katip

A structured logging framework. https://github.com/Soostone/katip

Version on this page:0.3.1.4
LTS Haskell 9.10:0.5.1.0
Stackage Nightly 2017-10-22:0.5.1.0
Latest on Hackage:0.5.1.0
BSD3 licensed by Ozgun Ataman, Michael Xavier
Maintained by michael.xavier@soostone.com

Module documentation for 0.3.1.4

Katip Build Status

Katip is a structured logging framework for Haskell.

Katip

K√Ętip (pronounced kah-tip) is the Turkish word for scribe.

Features

  • Structured: Logs are structured, meaning they can be individually tagged with key value data (JSON Objects). This helps you add critical details to log messages before you need them so that when you do, they are available. Katip exposes a typeclass for log payloads so that you can use rich, domain-specific Haskell types to add context that will be automatically merged in with existing log context.

  • Easy to Integration: Katip was designed to be easily integrated into existing monads. By using typeclasses for logging facilities, individual subsystems and even libraries can easily add their own namespacing and context without having any knowledge of their logging environment.

  • Practical Use: Katip comes with a set of convenience facilities built-in, so it can be used without much headache even in small projects.

    • A Handle backend for logging to files in simple settings.

    • A AnyLogPayload key-value type that makes it easy to log structured columns on the fly without having to define new data types.

    • A Monadic interface where logging namespace can be obtained from the monad context.

    • Multiple variants of the fundamental logging functions for optionally including fields and line-number information.

  • Extensible: Can be easily extended (even at runtime) to output to multiple backends at once (known as scribes). See katip-elasticsearch as an example. Backends for other forms of storage are trivial to write, including both hosted database systems and SaaS logging providers.

  • Debug-Friendly: Critical details for monitoring production systems such as host, PID, thread id, module and line location are automatically captured. User-specified attributes such as environment (e.g. Production, Test, Dev) and system name are also captured.

  • Configurable: Can be adjusted on a per-scribe basis both with verbosity and severity.

    • Verbosity dictates how much of the log structure should actually get logged. In code you can capture highly detailed metadata and decide how much of that gets emitted to each backend.

    • Severity AKA "log level" is specified with each message and individual scribes can decide whether or not to record that severity. It is even possible to at runtime swap out and replace loggers, allowing for swapping in verbose debug logging at runtime if you want.

  • Battle-Tested: Katip has been integrated into several production systems since 2015 and has logged hundreds of millions of messages to files and ElasticSearch.

Examples

Be sure to look in the examples directory for some examples of how to integrate Katip into your own stack.

Contributors

Changes

0.5.1.0

  • Add mkFileScribe, a specialization of mkHandleScribe for files that manages the handle automatically.

0.5.0.4

  • Loosen Win32 upper bound to run with GHC 8.2 on Windows.

0.5.0.3

  • Add worked example of Katip/KatipContext to the haddocks.

0.5.0.2

  • Export Katip.Compat for Windows users.

0.5.0.1

  • Fix numeric formatting in Handle scribe.
  • Bump deps for GHC 8.2.1

0.5.0.0

  • Improved documentation.
  • Add built-in buffering to scribes. Scribes now allocate a bounded queue (with configurable size). Rather than writes being synchronous to all scribes, they simply attempt to write into the bounded queue of each scribe. If any of the scribes is too far behind and the queue is full, the write is dropped. This also means that closing scribes is now an IO operation that happens synchrounsly.
  • Added local-like functions to Katip and KatipContext typeclasses. This allows us to generalize katipNoLogging, katipAddNamespace, and katipAddContext to be available to anything with a Katip or KatipContext instance rather than having to reimplement these functions all the time.

0.4.1.0

  • Add Katip instances for Strict StateT, WriterT, RWST.
  • Add Katip instances for Lazy RWST.

0.4.0.0

  • Drop unsafe _ioLogEnv for safe ioLogEnv

0.3.1.5

  • Add Semigroup instance for LogStr.

0.3.1.4

  • Loosen deps on aeson to allow 1.1.0.0

0.3.1.3

  • Fix build on windows

0.3.1.2

  • Add some missing test files

0.3.1.1

  • Fix some example code that wasn't building
  • Make FromJSON instance for Severity case insensitive.

0.3.1.0

  • Add support for aeson 1.0.x
  • Add Katip.Format.Time module and use much more efficient time formatting code in the Handle scribe.

0.3.0.0

  • Switch from regex-tdfa-rc to regex-tdfa.
  • Add katipNoLogging combinator.
  • Add Semigroup instances.
  • Drop ToJSON superclass requirement fro ToObject. Instead, ToObject will provide a default instance for types with an instance for ToJSON. This gets us to the same place as before without having to add a broader instance for something that's only going to show up in logs as an Object.
  • Add a simple MVar lock for file handle scribes to avoid interleaved log lines from concurrent inputs.

0.2.0.0

  • Add GHC implicit callstack support, add logLoc.
  • Drop lens in favor of type-compatible, lighter microlens.
  • Renamed logEnvNs to clearer logEnvApp
  • Added katipAddNamespace and katipAddContext
  • Fixed nested objects not rendering in Handle scribe.
  • LogContexts Monoid instance is now right-biased rather than left biased. This better fits the use case. For instance ctx1 <> ctx2 will prefer keys in ctx2 if there are conflicts. This makes the most sense because functions like katipAddContext will mappend on the right side.
  • LogContext internally uses a Seq instead of a list for better complexity on context add.
  • Improved documentation.

0.1.1.0

  • Set upper bounds for a few dependencies.
  • Add ExceptT instance for Katip typeclass

0.1.0.0

  • Initial release
comments powered byDisqus