Strumentazione del codice Node.js in AWS Lambda

Lambda si integra con AWS X-Ray per aiutarti a tracciare, eseguire il debug e ottimizzare le applicazioni Lambda. Puoi utilizzare X-Ray per tracciare una richiesta mentre attraversa le risorse nell'applicazione, che possono includere funzioni Lambda e altri servizi AWS .

Per inviare dati di tracciamento a X-Ray, puoi utilizzare una delle SDK due librerie:

Ciascuno di essi SDKs offre modi per inviare i dati di telemetria al servizio X-Ray. Puoi quindi utilizzare X-Ray per visualizzare, filtrare e analizzare le metriche delle prestazioni dell'applicazione per identificare i problemi e le opportunità di ottimizzazione.

Utilizzo ADOT per strumentare le funzioni di Node.js

ADOTfornisce layer Lambda completamente gestiti che racchiudono tutto il necessario per raccogliere dati di telemetria utilizzando. OTel SDK Usando questo livello, è possibile strumentare le funzioni Lambda senza dover modificare alcun codice funzione. Puoi anche configurare il tuo layer per eseguire l'inizializzazione personalizzata di. OTel Per ulteriori informazioni, consulta Configurazione personalizzata per ADOT Collector on Lambda nella ADOT documentazione.

Per i runtime di Node.js, puoi aggiungere il layer Lambda AWS gestito ADOT per Javascript per strumentare automaticamente le tue funzioni. Per istruzioni dettagliate su come aggiungere questo layer, consulta AWS Distro for OpenTelemetry Lambda JavaScript Support ADOT nella documentazione.

Utilizzo degli X-Ray SDK per strumentare le funzioni di Node.js

Per registrare i dettagli sulle chiamate effettuate dalla funzione Lambda ad altre risorse nell'applicazione, è anche possibile utilizzare il SDK AWS X-Ray per Node.js. Per ottenerloSDK, aggiungete il aws-xray-sdk-core pacchetto alle dipendenze dell'applicazione.

{
  "name": "blank-nodejs",
  "version": "1.0.0",
  "private": true,
  "devDependencies": {
    "jest": "29.7.0"
  },
  "dependencies": {
    "@aws-sdk/client-lambda": "3.345.0",
    "aws-xray-sdk-core": "3.5.3"
  },
  "scripts": {
    "test": "jest"
  }
}

Per AWS SDK i client Instrument nella AWS SDK for JavaScript v3, avvolgi l'istanza del client con il captureAWSv3Client metodo.

const AWSXRay = require('aws-xray-sdk-core');
const { LambdaClient, GetAccountSettingsCommand } = require('@aws-sdk/client-lambda');

// Create client outside of handler to reuse
const lambda = AWSXRay.captureAWSv3Client(new LambdaClient());

