Konfiguration der JSON- und Klartext-Protokollformate

Das Erfassen Ihrer Protokollausgaben als JSON-Schlüsselwertpaare erleichtert das Suchen und Filtern beim Debuggen Ihrer Event-Funktionen. Mit Protokollen im JSON-Format können Sie Ihren Protokollen auch Tags und Kontextinformationen hinzufügen. Das kann Ihnen bei der automatisierten Analyse großer Mengen von Protokolldaten helfen. Sofern Ihr Entwicklungsworkflow nicht auf vorhandenen Tools basiert, die Lambda-Protokolle im Klartext verarbeiten, empfehlen wir Ihnen, JSON als Protokollformat auszuwählen.

Für alle von Lambda verwalteten Laufzeiten können Sie wählen, ob die Systemprotokolle Ihrer Event Function im unstrukturierten Klartext- oder JSON-Format an CloudWatch Logs gesendet werden. Systemprotokolle sind die von Lambda generierten Protokolle und werden manchmal auch als Plattformereignisprotokolle bezeichnet.

Wenn Sie eine der unterstützten integrierten Protokollierungsmethoden verwenden, kann Lambda für unterstützte Laufzeiten auch die Anwendungsprotokolle Ihrer Event-Funktion (die Protokolle, die Ihr Event-Funktionscode generiert) im strukturierten JSON-Format ausgeben. Wenn Sie das Protokollformat Ihrer Event-Funktion für diese Laufzeiten konfigurieren, gilt die von Ihnen gewählte Konfiguration sowohl für System- als auch für Anwendungsprotokolle.

Wenn Ihre Event-Funktion für unterstützte Laufzeiten eine unterstützte Protokollierungsbibliothek oder -methode verwendet, müssen Sie keine Änderungen an Ihrem vorhandenen Code vornehmen, damit Lambda Logs in strukturiertem JSON erfasst.

Unterstützte Laufzeiten und Protokollierungsmethoden

Lambda unterstützt derzeit die Option, strukturierte JSON-Anwendungsprotokolle für folgende Laufzeiten auszugeben.

Damit Lambda die Anwendungsprotokolle Ihrer Event Function CloudWatch im strukturierten JSON-Format senden kann, muss Ihre Event Function die folgenden integrierten Protokollierungstools verwenden, um Logs auszugeben:

Für andere verwaltete Lambda-Laufzeiten unterstützt Lambda derzeit nur nativ die Erfassung von Systemprotokollen im strukturierten JSON-Format. Sie können jedoch weiterhin Anwendungsprotokolle zu jeder Laufzeit im strukturierten JSON-Format erfassen, indem Sie Protokollierungstools wie Powertools für AWS Lambda die Ausgabe von Protokollausgaben im JSON-Format verwenden.

Standardprotokollformate

Derzeit ist das Standard-Protokollformat für alle Lambda-Laufzeiten das Klartextformat. Für Lambda Managed Instances ist das Protokollformat immer JSON und kann nicht geändert werden.

Wenn Sie bereits Logging-Bibliotheken wie Powertools verwenden, AWS Lambda um Ihre Event Function-Logs im strukturierten JSON-Format zu generieren, müssen Sie Ihren Code nicht ändern, wenn Sie die JSON-Protokollformatierung auswählen. Lambda codiert keine Protokolle doppelt, die bereits JSON-kodiert sind, sodass die Anwendungsprotokolle Ihrer Event Function weiterhin wie zuvor erfasst werden.

JSON-Format für Systemprotokolle

Wenn Sie das Protokollformat Ihrer Event-Funktion als JSON konfigurieren, wird jedes Systemprotokollelement (Plattformereignis) als JSON-Objekt erfasst, das Schlüsselwertpaare mit den folgenden Schlüsseln enthält:

Das Format des "record"-Werts hängt von der Art des protokollierten Ereignisses ab. Weitere Informationen finden Sie unter Objekttypen für Telemetrie-API-Ereignisse. Weitere Hinweise zu den Protokollebenen, die Systemprotokollereignissen zugewiesen sind, finden Sie unter Zuordnung von Ereignissen auf Systemprotokollebene.

