winston-loki

A Grafana Loki transport for the nodejs logging library Winston.

Usage

This Winston transport is used similarly to other Winston transports. Require winston and define a new LokiTransport() inside its options when creating it.

Options

LokiTransport() takes a Javascript object as an input. These are the options that are available:

host

The URL of the Grafana Loki server. It should contain everything from the protocol to the port.

interval

optional

The interval at which the transport sends batched logs to Loki. In seconds.

json

optional

Switch to JSON transport instead of Protobuf.

Example

const { createLogger, transports } = require("winston");
const LokiTransport = require("winston-loki");
const options = {
  ...,
  transports: [
    new LokiTransport({
      host: "http://localhost:3100"
    })
  ]
  ...
};
const logger = createLogger(options);

Developing

npm install
npm link
cd ~/your_project
npm link winston-loki
npm install

And you should have a working, requirable winston-loki package under your project's node_modules.

Refer to https://github.com/grafana/loki/blob/master/docs/api.md for documentation about the available endpoints, data formats etc.

Grafana Loki doesn't have any official releases or version numbers as of now, so if the API is changed, it's going to be fun, but it's working as of now.

Run tests

npm test

Write new ones under /test

TODO: Remove got dependency