on master help sign in
Tweak README
commit19fad18deaf00725eac726622b4ecee646174171 authorOzgun Ataman <ozgun.ataman@soostone.com> dateMon 7 Mar 2016, 11:49 (11 years ago) parent53690bb
1 file changed+24−23
katip/README.md+24−23
katip/README.md+24−23
@@ -8,16 +8,6 @@ Kâtip (pronounced kah-tip) is the Turkish word for scribe.
88
99## Features
1010
11−* *Battle-Tested:* Katip has been integrated into several production
12− systems since 2015 and has logged hundreds of millions of messages
13− to files and ElasticSearch.
14−
15−* *Easy to Use:* Katip was designed to be easily integrated into
16− existing systems. By using a typeclass for logging facilities,
17− individual subsystems and even libraries can easily add their own
18− namespacing and context without having any knowledge of their
19− logging environment.
20−
2111* *Structured:* Logs are structured, meaning they can be individually
2212 tagged with key value data (JSON Objects). This helps you add
2313 critical details to log messages before you need them so that when
@@ -26,27 +16,38 @@ Kâtip (pronounced kah-tip) is the Turkish word for scribe.
2616 add context that will be automatically merged in with existing log
2717 context.
2818
19+* *Easy to Use:* Katip was designed to be easily integrated into
20+ existing systems. By using a typeclass for logging facilities,
21+ individual subsystems and even libraries can easily add their own
22+ namespacing and context without having any knowledge of their
23+ logging environment.
24+
25+* *Extensible:* Can be easily extended (even at runtime) to output to
26+ multiple backends at once (known as scribes). See
27+ `katip-elasticsearch` as an example.
28+
2929* *Debug-Friendly:* Critical details for monitoring production systems
3030 such as host, PID, thread id, module and line location are
3131 automatically captured. User-specified attributes such as
3232 environment (e.g. Production, Test, Dev) and system name are also
3333 captured.
3434
35−* *Extensible:* Can be easily extended (even at runtime) to output to
36− multiple backends at once (known as scribes). See
37− `katip-elasticsearch` as an example.
38−
39−* *Configurable:*. Can be adjusted on a per-scribe basis both with
35+* *Configurable:* Can be adjusted on a per-scribe basis both with
4036 verbosity and severity.
4137
42− * *Verbosity* dictates how much of the log structure should
43− actually get logged. In code you can capture highly detailed
44− metadata and decide how much of that gets emitted to each backend.
45− * *Severity* AKA "log level" is specified with each message and
46− individual scribes can decide whether or not to record that
47− severity. It is even possible to at runtime swap out and replace
48− loggers, allowing for swapping in verbose debug logging at runtime
49− if you want.
38+ * *Verbosity* dictates how much of the log structure should
39+ actually get logged. In code you can capture highly detailed
40+ metadata and decide how much of that gets emitted to each backend.
41+
42+ * *Severity* AKA "log level" is specified with each message and
43+ individual scribes can decide whether or not to record that
44+ severity. It is even possible to at runtime swap out and replace
45+ loggers, allowing for swapping in verbose debug logging at runtime
46+ if you want.
47+
48+* *Battle-Tested:* Katip has been integrated into several production
49+ systems since 2015 and has logged hundreds of millions of messages
50+ to files and ElasticSearch.
5051
5152
5253## Examples