pino-stackdriver/pino-stackdriver.d.ts

A transport for pino that sends messages to Google Stackdriver Logging

/// <reference types="node" />
declare namespace PinoStackdriver {
  export interface Options {
    /**
     * Full path to the JSON file containing the Google Service Credentials.
     * Defaults to GOOGLE_APPLICATION_CREDENTIALS environment variable.
     */
    credentials?: string | {client_email: string, private_key:string};

    /**
     * The name of the project.
     */
    projectId: string;

    /**
     * The name of the log.
     * @default "pino_log"
     */
    logName?: string;

    /**
     * The MonitoringResource to send logs to.
     * @default { type: "global" }
     */
    resource?: {
      type: string;
      labels?: Record<string, string>;
    };

    /**
     * Names of log fields to pull properties out of - see https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry
     * @default { httpRequest: "httpRequest", trace: "trace", ... }
     */
    keys?: {
      httpRequest?: string;
      trace?: string;
    };

    /**
     * Set the gRPC fallback option for the Google Stackdriver API.
     */
    fallback?: boolean;
  }

  /**
   * Create a writestream that `pino-multi-stream` can use to send logs to.
   * @param options
   */
  export const createWriteStream: (options: Options) => NodeJS.WritableStream;
}

export = PinoStackdriver