@google-cloud/logging-winston

class LoggingWinston

class LoggingWinston extends TransportStream {}

• This module provides support for streaming your winston logs to [Cloud Logging](https://cloud.google.com/logging).

  Parameter options

  Parameter

  {object} [options.level] The default log level. Winston will filter messages with a severity lower than this.

  Parameter

  {object} [options.levels] Custom logging levels as supported by winston. This list is used to translate your log level to the Cloud Logging level. Each property should have an integer value between 0 (most severe) and 7 (least severe). If you are passing a list of levels to your winston logger, you should provide the same list here.

  Parameter

  {boolean} [options.inspectMetadata=false] Serialize winston-provided log metadata using util.inspect.

  Parameter

  {string} [options.logName=winston_log] The name of the log that will receive messages written to this transport.

  Parameter

  {object} [options.resource] The monitored resource that the transport corresponds to. On Google Cloud Platform, this is detected automatically, but you may optionally specify a specific monitored resource. For more information see the [official documentation]https://cloud.google.com/logging/docs/api/reference/rest/v2/MonitoredResource.

  Parameter

  {object} [options.serviceContext] For logged errors, we provide this as the service context. For more information see [this guide]https://cloud.google.com/error-reporting/docs/formatting-error-messages and the [official documentation]https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext.

  Parameter

  {string} [options.serviceContext.service] An identifier of the service, such as the name of the executable, job, or Google App Engine service name.

  Parameter

  {string} [options.serviceContext.version] Represents the version of the service.

  Parameter

  {string} [options.projectId] The project ID from the Google Cloud Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports , your project ID will be detected automatically.

  Parameter

  {string} [options.keyFilename] Full path to the a .json, .pem, or .p12 key downloaded from the Google Cloud Console. If you provide a path to a JSON file, the projectId option above is not necessary. NOTE: .pem and .p12 require you to specify the email option as well.

  Parameter

  {string} [options.email] Account email address. Required when using a .pem or .p12 keyFilename.

  Parameter

  {object} [options.credentials] Credentials object.

  Parameter

  {string} [options.credentials.client_email]

  Parameter

  {string} [options.credentials.private_key]

  Parameter

  {boolean} [options.autoRetry=true] Automatically retry requests if the response is related to rate limits or certain intermittent server errors. We will exponentially backoff subsequent requests by default.

  Parameter

  {number} [options.maxRetries=3] Maximum number of automatic retries attempted before returning the error.

  Parameter

  {constructor} [options.promise] Custom promise module to use instead of native Promises.

  Example 1

  Import the client library const {LoggingWinston} = require('@google-cloud/logging-winston');

  Example 2

  Create a client that uses Application Default Credentials (ADC): const loggingWinston = new LoggingWinston();

  Example 3

  Create a client with explicit credentials: const loggingWinston = new LoggingWinston({ projectId: 'your-project-id', keyFilename: '/path/to/keyfile.json' });

  Example 4

  include:samples/quickstart.js region_tag:logging_winston_quickstart Full quickstart example:

interface Options

interface Options extends LoggingOptions {}

namespace express

module 'build/src/middleware/express.d.ts' {}