Welche Methode verwenden: Logging-Agent oder Clientbibliothek?

Dieses Dokument enthält die Informationen, die Ihnen bei der Entscheidung helfen, ob Anwendungslogs programmatisch über Clientbibliotheken oder einen Logging-Agent an Cloud Logging gesendet werden. Logging-Agents senden in eine Datei wie stdout oder eine Datei geschriebene Daten als Logs an Cloud Logging. Dienste wie Google Kubernetes Engine, die flexible App Engine-Umgebung und Cloud Functions enthalten einen integrierten Logging-Agent. Für Compute Engine können Sie den Ops-Agent oder den Legacy-Cloud Logging-Agent installieren. Diese Agents erfassen Logs aus bekannten Dateispeicherorten oder Logging-Diensten wie Windows Event Log, journald oder syslogd.

Wenn Sie keine Clientbibliothek oder keinen Logging-Agent verwenden können oder nur experimentieren möchten, können Sie Logs mit dem Befehl gcloud logging write schreiben oder HTTP-Befehle an den Cloud Logging API-Endpunkt entries.write senden. Die Cloud Logging API unterstützt sowohl HTTP- als auch gRPC-Aufrufe. Der Ops-Agent und die meisten Logging-Clientbibliotheken rufen die gRPC Logging API auf. Der alte Logging-Agent und die Clientbibliotheken für einige Sprachen rufen die REST Logging API auf.

Hinweis: Für den Legacy-Logging-Agent werden keine neuen Features entwickelt und keine neuen Betriebssysteme unterstützt. Es wird empfohlen, für neue Arbeitslasten den Ops-Agent zu verwenden und schließlich Ihre vorhandenen VMs für die Verwendung des Ops-Agents umzustellen.

Agent oder Clientbibliotheken auswählen

Stellen Sie sich bei der Entscheidung, ob Sie einen Agent oder die Clientbibliotheken nutzen, folgende Fragen:

Wird Ihre Anwendung außerhalb von Google Cloud ausgeführt?

Wird Ihre Anwendung nicht in Google Cloud ausgeführt, müssen Sie Logs an die Logging API senden können. Zum Weiterleiten von Logs von lokalen Systemen an Logging empfehlen wir die Verwendung von BindPlane by observIQ. Weitere Informationen zu BindPlane finden Sie unter Informationen zu observIQ und BindPlane.

Alternativ können Sie Logs mithilfe von Clientbibliotheken direkt von der Anwendung an Logging weiterleiten. In sitzungsspezifischen Umgebungen wie beim serverlosen Computing müssen Sie Clientbibliotheken verwenden, um direkte Aufrufe an die Logging API zu senden.

Unterstützt der Google Cloud-Dienst, auf dem Ihre Anwendung ausgeführt wird,

Du schreibst Inhalte zu stdout und stderr in dein Projekt?

Einige Google Cloud-Dienste werden vollständig verwaltet, sodass Sie keine Agents verwenden müssen, um Logs an Ihr Google Cloud-Projekt zu senden. Sie können ein beliebiges etabliertes Logging-Framework in der Sprache Ihrer Wahl verwenden, z. B. Go, Node.js und Python, um Logs in Produkten an Logging zu senden, in denen stdout und stderr standardmäßig unterstützt werden. Die Verwendung von stdout und stderr anstelle der Verwendung von Clientbibliotheken bietet den Vorteil, dass Anwendungsabstürze das Senden von Logs an Ihr Projekt nicht beeinträchtigen. Informationen zum Senden von strukturierten Logs über stdout und stderr finden Sie im Abschnitt Kann das Logformat in Ihrer Anwendung flexibel geändert werden?.

Sie können Logging-Clientbibliotheken verwenden. Beachten Sie jedoch, dass dies eine Abhängigkeit von Logging für lokale Tests bedingen kann – selbst wenn Sie diese nicht unbedingt benötigen. Weiter macht die Verwendung der Clientbibliotheken eventuell auch eine komplexere Codierung erforderlich, um Zwischenspeicher und Wiederholungsversuche explizit zu verarbeiten. Außerdem wird bei jeder Verwendung der Logging-Clientbibliotheken ein neuer Verbindungsstream zur API erstellt. Diese neuen Verbindungen steigern die Komplexität, nutzten zusätzliche Ports und senden separate Anfragen, die nur die Logs der Anwendung enthalten. Das kann verschwenderisch sein, wenn nur wenige Logs vorhanden sind.

Müssen die Anwendungslogs in Ihrer lokalen Umgebung zugänglich sein?

Wenn Sie zum Debuggen und für andere Zwecke auf die Anwendungslogs in Ihrer lokalen Umgebung zugreifen müssen, können Sie die Logging-Module in einigen Sprachen verwenden, um Ausgaben an stdout und stderr zu senden. Logging-Clientbibliotheken für einige Sprachen unterstützen das Routing von Logs an stdout und stderr.

