relaycorp / pino-cloud-js Goto Github PK

View Code? Open in Web Editor NEW

10.0 3.0 0.0 2.52 MB

Pino integration for cloud logging services like Google Stackdriver

Home Page: https://docs.relaycorp.tech/pino-cloud-js/

License: MIT License

JavaScript 48.07% TypeScript 51.93%

pino stackdriver

pino-cloud-js's Introduction

@relaycorp/pino-cloud

This library generates Pino configuration to format log entries in such a way that they can be properly ingested by cloud logging services such as those on Google Cloud Platform (GCP).

At this point, only GCP's Cloud Logging and Error Reporting services are supported, but we'd welcome any PRs to support additional targets, such as Elastic Search or AWS CloudWatch Logs.

Install

Releases are automatically pushed to NPM. For example, to get the latest release, run:

npm install @relaycorp/pino-cloud

Usage

This library simply returns a configuration object for Pino, which you augment before passing to Pino. For example:

import { getPinoOptions } from '@relaycorp/pino-cloud';

const LOGGER = pino({
  ...getPinoOptions(process.ENV.LOGGING_TARGET, {
    name: 'your-app-name',
    version: '1.0.2',
  }),
  level: 'debug',
});

If the environment variable LOGGING_TARGET is unset, an empty object is returned.

Targets

`gcp`

error and fatal logs are augmented to include Error Reporting fields, like the name and version of your app.

Additionally, if the log contains an err field that is an instance of Error, its stack trace will be added to the field stack_trace -- Where Error Reporting expects to find it.

API documentation

The API documentation can be found on docs.relaycorp.tech.

Contributing

We love contributions! If you haven't contributed to a Relaycorp project before, please take a minute to read our guidelines first.

pino-cloud-js's People

Contributors

Stargazers

Watchers

pino-cloud-js's Issues

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Update to Pino v7

Describe the problem

The lib still relies on Pino v6, and new typings are now included with the v7. The exports are a bit different, for instance import { LoggerOptions } from 'pino'; would become import { P } from 'pino'; and usage would be namespaced with P.LoggerOptions. This breaks the libs' typings and return type becomes any, which in turn breaks our app's typechecking.

Describe the solution you'd like

Update the library to support Pino v7 and drop DefinitelyTyped typings.

Describe alternatives you've considered

In the meantime, I've overrided the getPinoOptions typings with local types of my own, but it's obviously not great 😉

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

My log still looks like a plain string

I'm using the standard config for this plugin on my GCP project, but I don't know why Cloud Logging insists in printing a plain string:

relaycorp / pino-cloud-js Goto Github PK

pino-cloud-js's Introduction

@relaycorp/pino-cloud

Install

Usage

Targets

gcp

API documentation

Contributing

pino-cloud-js's People

Contributors

Stargazers

Watchers

pino-cloud-js's Issues

🚨 The automated release from the main branch failed. 🚨

Invalid npm token.

Describe the problem

Describe the solution you'd like

Describe alternatives you've considered

🚨 The automated release from the main branch failed. 🚨

Invalid npm token.

Recommend Projects

Recommend Topics

Recommend Org

`gcp`

🚨 The automated release from the `main` branch failed. 🚨

🚨 The automated release from the `main` branch failed. 🚨