Cloud Logging für Node.js einrichten

Für Node.js-Anwendungen werden Plug-ins für die beliebten Logging-Bibliotheken Winston und Bunyan verwaltet. Winston ist eine universelle Bibliothek, die eine Vielzahl von Logformattern und -transporten implementiert. Bunyan ist auf strukturierte JSON-Logs spezialisiert und unterstützt die Logformatierung durch eine Weiterleitung an die Bunyan-Befehlszeile.

Sie können die Logging-Clientbibliothek für Node.js auch direkt verwenden oder eigene Integrationen mit Ihrer bevorzugten Logging-Bibliothek erstellen. Ein Beispiel für ein Pino-Log-Framework finden Sie unter Strukturiertes Logging konfigurieren.

Der Logging-Agent muss nicht installiert sein, um Winston oder Bunyan auf einer Compute Engine-VM-Instanz zu verwenden.

Hinweise

1. Melden Sie sich bei Ihrem Google Cloud-Konto an. Wenn Sie mit Google Cloud noch nicht vertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

4. Cloud Logging API aktivieren.

   Aktivieren Sie die API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.

7. Cloud Logging API aktivieren.

   Aktivieren Sie die API

8. Bereiten Sie Ihre Umgebung für die Node.js-Entwicklung vor.

   Einrichtungsleitfaden für Node.js aufrufen

Logging konfigurieren

In diesem Abschnitt wird beschrieben, wie Sie die Plug-ins für die Logging-Bibliotheken Winston und Bunyan installieren und konfigurieren. Für Bunyan werden Informationen zur Verwendung von Bunyan mit einer Node.js Express-Anwendung bereitgestellt.

Sie können auch andere Ansätze verwenden. Beispielsweise können Sie mit dem Pino-Log-Framework strukturiertes Logging konfigurieren.

Winston-Plug-in installieren und konfigurieren

Cloud Logging enthält ein Plug-in für die Node.js-Logging-Bibliothek von Winston. Das Logging-Plug-in für Winston bietet eine einfachere, allgemeinere Ebene für die Arbeit mit Logging.

So installieren und konfigurieren Sie das Winston-Plug-in:

1. Verwenden Sie npm, um das Winston-Plug-in für Logging zu installieren:

   npm install --save @google-cloud/logging-winston winston

2. Importieren Sie das Plug-in und fügen Sie es Ihrer Winston-Konfiguration hinzu:

   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%');

3. Konfigurieren Sie das Plug-in.

   Sie können das Verhalten des Winston-Plug-ins mit denselben Konfigurationsoptionen anpassen, die auch von der Cloud-Clientbibliothek der Cloud Logging API für Node.js unterstützt werden. Diese Optionen können im Objekt options übergeben werden, das an den Plug-in-Konstruktor übergeben wird.

Bunyan-Plug-in installieren und konfigurieren

Cloud Logging enthält ein Plug-in für die Node.js-Logging-Bibliothek von Bunyan. Das Logging-Plug-in für Bunyan bietet eine einfachere, allgemeinere Ebene für die Arbeit mit Logging.

So installieren und konfigurieren Sie das Bunyan-Plug-in:

1. Verwenden Sie zum Installieren des Logging-Bunyan-Plug-ins npm:

   npm install --save bunyan @google-cloud/logging-bunyan

2. Importieren Sie das Plug-in und fügen es Ihrer Bunyan-Konfiguration hinzu:

   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%');

3. Konfigurieren Sie das Plug-in.

   Sie können das Verhalten des Bunyan-Plug-ins mit denselben Konfigurationsoptionen anpassen, die auch von der Cloud-Clientbibliothek der Cloud Logging API für Node.js unterstützt werden. Diese Optionen können im Objekt options übergeben werden, das an den Plug-in-Konstruktor übergeben wird.

Bunyan und Express verwenden

Sie können Bunyan mit Logging in einer Node.js-Express-Anwendung einrichten und verwenden.

// 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();

Weitere Informationen zur Installation finden Sie in der Dokumentation zu den Cloud Logging-Bibliotheken für Node.js. Probleme können Sie über die Problemverfolgung melden.

Logs mit der Cloud Logging-Clientbibliothek schreiben

Informationen zur direkten Verwendung der Cloud Logging-Clientbibliothek für Node.js finden Sie unter Cloud Logging-Clientbibliotheken.

In Google Cloud ausführen

Damit eine Anwendung Logs mithilfe der Cloud Logging-Bibliotheken für Node.js schreiben kann, muss das Dienstkonto für die zugrunde liegende Ressource die IAM-Rolle Logautor (roles/logging.logWriter) haben. In den meisten Google Cloud-Umgebungen wird das Standarddienstkonto automatisch für diese Rolle konfiguriert.

App Engine

Cloud Logging ist für App Engine automatisch aktiviert und das Standarddienstkonto Ihrer Anwendung hat standardmäßig die IAM-Berechtigungen zum Schreiben von Logeinträgen.

Zum Schreiben von Logeinträgen aus Ihrer Anwendung empfehlen wir die Verwendung von Bunyan oder Winston, wie auf dieser Seite beschrieben.

Weitere Informationen finden Sie unter Logs schreiben und ansehen.

Google Kubernetes Engine (GKE)