// Handler
exports.handler = async function(event, context) {
    event.Records.forEach(record => {
  ...

Il runtime Lambda imposta alcune variabili di ambiente per configurare X-Ray. SDK Ad esempio, Lambda imposta in modo da AWS_XRAY_CONTEXT_MISSING LOG_ERROR evitare la generazione di errori di runtime dall'X-Ray. SDK Per impostare una strategia mancante di contesto personalizzato, sovrascrivi la variabile di ambiente nella configurazione della funzione in modo da non avere alcun valore, quindi puoi impostare la strategia mancante di contesto a livello di programmazione.

const AWSXRay = require('aws-xray-sdk-core');

// Configure the context missing strategy to do nothing
AWSXRay.setContextMissingStrategy(() => {});

Per ulteriori informazioni, consulta Usa le variabili di ambiente Lambda per configurare i valori nel codice.

Dopo aver aggiunto le dipendenze corrette e apportato le modifiche necessarie al codice, attiva la traccia nella configurazione della funzione tramite la console Lambda o il. API

Attivazione del tracciamento con la console Lambda

Per attivare il tracciamento attivo sulla funzione Lambda con la console, attenersi alla seguente procedura:

Attivazione del tracciamento con la Lambda API

Configura il tracciamento sulla tua funzione Lambda con AWS SDK o, utilizza AWS CLI le API seguenti operazioni:

Il AWS CLI comando di esempio seguente abilita il tracciamento attivo su una funzione denominata my-function.

aws lambda update-function-configuration --function-name my-function \
--tracing-config Mode=Active

La modalità di tracciamento fa parte della configurazione specifica della versione quando si pubblica una versione della funzione. Non è possibile modificare la modalità di tracciamento in una versione pubblicata.

Attivazione del tracciamento con AWS CloudFormation

Per attivare il tracciamento su una AWS::Lambda::Function risorsa in un AWS CloudFormation modello, utilizzate la proprietà. TracingConfig

Resources:
  function:
    Type: AWS::Lambda::Function
    Properties:
      TracingConfig:
        Mode: Active
      ...

Per una AWS::Serverless::Function risorsa AWS Serverless Application Model (AWS SAM), utilizzate la Tracing proprietà.

Resources:
  function:
    Type: AWS::Serverless::Function
    Properties:
      Tracing: Active
      ...

Interpretazione di una traccia X-Ray

La funzione ha bisogno dell'autorizzazione per caricare i dati di traccia su X-Ray. Quando si attiva il tracciamento nella console Lambda, Lambda aggiunge le autorizzazioni necessarie al ruolo di esecuzione della funzione. Altrimenti, aggiungete la AWSXRayDaemonWriteAccesspolitica al ruolo di esecuzione.

Dopo aver configurato il tracciamento attivo, è possibile osservare richieste specifiche tramite l'applicazione. Il grafico dei servizi X-Ray mostra informazioni sull'applicazione e tutti i suoi componenti. L'esempio seguente mostra un'applicazione con due funzioni. La funzione principale elabora gli eventi e talvolta restituisce errori. La seconda funzione in alto elabora gli errori che compaiono nel gruppo di log della prima e utilizza X-Ray, Amazon Simple Storage Service (Amazon S3) e Amazon Logs. AWS SDK CloudWatch

X-Ray non traccia tutte le richieste nell'applicazione. X-Ray applica un algoritmo di campionamento per garantire che il tracciamento avvenga in modo efficiente, continuando allo stesso tempo a fornire un campione rappresentativo di tutte le richieste. La frequenza di campionamento è di una richiesta al secondo e del 5% delle altre richieste. Non puoi configurare la frequenza di campionamento dei raggi X per le tue funzioni.

In X-Ray, una traccia registra informazioni su una richiesta elaborata da uno o più servizi. Lambda registra 2 segmenti per traccia, il che crea due nodi sul grafico del servizio. L'immagine seguente evidenzia questi due nodi:

Il primo nodo a sinistra rappresenta il servizio Lambda che riceve la richiesta di chiamata. Il secondo nodo rappresenta la specifica funzione Lambda. L'esempio seguente mostra una traccia con questi 2 segmenti. Entrambi sono denominati my-function, ma uno ha un'origine di AWS::Lambda e l'altro ha un'origine di. AWS::Lambda::Function Se il AWS::Lambda segmento mostra un errore, il servizio Lambda presentava un problema. Se il AWS::Lambda::Function segmento mostra un errore, la funzione presentava un problema.

Questo esempio espande il AWS::Lambda::Function segmento per mostrarne i tre sottosegmenti.

Il segmento di funzioni vecchio stile contiene i seguenti sottosegmenti:

Il segmento di funzione di nuovo stile non contiene un sottosegmento. Invocation I sottosegmenti dei clienti vengono invece collegati direttamente al segmento di funzioni. Per ulteriori informazioni sulla struttura dei segmenti di funzione di vecchio e nuovo stile, vedere. Informazioni sui monitoraggi di X-Ray

È inoltre possibile strumentare HTTP i client, registrare SQL le interrogazioni e creare sottosegmenti personalizzati con annotazioni e metadati. Per ulteriori informazioni, consulta SDK AWS X-Ray per Node.js nella Guida per gli sviluppatori di AWS X-Ray .

Memorizzazione delle dipendenze di runtime in un livello (X-RaySDK)

Se utilizzate X-Ray SDK per strumentare AWS SDK i client del codice della funzione, il pacchetto di implementazione può diventare piuttosto grande. Per evitare di caricare le dipendenze di runtime ogni volta che aggiorni il codice della funzione, impacchetta X-Ray in SDK un layer Lambda.

L'esempio seguente mostra una risorsa AWS::Serverless::LayerVersion che memorizza SDK AWS X-Ray per Node.js.

Resources:
  function:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: function/.
      Tracing: Active
      Layers:
        - !Ref libs
      ...
  libs:
    Type: AWS::Serverless::LayerVersion
    Properties:
      LayerName: blank-nodejs-lib
      Description: Dependencies for the blank sample app.
      ContentUri: lib/.
      CompatibleRuntimes:
        - nodejs16.x

Con questa configurazione, si aggiorna il livello della libreria solo se si modificano le dipendenze di runtime. Poiché il pacchetto di implementazione della funzione contiene solo il codice, questo può contribuire a ridurre i tempi di caricamento.

La creazione di un layer per le dipendenze richiede modifiche alla compilazione per generare l'archivio dei layer prima della distribuzione. Per un esempio funzionante, vedere l'applicazione di esempio blank-nodejs .