Zum Vergleich zeigen die folgenden beiden Beispiele dieselbe Protokollausgabe sowohl im Klartext- als auch im strukturierten JSON-Format. Beachten Sie, dass Systemprotokollereignisse in den meisten Fällen mehr Informationen enthalten, wenn sie im JSON-Format ausgegeben werden, als wenn sie im Klartext ausgegeben werden.

2024-03-13 18:56:24.046000 fbe8c1   INIT_START  Runtime Version: python:3.12.v18  Runtime Version ARN: arn:aws:lambda:eu-west-1::runtime:edb5a058bfa782cb9cedc6d534ac8b8c193bc28e9a9879d9f5ebaaf619cd0fc0

{
  "time": "2024-03-13T18:56:24.046Z",
  "type": "platform.initStart",
  "record": {
    "initializationType": "on-demand",
    "phase": "init",
    "runtimeVersion": "python:3.12.v18",
    "runtimeVersionArn": "arn:aws:lambda:eu-west-1::runtime:edb5a058bfa782cb9cedc6d534ac8b8c193bc28e9a9879d9f5ebaaf619cd0fc0"
  }
}

JSON-Format für Anwendungsprotokolle

Wenn Sie das Protokollformat Ihrer Event-Funktion als JSON konfigurieren, werden Anwendungsprotokollausgaben, die mit unterstützten Protokollierungsbibliotheken und -methoden geschrieben wurden, als JSON-Objekt erfasst, das Schlüsselwertpaare mit den folgenden Schlüsseln enthält.

Je nach Laufzeit und Protokollierungsmethode, die Ihre Funktion verwendet, kann dieses JSON-Objekt auch zusätzliche Schlüsselpaare enthalten. Wenn Ihre Funktion beispielsweise console Methoden verwendet Node.js, um Fehlerobjekte mit mehreren Argumenten zu protokollieren, enthält das JSON-Objekt zusätzliche Schlüssel-Wert-Paare mit den Schlüsseln errorMessageerrorType, undstackTrace. Weitere Informationen zu JSON-formatierten Protokollen in verschiedenen Lambda-Laufzeiten finden Sie unter Python-Lambda-Ereignisfunktionen protokollieren und überwachen, Node.js Lambda-Ereignisfunktionen protokollieren und überwachen und Protokollieren und Überwachen von Java-Lambda-Eventfunktionen.

Zum Vergleich zeigen die folgenden beiden Beispiele dieselbe Protokollausgabe sowohl im Klartext- als auch im strukturierten JSON-Format.

2024-10-27T19:17:45.586Z 79b4f56e-95b1-4643-9700-2807f4e68189 INFO some log message

{
    "timestamp":"2024-10-27T19:17:45.586Z",
    "level":"INFO",
    "message":"some log message",
    "requestId":"79b4f56e-95b1-4643-9700-2807f4e68189"
}

Das Protokollformat Ihrer Event-Funktion festlegen

Um das Protokollformat für Ihre Event-Funktion zu konfigurieren, können Sie die Lambda-Konsole oder die AWS Command Line Interface (AWS CLI) verwenden. Sie können das Protokollformat einer Event-Funktion auch mithilfe der API-Befehle CreateFunctionund UpdateFunctionConfigurationLambda, der Ressource AWS Serverless Application Model (AWS SAM) AWS::Serverless: :Function und der Ressource CloudFormation AWS::Lambda: :Function konfigurieren.

Das Ändern des Protokollformats Ihrer Event-Funktion hat keine Auswirkungen auf bestehende Protokolle, die in Logs gespeichert sind. CloudWatch Nur neue Protokolle verwenden das aktualisierte Format.

Wenn Sie das Protokollformat Ihrer Event-Funktion in JSON ändern und keine Protokollebene festlegen, setzt Lambda die Anwendungsprotokollebene und die Systemprotokollebene Ihrer Event-Funktion automatisch auf INFO. Das bedeutet, dass Lambda nur Protokollausgaben der Stufe INFO und niedriger an CloudWatch Logs sendet. Weitere Informationen zur Filterung auf Anwendungs- und Systemprotokollebene finden Sie unter Log-level filtern

Bei Node.js Funktionen, die EMF-Logs (Embedded Metric Format) ausgeben, kann die Änderung des Protokollformats Ihrer Event-Funktion in JSON dazu führen, dass Ihre Metriken nicht erkannt CloudWatch werden können.