Configura Stackdriver Logging para Node.js

Puedes escribir registros en Logging desde aplicaciones Node.js mediante los complementos Bunyan o Winston o directamente con la biblioteca cliente de la API de Cloud en Stackdriver Logging para Node.js.

No es necesario que el agente de Logging esté instalado para usar las bibliotecas Bunyan y Winston en una instancia de VM de Compute Engine.

Antes de comenzar

  1. Accede a tu Cuenta de Google.

    Si todavía no tienes una cuenta, regístrate para obtener una nueva.

  2. En GCP Console, en la página de selección de proyecto, selecciona o crea un proyecto de GCP.

    Ir a la página de selección de proyecto

  3. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

  4. Habilita lasStackdriver Logging APIAPInecesarias.

    Habilita lasAPI

  5. Prepara tu entorno para el desarrollo en Node.js.

    Ir a la guía de configuración de Node.js

Usa Bunyan

Stackdriver Logging proporciona un complemento para la biblioteca Bunyan de Logging para Node.js. El complemento de Logging para Bunyan proporciona una capa más simple y de nivel superior a fin de trabajar con Logging.

Instala el complemento

  1. La forma más fácil de instalar el complemento de Bunyan de Logging es con npm:

    npm install --save bunyan @google-cloud/logging-bunyan
  2. Importa el complemento y agrégalo a tu configuración de Bunyan:

    const bunyan = require('bunyan');
    
    // Imports the Google Cloud client library for Bunyan
    const {LoggingBunyan} = require('@google-cloud/logging-bunyan');
    
    // Creates a Bunyan Stackdriver Logging client
    const loggingBunyan = new LoggingBunyan();
    
    // Create a Bunyan logger that streams to Stackdriver Logging
    // Logs will be written to: "projects/YOUR_PROJECT_ID/logs/bunyan_log"
    const logger = bunyan.createLogger({
      // The JSON payload of the log as it appears in Stackdriver Logging
      // will contain "name": "my-service"
      name: 'my-service',
      streams: [
        // Log to the console at 'info' and above
        {stream: process.stdout, level: 'info'},
        // And log to Stackdriver Logging, logging at 'info' and above
        loggingBunyan.stream('info'),
      ],
    });
    
    // Writes some log entries
    logger.error('warp nacelles offline');
    logger.info('shields at 99%');

Configura el complemento

Puedes personalizar el comportamiento del complemento Bunyan con las mismas opciones de configuración compatibles con la biblioteca cliente de la API de Cloud en Stackdriver Logging para Node.js. Estas opciones se pueden pasar en el objeto options que se pasa al constructor del complemento.

Usa Winston

Stackdriver Logging proporciona un complemento para la biblioteca Winston de Logging para Node.js. El complemento de Logging para Winston proporciona una capa más simple y de nivel superior a fin de trabajar con Logging.

Instala el complemento

  1. La forma más sencilla de instalar el complemento Winston de Logging es con npm:

    npm install --save @google-cloud/logging-winston
  2. Importa el complemento y agrégalo a tu configuración de Winston:

    const winston = require('winston');
    
    // Imports the Google Cloud client library for Winston
    const {LoggingWinston} = require('@google-cloud/logging-winston');
    
    const loggingWinston = new LoggingWinston();
    
    // Create a Winston logger that streams to Stackdriver Logging
    // Logs will be written to: "projects/YOUR_PROJECT_ID/logs/winston_log"
    const logger = winston.createLogger({
      level: 'info',
      transports: [
        new winston.transports.Console(),
        // Add Stackdriver Logging
        loggingWinston,
      ],
    });
    
    // Writes some log entries
    logger.error('warp nacelles offline');
    logger.info('shields at 99%');

Configura el complemento

Puedes personalizar el comportamiento de un complemento Winston con las mismas opciones de configuración que admite la biblioteca cliente de la API de Cloud en Stackdriver Logging para Node.js. Estas opciones se pueden pasar en el objeto options que se pasa al constructor del complemento.

A fin de obtener más información sobre la instalación, consulta la documentación sobre las bibliotecas de Stackdriver Logging para Node.js. También puedes informar problemas con el seguimiento de problemas.

Usa la biblioteca cliente de Cloud directamente

A fin de obtener información sobre cómo usar una biblioteca cliente de Cloud en Stackdriver Logging para Node.js directamente, consulta Bibliotecas cliente de Stackdriver Logging.

Ejecuta en Google Cloud

