Configura Cloud Logging para Node.js

En las aplicaciones de Node.js, los complementos se mantienen para las bibliotecas de registro populares Bunyan y Winston.

Winston es una biblioteca de uso general que implementa una variedad de transportes y formateadores de registro.

Bunyan se especializa en registros JSON estructurados. El formateo de registros se puede realizar mediante la canalización a la línea de comandos de Bunyan.

También puedes usar la biblioteca cliente de Logging para Node.js directamente o crear tus propias integraciones con la biblioteca de registro que prefieras.

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

Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

Ir al selector de proyectos

Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

Habilita Cloud Logging API.

Habilita la API

En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

Ir al selector de proyectos

Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

Habilita Cloud Logging API.

Habilita la API

Prepara el entorno para el desarrollo en Node.js.
Ir a la guía de configuración de Node.js

Usa Bunyan

Cloud Logging proporciona un complemento para la biblioteca de Logging de Node.js de Bunyan. 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

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
```

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 Cloud Logging client
const loggingBunyan = new LoggingBunyan();

// Create a Bunyan logger that streams to Cloud 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 Cloud 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 Cloud 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 Cloud de la API de Cloud Logging para Node.js. Estas opciones se pueden pasar en el objeto options que se pasa al constructor del complemento.

Usa Bunyan y Express

Puedes configurar y usar Bunyan con Logging en una aplicación Express de Node.js.

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

// Import express module and create an http server.
const express = require('express');

async function startServer() {
  const {logger, mw} = await lb.express.middleware({
    logName: 'samples_express',
  });
  const app = express();

  // Install the logging middleware. This ensures that a Bunyan-style `log`
  // function is available on the `request` object. This should be the very
  // first middleware you attach to your app.
  app.use(mw);

  // Setup an http route and a route handler.
  app.get('/', (req, res) => {
    // `req.log` can be used as a bunyan style log method. All logs generated
    // using `req.log` use the current request context. That is, all logs
    // corresponding to a specific request will be bundled in the Stackdriver
    // UI.
    req.log.info('this is an info log message');
    res.send('hello world');
  });

  const port = process.env.PORT || 8080;

  // `logger` can be used as a global logger, one not correlated to any specific
  // request.
  logger.info({port}, 'bonjour');

  // Start listening on the http server.
  const server = app.listen(port, () => {
    console.log(`http server listening on port ${port}`);
  });

  app.get('/shutdown', (req, res) => {
    res.sendStatus(200);
    server.close();
  });
}

startServer();

Usa Winston

Cloud Logging proporciona un complemento destinado a 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

La forma más sencilla de instalar el complemento Winston de Logging es con npm:
```
npm install --save @google-cloud/logging-winston winston
```

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 Cloud 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 Cloud Logging
    loggingWinston,
  ],
});

// Writes some log entries
logger.error('warp nacelles offline');
logger.info('shields at 99%');

Configura el complemento

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

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

Escribe registros con la biblioteca cliente de Cloud Logging

Si deseas obtener información sobre cómo usar directamente la biblioteca cliente de Cloud Logging para Node.js, consulta Bibliotecas cliente de Cloud Logging.

Ejecutar en Google Cloud

A fin de que una aplicación escriba registros mediante las bibliotecas de Cloud Logging para Node.js, la cuenta de servicio del recurso subyacente debe tener la función de IAM de escritor de registros (roles/logging.logWriter). La mayoría de los entornos de Google Cloud configuran automáticamente la cuenta de servicio predeterminada para que tenga esta función.

App Engine

Cloud Logging se habilita automáticamente para App Engine, y la cuenta de servicio predeterminada de tu app tiene los permisos de IAM de forma predeterminada para escribir entradas de registro.

Para escribir entradas de registro desde tu app, te recomendamos que uses Bunyan o Winston como se describe en esta página.

Para obtener más información, consulta Escribe y visualiza registros.

Google Kubernetes Engine (GKE)

GKE otorga automáticamente a la cuenta de servicio predeterminada el rol de IAM de escritor de registros (roles/logging.logWriter). Si usas Workload Identity con esta cuenta de servicio predeterminada para permitir que las cargas de trabajo accedan a APIs de Google Cloud específicas, no se requiere ninguna configuración adicional. Sin embargo, si usas Workload Identity con una cuenta de servicio de IAM personalizada, asegúrate de que esta tenga la función de escritor de registros (roles/logging.logWriter).

Si es necesario, también puedes usar el siguiente comando para agregar el permiso 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 permiso de acceso cloud-platform a cada instancia. Cuando crees una instancia nueva a través de la consola de Google Cloud, 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. Sin importar la cuenta de servicio que selecciones, asegúrate de que se le haya otorgado el rol de escritor de registros en la sección IAM y administración de la consola de Google Cloud.

Cloud Functions

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

Las bibliotecas de Cloud Logging para Node.js se pueden usar sin necesidad de proporcionar credenciales de forma explícita.

Cloud Functions está configurado para usar Cloud Logging de forma automática.

Ejecuta de manera local y en otros lugares

Si quieres usar las bibliotecas de Cloud Logging para Node.js fuera de Google Cloud, incluida la ejecución de la biblioteca en tu propia 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 tu ID del proyecto de Google Cloud y las credenciales de cuenta de servicio adecuadas directamente a las bibliotecas de Cloud Logging para Node.js.

Para las cuentas de servicio existentes, haz lo siguiente:

Otorga a la cuenta de servicio el rol de IAM de Escritor de registros (roles/logging.logWriter) de IAM. Para obtener más información sobre las funciones de IAM, consulta Control de acceso.
Configura las credenciales predeterminadas de la aplicación.

Si no tienes una cuenta de servicio, crea una. Para obtener información sobre este proceso, consulta Crea cuentas de servicio.

Si deseas obtener información general sobre los métodos que puedes usar para la autenticación, consulta Terminología: cuentas de servicio.

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',
});

Consulta los registros

En el panel de navegación de la consola de Google Cloud, elige Logging y, luego, Explorador de registros:

Ir al Explorador de registros

En el Explorador 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 utilizas 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 un análisis detallado de las soluciones de Kubernetes Monitoring de observabilidad y observabilidad de Google Cloud heredadas, y cómo esas opciones afectan el tipo de recurso, consulta Migra a Google Cloud Observability Monitoring Kubernetes Monitoring.
Si la aplicación usa la API de Cloud Logging directamente, el recurso depende de la API y de tu configuración. Por ejemplo, en la aplicación, puedes especificar un recurso o usar un recurso predeterminado.
Si no ves ningún registro en el Explorador 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ú (&blacktriangledown;) en la parte superior del visor de registros y selecciona Convertir a filtro avanzado.
2. Borra el contenido que aparece en el cuadro de filtro.
3. Haz clic en Enviar filtro.
Puedes examinar las entradas individuales para identificar tus recursos.

Para obtener más información, consulta Usa el Explorador de registros.