Attiva gli indicatori di telemetria nelle librerie client Node.js

Cloud de Confiance by S3NS fornisce funzionalità avanzate di monitoraggio, logging e analisi per le applicazioni Node.js.

Le librerie client Node.js sono strumentate per emettere dati di tracciamento. La strumentazione è facoltativa, quindi devi attivarla in modo esplicito. Questo documento descrive gli indicatori disponibili e come attivarli.

Indicatori disponibili

Le librerie client Node.js sono strumentate per generare i seguenti indicatori:

1. Span INFO per ogni richiesta client logica. In genere, una singola chiamata al metodo nella struct client ottiene uno span di questo tipo (ad esempio, la chiamata di accessSecretVersion su un SecretManagerServiceClient).
2. Span INFO per ogni tentativo RPC di basso livello. In genere, un singolo metodo nella struct client ottiene uno span di questo tipo, ma potrebbero essercene di più se la libreria deve riprovare l'RPC.

Questi span e log seguono le convenzioni semantiche di OpenTelemetry con attributi aggiuntivi Cloud de Confiance by S3NS . Sia gli span che i log devono essere adatti al monitoraggio della produzione. Gli indicatori includono attributi OpenTelemetry standard (ad esempio, http.response.status_code e rpc.system.name).

Per un elenco completo degli attributi standard, consulta le convenzioni semantiche HTTP e gRPC di OpenTelemetry.

Attivare gli indicatori di telemetria

Per proteggere i dati sensibili, gli indicatori di telemetria sono disattivati per impostazione predefinita.

In Node.js, devi configurare il client per emettere tracce e configurare sottoscrittori ed esportatori per inviare questi indicatori a un servizio esterno.

Per configurare il client, puoi impostare la seguente variabile di ambiente:

export GOOGLE_SDK_NODE_ENABLE_TRACING=true

Quando il tracciamento è attivo e l'applicazione ha uno span OpenTelemetry attivo nel contesto corrente quando chiami un metodo della libreria client, la libreria client collega automaticamente i suoi span come figli dello span attivo.

Esportare le tracce

Una volta attivata la telemetria nelle librerie client, l'applicazione deve essere configurata per raccogliere ed esportare questi dati nel servizio di osservabilità.

Per istruzioni dettagliate sulla configurazione dei dati di correlazione delle tracce OpenTelemetry, consulta l'esempio di osservabilità nel repository Node.js.

Per esportare gli tracing span generati dalle Cloud de Confiance by S3NS librerie client in OpenTelemetry, devi configurare un provider di tracer e un esportatore:

const cloudTraceExporter = new TraceExporter();
const spanProcessor = new BatchSpanProcessor(cloudTraceExporter);

const provider = new NodeTracerProvider({
  spanProcessors: [spanProcessor],
});
provider.register();