El uso de la biblioteca de Stackdriver Logging para Node.js requiere la función escritor de registros de Cloud IAM en Google Cloud. La mayoría de los entornos de Google Cloud proporcionan esta función de forma predeterminada.

App Engine

App Engine otorga la función de escritor de registros de forma predeterminada.

Las bibliotecas de Stackdriver Logging para Node.js se pueden utilizar sin tener que proporcionar credenciales explícitamente.

Stackdriver Logging está habilitado automáticamente para las aplicaciones de App Engine. No se requiere ninguna configuración adicional.

Google Kubernetes Engine

En Google Kubernetes Engine, debes agregar el nivel de acceso logging.write cuando creas el clúster:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

Cuando uses las instancias de VM de Compute Engine, agrega el nivel de acceso cloud-platform a cada instancia. Si creas una instancia nueva a través de Google Cloud Console, puedes hacerlo en la sección Identidad y acceso a la API del panel Crear Instancia. Usa la cuenta de servicio predeterminada de Compute Engine o una cuenta de servicio diferente y selecciona Permitir acceso total a las API de Cloud en la sección Identidad y acceso a la API. Asegúrate de que la cuenta de servicio que selecciones tenga la función de escritor de registros en la sección IAM y administración de Cloud Console.

Cloud Functions

Cloud Functions otorga la función de escritor de registros de forma predeterminada.

Las bibliotecas de Stackdriver Logging para Node.js se pueden utilizar sin tener que proporcionar credenciales explícitamente.

Cloud Functions está configurado para utilizar Stackdriver Logging automáticamente.

Ejecuta de forma local y en otros lugares

Si quieres usar las bibliotecas de Stackdriver Logging para Node.js fuera de Google Cloud, lo que incluye ejecutar la biblioteca en tu estación de trabajo, en las computadoras del centro de datos o en las instancias de VM de otro proveedor de servicios en la nube, debes proporcionar el ID del proyecto de Google Cloud y las credenciales de la cuenta de servicio correspondientes directamente a las bibliotecas de Stackdriver Logging para Node.js.

Puedes crear y obtener credenciales de cuentas de servicio de forma manual. Cuando especifiques el campo Función, usa la función escritor de registros. Para obtener más información sobre las funciones de Cloud Identity and Access Management, consulta la Guía de control de acceso.

Con Bunyan:

// Imports the Google Cloud client library for Bunyan
const {LoggingBunyan} = require('@google-cloud/logging-bunyan');

// Creates a client
const loggingBunyan = new LoggingBunyan({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

Con Winston:

// Imports the Google Cloud client library for Winston
const {LoggingWinston} = require('@google-cloud/logging-winston');

// Creates a client
const loggingWinston = new LoggingWinston({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

Visualiza los registros

Después de la implementación, puedes ver los registros en el visor de registros de Cloud Console.

Ir al visor de registros

En el visor de registros, debes especificar uno o más recursos, aunque la selección de recursos puede no ser obvia. Aquí encontrarás algunas sugerencias que te ayudarán a comenzar:

  • Si implementas tu aplicación en App Engine o mediante las bibliotecas específicas de App Engine, configura tu recurso como Aplicación de GAE.

  • Si implementas tu aplicación en Compute Engine, configura el recurso como Instancia de VM de GCE.

  • Si implementas tu aplicación en Google Kubernetes Engine, la configuración de registro de tu clúster determina el tipo de recurso de las entradas de registro. Para obtener más información sobre las soluciones de Stackdriver heredado y Stackdriver Kubernetes Monitoring, y sobre cómo estas opciones afectan el tipo de recurso, consulta Migración a Kubernetes Monitoring.

  • Si tu aplicación usa directamente la API de Stackdriver Logging, el recurso depende de la API y de tu configuración. Por ejemplo, en tu aplicación, puedes especificar un recurso o usar un recurso predeterminado.

  • Si no ves ningún registro en el visor de registros, cambia al modo de consulta avanzada y usa una consulta vacía para ver todas las entradas de registro.

    1. Para cambiar al modo de consulta avanzada, haz clic en menú (▾) en la parte superior del visor de registros y selecciona Convertir en filtro avanzado.
    2. Borra el contenido que aparece en la casilla de filtro.
    3. Haz clic en Enviar filtro.

    Puedes examinar las entradas individuales para identificar tus recursos.

Para obtener más información, consulta Visualiza los registros y la página sobre consultas de registros avanzadas.