npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bonniernews/logger

v0.0.9

Published

Some simple functions to use Trace Context for correlating logs

Downloads

421

Readme

@bonniernews/logger

Bonnier News logger library, that makes it easier to unify logging. It is pre-configured for GCP and includes tracing capabilities for Express servers.

npm install @bonniernews/logger

Usage

Here is an example server with log tracing enabled.

import {
  getTraceparent,
  middleware,
  logger as buildLogger
} from "@bonniernews/logger";
import express from "express";

const logger = buildLogger();
const app = express();

// This middleware will create a request context and
// automatically decorate all logs with tracing data:
app.use(middleware());

app.get("/", async (req, res) => {
  logger.info("Hello, world!");

  // Propagate traceparent to other services
  const response = await fetch("https://some.other.service.bn.nr/some/endpoint", {
    headers: { traceparent: getTraceparent() },
  });

  ...
});

The middleware should be put as early as possible, since only logs after this middleware will get the tracing data. The middleware will lookup the active project ID from GCP. Alternatively, you can set the GCP_PROJECT environment variable for this purpose.

Use the getTraceparent function to pass tracing headers to downstream services. Use getTraceId if you only want to know the current trace-id.

If you want to decorate logs with custom data, use the exported decorateLogs function. In order to use this, the middleware needs to be installed first.

Interface

The library have these named exports:

  • logger: Used to create a logger, see below.
  • middleware: A middleware to install a request context store that is used to decorate logs with automatic tracing. This middleware enables the use of decorateLogs, getLoggingData, getTraceparent and getTraceId.
  • decorateLogs: Function to add data to the request context.
  • getLoggingData: Returns decorated data fields together with trace information.
  • getTraceparent: Returns traceparent header value - to be used for requests to downstream services.
  • getTraceId: Returns the traceId value - useful if you want to add it to an API error response.
  • createTraceparent: Utility function to generate a traceparent header value.

Logger

Options

This library uses the Pino logger, and instances are created using the same options. In most cases this is not needed, and you can use the defaults:

  • Uses info as the minimum log level
  • JSON logging with severity and message fields for non-local environments - in line with GCP structured logging standards
  • Pretty logging enabled for local development and test environments

Log Levels

The logger has the following levels, with their corresponding GCP severity mapping:

| Log level | GCP severity | | --------- | ------------ | | trace | DEBUG | | debug | DEBUG | | info | INFO | | warn | WARNING | | error | ERROR | | fatal | CRITICAL |

Log messages

Here are a few examples on how to use the logger:

import { logger } from "@bonniernews/logger";

const log = logger({ level: "debug" });

log.debug("This is just a message");

log.info("This is how to use %s strings: %d", "template", 123);

log.info({ any: { additional: "data" } }, "I'm attaching relevant data");

const error = new Error("Oops!");

// This will set error.message as the log message,
// and add a serialized error object under the `err` key:
log.warn(error);

// The `err` key is special, and triggers error serialization:
log.error({ err: error }, "This message takes precedence over err.message");

Tracing

If you want to decorate logs with tracing fields for incoming requests, use the library's middleware, which will use Node async hooks to store and decorate all logs using the standardized traceparent header.