`@probot/pino`

formats pino logs and sends errors to Sentry

About

@probot/pino is currently built into probot, you don't need to manually pipe probot's logs into it. It will be easy to move it out of probot in future though, and give people a simple way to recover the logging behavior if they wish, or to replace it with another pino transport

Examples

You can test @probot/pino by running the following in your terminal

node example | node cli.js

You can test the environment variables by setting them inline

node example | LOG_FORMAT=json node cli.js

Programmatic usage

@probot/pino exports a getTransformStream() method which can be passed as 2nd argument to pino()

import pino from "pino";
import { getTransformStream } from "@probot/pino";

const log = pino(
  {
    name: "probot",
  },
  getTransformStream()
);

This won't log anything to stdout though. In order to pass the formatted logs back to stdout, do the following

import pino from "pino";
import { getTransformStream } from "@probot/pino";

const transform = getTransformStream();
transform.pipe(pino.destination(1));
const log = pino(
  {
    name: "probot",
  },
  transform
);

Options

@probot/pino can be configured using environment variables

Variable	Description
`LOG_FORMAT`	By default, logs are formatted for readability in development. You can set this to `json` in order to disable the formatting
`LOG_LEVEL_IN_STRING`	By default, when using the `json` format, the level printed in the log records is an int (`10`, `20`, ..). This option tells the logger to print level as a string: `{"level": "info"}`. Default `false`
`SENTRY_DSN`	Set to a Sentry DSN to report all errors thrown by your app. (Example: `https://1234abcd@sentry.io/12345`)

Contributing

See CONTRIBUTING.md

License

ISC

mikz/pino