Use Pino with Google Cloud Logging

This package provides a simple configuration to use with Pino to make it adhere to Google Cloud Logging structured logging.

Quickstart

1yarn add pino-cloud-logging

When you initialize your Pino logging instance, you'll use our gcpLogOptions.

1import Pino from 'pino';
2import { gcpLogOptions } from 'pino-cloud-logging';
3
4const logger = Pino(gcpLogOptions());
5
6logger.info('Hello 👋');

You can extend the configuration provided by this package like this:

1gcpLogOptions({
2  level: 'INFO',
3  // Options can be found here:
4  // https://github.com/pinojs/pino/blob/master/docs/api.md#options
5});

You can also provide some of the default context like this:

1gcpLogOptions(
2  {
3    /* ... */
4  },
5  { serviceName: 'hello-world', version: '2020-01-01' },
6);

If you want to provide insertId (or any other runtime data), you can add those with the mixin function.

1gcpLogOptions(
2  {
3    /* ... */
4  },
5  { mixin: () => ({ insertId: randomUUID() }) },
6);

Or even provide context from OpenTelemetry.

1import { context, getSpan } from '@opentelemetry/api';
2gcpLogOptions(
3  {
4    /* ... */
5  },
6  { mixin: () => getSpan(context.active())?.context() ?? {} },
7);