README.md

structlog.nvim

Structured Logging for nvim, using Lua

Why using it

structlog makes logging in Lua less painful and more powerful by adding structure to your log entries.

Instead of writting complex messages, you can start thinking in terms of an event that happens in the context of key/value pairs.
Each log entry is a meaningful dictionary instead of an opaque string!

Thanks to its flexible design, the structure of the final log output is up for you to decide.
Each log entry goes through a processor pipeline that is just a chain of functions that receive a dictionary and return a new dictionary that gets fed into the next function. That allows for simple but powerful data manipulation.
This dictionary is then formatted and sent out to the sink.

For more details, consider reading the documentation.

Installation

Using packer.nvim

use { "Tastyep/structlog.nvim" }

Using luarocks

luarocks install --local structlog.nvim

Design

As explained in the introduction, log messages go through a pipeline to provide common information and to structure them into a comprehensible format. Internally, the log message is a dictionary built by the logger and is composed as follow:

  local log = {
    level = Level.name(level), -- The log level represented as a string
    msg = msg,                 -- The given message
    logger_name = logger.name, -- The name of the logger
    events = events or {},     -- The dictionary containing the 'key=value' arguments
  }

At the end of a pipeline, the message msg field should contain the text to write to the sink.

Processors

Processors are functions with the goal of enriching log messages. These functions accept one parameter, log which they edit by adding new key=value pairs, such as the logger's name or the current timestamp, and return it on completion.

See the processors documentation.

Formatters

Formatters define the structure of the log. By default vim.inspect is used to format the given arguments events as key=value pairs. All formatters have the same interface. They expose a formatting function accepting a dictionary log and return that same dictionary, modified so that log.msg contains the message to write to the sink.

See the formatters documentation.

Sinks

Sinks specify where to write the log message. Like the other elements of the pipeline, sinks accept log as parameter.

See the sinks documentation.

Usage

Minimal

local log = require("structlog")

log.configure({
  my_logger = {
    pipelines = {
      {
        log.level.INFO,
        {
          log.processors.Timestamper("%H:%M:%S"),
        },
        log.formatters.Format( --
          "%s [%s] %s: %-30s",
          { "timestamp", "level", "logger_name", "msg" },
        ),
        log.sinks.Console(),
      },
    },
  },
  other_logger = {
    pipelines = { ... }
  },
})

local logger = log.get_logger("my_logger")

Complete

local log = require("structlog")

log.configure({
  my_logger = {
    pipelines = {
      {
        level = log.level.INFO,
        processors = {
          log.processors.StackWriter({ "line", "file" }, { max_parents = 0, stack_level = 0 }),
          log.processors.Timestamper("%H:%M:%S"),
        },
        formatter = log.formatters.FormatColorizer( --
          "%s [%s] %s: %-30s",
          { "timestamp", "level", "logger_name", "msg" },
          { level = log.formatters.FormatColorizer.color_level() }
        ),
        sink = log.sinks.Console(),
      },
      {
        level = log.level.WARN,
        processors = {},
        formatter = log.formatters.Format( --
          "%s",
          { "msg" },
          { blacklist = { "level", "logger_name" } }
        ),
        sink =  log.sinks.NvimNotify(),
      },
      {
        level = log.level.TRACE,
        processors = {
          log.processors.StackWriter({ "line", "file" }, { max_parents = 3 }),
          log.processors.Timestamper("%H:%M:%S"),
        },
        formatter = log.formatters.Format( --
          "%s [%s] %s: %-30s",
          { "timestamp", "level", "logger_name", "msg" }
        ),
        sink = log.sinks.File("./test.log"),
      },
    },
  },
  },
  -- other_logger = {...}
})

local logger = log.get_logger("my_logger")
logger:info("A log message")
logger:warn("A log message with keyword arguments", { warning = "something happened" })

cat test.log:
10:43:23 [INFO] my_logger: A log message                            file="lua/foo/bar.lua", line=9
10:43:23 [WARN] my_logger: A log message with keyword arguments     file="lua/foo/bar.lua", line=10, warning="something happened"