GKE weist dem Standarddienstkonto automatisch die IAM-Rolle Logautor (roles/logging.logWriter) zu. Wenn Sie Workload Identity mit diesem Standarddienstkonto verwenden, damit Arbeitslasten auf bestimmte Google Cloud APIs zugreifen können, ist keine zusätzliche Konfiguration erforderlich. Wenn Sie Workload Identity jedoch mit einem benutzerdefinierten IAM-Dienstkonto verwenden, muss das benutzerdefinierte Dienstkonto die Rolle „Logautor“ (roles/logging.logWriter) haben.

Bei Bedarf können Sie auch den folgenden Befehl verwenden, um beim Erstellen des Clusters den Zugriffsbereich logging.write hinzuzufügen:

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

Compute Engine

Hinweis: Wenn Sie die Cloud Logging-Bibliotheken für Node.js auf einer Compute Engine-VM-Instanz verwenden möchten, müssen Sie den Cloud Logging-Agent nicht installieren.

Wenn Sie Compute Engine-VM-Instanzen verwenden, fügen Sie der jeweiligen Instanz den Zugriffsbereich für cloud-platform hinzu. Wenn Sie eine neue Instanz über die Google Cloud Console erstellen, können Sie dies im Bereich Instanz erstellen im Abschnitt Identität und API-Zugriff tun. Verwenden Sie das Compute Engine-Standarddienstkonto oder ein anderes Dienstkonto und wählen Sie im Abschnitt Identität und API-Zugriff die Option Uneingeschränkten Zugriff auf alle Cloud APIs zulassen aus. Achten Sie darauf, dass jedem ausgewählten Dienstkonto im Bereich IAM & Verwaltung der Google Cloud Console die Rolle „Logautor“ zugewiesen ist.

Cloud Functions

In Cloud Functions wird die Rolle "Logautor" standardmäßig zugewiesen.

Die Cloud Logging-Bibliotheken für Node.js können ohne explizite Angabe von Anmeldedaten verwendet werden.

Cloud Functions ist für die automatische Verwendung von Cloud Logging konfiguriert.

Hinweis: In stdout und stderr geschriebene Logs werden automatisch an Cloud Logging gesendet, ohne dass Sie die Cloud Logging-Bibliotheken für Node.js verwenden müssen.

Lokal und extern ausführen

Wenn Sie die Cloud Logging-Bibliotheken für Node.js außerhalb von Google Cloud verwenden möchten, beispielsweise auf Ihrer eigenen Workstation, auf den Computern Ihres Rechenzentrums oder auf den VM-Instanzen eines anderen Cloud-Anbieters, müssen Sie Ihre Google Cloud-Projekt-ID und die entsprechenden Dienstkonto-Anmeldedaten direkt in den Cloud Logging-Bibliotheken für Node.js angeben.

Gehen Sie bei vorhandenen Dienstkonten so vor:

1. Gewähren Sie dem Dienstkonto die IAM-Rolle Logautor (roles/logging.logWriter). Weitere Informationen zu IAM-Rollen finden Sie unter Zugriffssteuerung.

2. Standardanmeldedaten für Anwendungen einrichten

Wenn Sie noch kein Dienstkonto haben, erstellen Sie eines. Informationen zu diesem Prozess finden Sie unter Dienstkonten erstellen.

Allgemeine Informationen zu den Authentifizierungsmethoden finden Sie unter Terminologie: Dienstkonten.

Winston verwenden:

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

Bunyan verwenden:

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

Logs ansehen

Rufen Sie in der Google Cloud Console die Seite Log-Explorer auf.

Zum Log-Explorer

Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

Im Log-Explorer müssen Sie eine oder mehrere Ressourcen angeben. Die Auswahl der Ressourcen ist jedoch möglicherweise nicht offensichtlich. Hier sind ein paar Tipps für den Einstieg.

• Wenn Sie Ihre Anwendung für App Engine bereitstellen oder die App Engine-spezifischen Bibliotheken verwenden, setzen Sie die Ressource auf GAE-Anwendung.

• Wenn Sie Ihre Anwendung auf der Compute Engine bereitstellen, setzen Sie die Ressource auf GCE-VM-Instanz.

• Wenn Sie Ihre Anwendung in Google Kubernetes Engine bereitstellen, wird der Ressourcentyp der Logeinträge von der Loggingkonfiguration des Clusters bestimmt. Eine ausführliche Erläuterung der Legacy-Lösungen für die Beobachtbarkeit von Google Cloud und von Kubernetes Monitoring für die Beobachtbarkeit von Google Cloud sowie zu den Auswirkungen dieser Optionen auf den Ressourcentyp finden Sie unter Zu Google Cloud-Kubernetes Monitoring für die Beobachtbarkeit migrieren.

• Wenn Ihre Anwendung die Cloud Logging API direkt nutzt, ist die Ressource von der API und Ihrer Konfiguration abhängig. Sie können in Ihrer Anwendung zum Beispiel eine Ressource angeben oder eine Standardressource verwenden.

• Wenn im Log-Explorer keine Logs zu sehen sind, wechseln Sie zum erweiterten Abfragemodus und verwenden Sie eine leere Abfrage, um alle Logeinträge zu sehen.

  1. Klicken Sie oben im Log-Explorer auf das Dreipunkt-Menü (▾) und wählen Sie In erweiterten Filter umwandeln aus, um zum erweiterten Abfragemodus zu wechseln.
  2. Löschen Sie den Inhalt, der im Filterfeld angezeigt wird.
  3. Klicken Sie auf Filter senden.

  Sie können die einzelnen Einträge prüfen, um Ihre Ressourcen zu identifizieren.

Weitere Informationen finden Sie unter Log-Explorer verwenden.