Configurazione dei formati di log JSON e testo normale

L'acquisizione degli output dei log come coppie chiave-valore JSON semplifica la ricerca e il filtraggio durante il debug delle funzioni degli eventi. Con i log in formato JSON, puoi aggiungere ai log anche tag e informazioni contestuali. Questo può aiutarti a eseguire analisi automatizzate di grandi volumi di dati di log. A meno che il flusso di lavoro di sviluppo non si basi su strumenti esistenti che utilizzano i log Lambda in testo normale, ti consigliamo di selezionare JSON come formato di log.

Per tutti i runtime gestiti da Lambda, puoi scegliere se i log di sistema della tua Event Function vengono inviati a CloudWatch Logs in testo semplice non strutturato o in formato JSON. I log di sistema sono i log generati da Lambda e a volte vengono chiamati log eventi della piattaforma.

Per i runtime supportati, quando si utilizza uno dei metodi di registrazione integrati supportati, Lambda può anche generare i log delle applicazioni di Event Function (i log generati dal codice Event Function) in formato JSON strutturato. Quando configurate il formato di registro di Event Function per questi runtime, la configurazione scelta si applica sia ai log di sistema che a quelli delle applicazioni.

Per i runtime supportati, se la tua Event Function utilizza una libreria o un metodo di registrazione supportato, non è necessario apportare modifiche al codice esistente per Lambda per acquisire i log in formato JSON strutturato.

Runtime e metodi di registrazione supportati

Lambda attualmente supporta l'opzione di generare i log delle applicazioni in formato JSON strutturato per i seguenti runtime.

Affinché Lambda invii i log delle applicazioni di Event Function CloudWatch in formato JSON strutturato, la Event Function deve utilizzare i seguenti strumenti di registrazione integrati per generare i log:

Per altri runtime Lambda gestiti, Lambda attualmente supporta nativamente solo l'acquisizione dei log di sistema in formato JSON strutturato. Tuttavia, è ancora possibile acquisire i log delle applicazioni in formato JSON strutturato in qualsiasi runtime utilizzando strumenti di registrazione come Powertools per AWS Lambda generare output di log in formato JSON.

Formati di log predefiniti

Attualmente, il formato di log predefinito per tutti i runtime Lambda è il testo normale. Per le istanze gestite Lambda, il formato di registro è sempre JSON e non può essere modificato.

Se utilizzi già librerie di registrazione come Powertools AWS Lambda per generare i registri delle funzioni degli eventi in formato strutturato JSON, non devi modificare il codice se selezioni la formattazione dei log JSON. Lambda non codifica due volte i log che sono già codificati in JSON, quindi i log delle applicazioni della tua Event Function continuano a essere acquisiti come prima.

Formato JSON per i log di sistema

Quando configuri il formato di registro di Event Function come JSON, ogni elemento del registro di sistema (evento della piattaforma) viene acquisito come un oggetto JSON che contiene coppie di valori chiave con le seguenti chiavi:

Il formato del valore "record" varia in base al tipo di evento registrato. Per ulteriori informazioni, consulta Tipi di oggetti degli eventi dell'API di telemetria. Per ulteriori informazioni sui livelli di log assegnati ai log eventi di sistema, consulta la pagina Strumento di mappatura degli eventi a livello di log di sistema.

A titolo di confronto, i due esempi seguenti mostrano lo stesso output log in formato di testo normale e in formato JSON strutturato. Tieni presente che, nella maggior parte dei casi, i log eventi di sistema contengono più informazioni quando vengono emessi in formato JSON rispetto a quando vengono emessi in testo normale.

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"
  }
}

Formato JSON per i log delle applicazioni

Quando configurate il formato di registro di Event Function come JSON, gli output dei log delle applicazioni scritti utilizzando le librerie e i metodi di registrazione supportati vengono acquisiti come un oggetto JSON che contiene coppie chiave-valore con le seguenti chiavi.

A seconda del metodo di runtime e registrazione utilizzato dalla funzione, questo oggetto JSON potrebbe contenere anche coppie di chiavi aggiuntive. Ad esempio Node.js, se la funzione utilizza console metodi per registrare gli oggetti di errore utilizzando più argomenti, l'oggetto JSON contiene coppie di valori chiave aggiuntive con le chiavierrorMessage, errorType e. stackTrace Per ulteriori informazioni sui log in formato JSON in diversi runtime Lambda, consulta Registra e monitora le funzioni degli eventi Python Lambda, Registra e monitora le Node.js funzioni degli eventi Lambda e Registra e monitora le funzioni degli eventi Java Lambda.

A titolo di confronto, i due esempi seguenti mostrano lo stesso output log in formato di testo normale e in formato JSON strutturato.

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"
}

Impostazione del formato di registro della funzione eventi

Per configurare il formato di registro per la tua Event Function, puoi usare la console Lambda o il AWS Command Line Interface ()AWS CLI. Puoi anche configurare il formato di registro di una funzione evento utilizzando i comandi CreateFunctione UpdateFunctionConfigurationLambda API, la risorsa AWS Serverless Application Model (AWS SAM) AWS::Serverless: :Function e la risorsa CloudFormation AWS::Lambda: :Function.

La modifica del formato di registro di Event Function non influisce sui log esistenti archiviati in Logs. CloudWatch Solo i nuovi registri utilizzano il formato aggiornato.

Se modifichi il formato di registro della funzione evento in JSON e non imposti il livello di registro, Lambda imposta automaticamente il livello di registro dell'applicazione e il livello di registro del sistema di Event Function su INFO. Ciò significa che Lambda invia solo output di log di livello INFO e inferiore a Logs. CloudWatch Per ulteriori informazioni sul filtraggio a livello di log di applicazioni e sistemi, consulta Log-level filtraggio

Per Node.js le funzioni che emettono registri in formato metrico incorporato (EMF), la modifica del formato di registro di Event Function in JSON potrebbe comportare l' CloudWatch impossibilità di riconoscere le metriche.