Skip to content

Commit

Permalink
flatten overview headings
Browse files Browse the repository at this point in the history
  • Loading branch information
mahmoud committed Jun 5, 2016
1 parent 743275c commit d00cc7d
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ The Lithoxyl approach to application instrumentation is a practical
one. First, write your code. Then, once you have half a module or find
yourself asking, "How long does this part take?" then it's time to
``pip install lithoxyl``. There are two steps. First comes
instrumentation, then we select a configuration.
instrumentation, then we get into configuration.

Application instrumentation
Records for instrumentation
---------------------------

With Lithoxyl, logging and other instrumentation starts with knowing
Expand Down Expand Up @@ -87,15 +87,12 @@ That about covers creating and interacting with records. Now we turn
to the origin and destination of the records we create and populate:
Loggers and Sinks.

Logger and Sink configuration
-----------------------------
Logger creation
---------------

Records make up most of an application's interaction with Lithoxyl,
but it would not be very easy to create a Record without a Logger.

Logger creation
~~~~~~~~~~~~~~~

As we learned above, before a Record can be populated, it must be
created, and Records are created through Logger. As for the Logger
itself, here is how it is created::
Expand Down Expand Up @@ -123,8 +120,8 @@ your application, no matter how many aspects it may have. On their
own, they are conceptually useful, but without Sinks, they are all
potential.

Sink configuration
~~~~~~~~~~~~~~~~~~
BasicSink configuration
-----------------------

So far, we have discovered two uses of the Lithoxyl Logger:

Expand Down Expand Up @@ -154,7 +151,7 @@ persistent logging to streams (stdout/stderr) and files. Lithoxyl is
more than capable.

Sensible logging
^^^^^^^^^^^^^^^^
----------------

For developers who want a sensible and practical default, Lithoxyl
provides the SensibleSink. The Sensible Suite chapter has a full
Expand Down

0 comments on commit d00cc7d

Please sign in to comment.