Wenn Sie Ihre Anwendung in Google Cloud-Diensten ausführen, die das automatische Senden von Logs, die in stdout und stderr geschrieben wurden, nicht an Ihr Google Cloud-Projekt senden, können Sie stdout- und stderr-Logs in Dateien auf dem Laufwerk erfassen und den Agent so konfigurieren, dass diese extrahiert und an Logging gesendet werden. Weitere Informationen finden Sie in der Konfigurationsanleitung für den Ops-Agent oder den Legacy-Logging-Agent.

Erfolgt die Agent-Installation manuell oder automatisch?

Einige Dienste installieren Agents automatisch oder ermöglichen es Ihnen, Agents selbst zu installieren. Wenn der von Ihnen verwendete Dienst die Installation von Agents nicht zulässt, müssen Sie die Clientbibliotheken nutzen, um Logging zu verwenden.

Führen Sie fluentd bereits in Ihrem System aus?

Der Legacy-Logging-Agent basiert auf fluentd.

Wenn fluentd bereits in Ihrem System ausgeführt wird und Sie diesen Daemon zum Senden Ihrer Logs an Logging verwenden möchten, verwenden Sie das Google Cloud Logging-Plug-in für fluentd.

Erfassen Sie auch Anwendungsmesswerte für Cloud Monitoring?

In Compute Engine-VMs kann der Ops-Agent Logs und die meisten Messwerte erfassen. Weitere Informationen finden Sie unter Ops-Agent-Features.

Wenn der Ops-Agent nicht für Ihre Anwendungsfälle geeignet ist, können Sie den Legacy-Monitoring-Agent oder die Monitoring-Clientbibliotheken verwenden, um Ihre Messwerte zu erfassen.

Können Sie das Logformat in Ihrer Anwendung flexibel ändern?

Anhand dieser Frage können Sie entscheiden, ob Ihre Anwendung strukturierte Logs generieren kann. Logging erkennt strukturierte Logs, wenn Sie die Logs im Format für strukturiertes Logging an die Logging API senden. Clientbibliotheken bieten die Methoden zur Verarbeitung dieses Formats.

Es gibt zwei Möglichkeiten, strukturierte Logs zu schreiben: Eine definiert bestimmte Felder im LogEntry-Umschlag, die andere bestimmt das jsonPayload-Feld innerhalb des LogEntry-Umschlags. Das Schema für die erste Option wird von Cloud Logging, das Schema für die zweite Option wird vom Nutzer bestimmt.

Sie müssen den Agent so konfigurieren, dass er strukturierte Logs erkennt. Standardmäßig sind die Agents so konfiguriert, dass sie Logs im JSON-Format erkennen und als strukturierte Logs verarbeiten. Wenn Ihre Anwendung ein eigenes Logformat hat, das Sie nicht ändern können, die Logs jedoch als strukturierte Logs erkannt werden sollen, müssen Sie Logs im strukturierten Logging-Format (in der Regel JSON) in stdout und stderr schreiben, damit die Agents sie als strukturierte Logs erkennen. Andernfalls müssen Sie den Agent so konfigurieren, dass er Ihr eigenes Format versteht.

Übersicht über die einzelnen Optionen

• Cloud Logging-Clientbibliotheken

  • Vorteile

    • Sie können Logs direkt an die Cloud Logging API leiten.
    • Einige Sprachen können über die Bibliothek Logs an stdout und stderr ausgeben.

  • Nachteile

    • Das Senden von Logs an Ihr Google Cloud-Projekt funktioniert nach Anwendungsabstürzen nicht mehr.

• Ops-Agent

  • Vorteile
    • Der Ops-Agent kann Logs und Messwerte mithilfe stabiler Open-Source-Technologien senden: Fluent Bit für die Logerfassung und den OpenTelemetry Collector zur Messwerterfassung.
    • Sie können sowohl Logs als auch Messwerte aus vielen gängigen Anwendungen erfassen. Weitere Informationen hierzu finden Sie unter Logs von Drittanbieteranwendungen überwachen und erfassen.
    • Sie können Logs in Ihrer lokalen Umgebung aufbewahren.
    • Sie können Logs nach dem Absturz einer Anwendung möglicherweise wiederherstellen.
    • Der Ops-Agent befindet sich in der aktiven Entwicklung.

• Legacy-Logging-Agent

  • Vorteile
    • Der Agent verwendet Fluentd zum Erfassen von Logs.
    • Sie können Logs in Ihrer lokalen Umgebung aufbewahren.
    • Sie können Logs nach dem Absturz einer Anwendung möglicherweise wiederherstellen.
  • Nachteile
    • Der Agent wird derzeit unterstützt, befindet sich aber nicht in der aktiven Entwicklung.

• stdout- und stderr-Logs automatisch an Ihr Google Cloud-Projekt gesendet

  • Vorteile
    • Dieser Vorgang ist eine gängige Methode, Logs an lokale Umgebungen auszugeben.
    • Sie können beliebige Logging-Bibliotheken verwenden.
    • Sie können Logs nach dem Absturz einer Anwendung möglicherweise wiederherstellen.
  • Nachteile
    • Nicht alle Umgebungen leiten Logs automatisch an Logging weiter.