Skip to content

Commit

Permalink
fix format, clearer
Browse files Browse the repository at this point in the history
  • Loading branch information
Dieterbe committed Jun 24, 2016
1 parent 52d47d9 commit c589816
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/logging.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# log level description

== these messages are potentially high volume and resource intensive ==
debug: state changes that we only need to know when debugging
info: for tracing data as it flows around ONLY, including discards (note that some tracing data can be in warnings too!)
notice: events worth noticing, i.e. harmless but they don't happen often or are special events like closing conn or manually triggered things
* debug: state changes that we only need to know when debugging [1]
* info: for tracing data as it flows around ONLY, including discards (note that some tracing data can be in warnings too!) [1]
* notice: events worth noticing, i.e. harmless but they don't happen often or are special events like closing conn or manually triggered things [1]
* warning: something's wrong but we can survive, like write errors
* error:
* critical: not used, errors are critical

== everything from here on is low volume only ==
== we don't want to spend significant time in the logging library and/or being very spammy/resource intensive ==

warning: something's wrong but we can survive, like write errors
error:
critical: not used, errors are critical
# fine-grained logging

logging related to instances of objects:
{conn,dest,..} <spec> where spec is typically the addr or listening port
`{conn,dest,..} <spec>` where spec is typically the addr or listening port

# notes
[1] these metrics are potentially high volume and resource intensive

0 comments on commit c589816

Please sign in to comment.