simenandre / pino-cloud-logging

Pino configuration for Google Cloud Platform. Enabled structured logging!

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

yarn add pino-cloud-logging

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

import Pino from 'pino';
import { gcpLogOptions } from 'pino-cloud-logging';

const logger = Pino(gcpLogOptions());

logger.info('Hello 👋');

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

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

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

gcpLogOptions(
  {
    /* ... */
  },
  { serviceName: 'hello-world', version: '2020-01-01' },
);

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

gcpLogOptions(
  {
    /* ... */
  },
  { mixin: () => ({ insertId: randomUUID() }) },
);

Or even provide context from OpenTelemetry.

import { context, getSpan } from '@opentelemetry/api';
gcpLogOptions(
  {
    /* ... */
  },
  { mixin: () => getSpan(context.active())?.context() ?? {} },
);

pino-cloud-logging's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update actions/checkout digest to a5ac7e5
• chore(deps): update actions/setup-node action to v4
• chore(deps): update dependency @bjerk/eslint-config to v6
• chore(deps): update dependency @tsconfig/node16 to v16
• chore(deps): update dependency @types/node to v20
• chore(deps): update dependency prettier to v3
• chore(deps): update google-github-actions/release-please-action action to v4
• fix(deps): update dependency pino to v9
• chore(deps): lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/workflow.yml

• actions/checkout v4@3df4ab11eba7bda6032a0b82a6bb43b11571feac
• google-github-actions/release-please-action v3
• actions/setup-node v3

npm

package.json

• pino ^8.0.0
• @bjerk/eslint-config ^4.0.0
• @cobraz/prettier ^2.0.0
• @tsconfig/node16 ^1.0.2
• @types/jest ^29.0.0
• @types/node 18
• jest ^29.0.0
• prettier ^2.5.1
• ts-jest ^29.0.0
• ts-node ^10.4.0
• typescript ^5.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository