@@ -1,7 +1,29 @@
2version: 0.1.0.0
2version: 0.1.0.0
3−synopsis: A structured logging framework for tagging each log message with its
3+synopsis: A structured logging framework.
4− surrounding context.
4+description:
5+ Katip is a structured logging framework with following design goals:
7+ * Logs are structured, meaning they can be individually tagged with
8+ key value data (JSON Objects). This helps you add critical
9+ details to log messages before you need them so that when you do,
10+ they are available. Logs are also namespaced to help filter
11+ different subsystems.
13+ * Critical details for monitoring production systems such as host,
14+ PID, thread id, module and line location are automatically
17+ * Can be easily extended (even at runtime) to output to multiple
18+ destinations at once (known as scribes). See @katip-elasticsearch@
21+ * Designed to be highly configurable. Can be adjusted both with
22+ verbosity, which dictates how much of the log structure should
23+ actually get logged, and severity. Each individual scribe can be
24+ configured to a different log severity.
26+ A note on the name: Katip is Turkish for scribe.
5license: BSD3
27license: BSD3
6license-file: LICENSE
28license-file: LICENSE
7author: Ozgun Ataman
29author: Ozgun Ataman