Questa pagina è stata tradotta dall'API Cloud Translation.

Generare tracce e metriche con Node.js

Questo documento descrive come modificare un'app JavaScript Node.js per raccogliere tracce e metriche utilizzando il framework open source OpenTelemetry, e come per scrivere log JSON strutturati in uscita standard. Il presente documento fornisce inoltre informazioni su un'app Node.js di esempio che puoi installare ed eseguire. L'app utilizza il framework web Fastify ed è configurato per generare metriche, per le tracce e i log.

Per saperne di più sulla strumentazione, consulta i seguenti documenti:

Informazioni sulla misurazione manuale e automatica

Per questo linguaggio, OpenTelemetry definisce la strumentazione automatica come la pratica di raccogliere la telemetria da librerie e framework senza apportare modifiche al codice. Tuttavia, devi installare i moduli e impostare le variabili di ambiente.

Questo documento non descrive la strumentazione automatica. Per informazioni su questo argomento, consulta Strumentazione automatica per Node.

Per informazioni generali, consulta OpenTelemetry Instrumentation for Node.

Prima di iniziare

Enable the Cloud Logging, Cloud Monitoring, and Cloud Trace APIs.

Enable the APIs

Instrumenta l'app per raccogliere tracce, metriche e log

Per eseguire l'instrumentazione dell'app in modo da raccogliere dati sulle metriche e sulle tracce e scrivere JSON strutturato nello standard output, svolgi i seguenti passaggi come descritto nelle sezioni successive di questo documento:

Configurare OpenTelemetry
Configura la tua app per precaricare la configurazione OpenTelemetry
Configurare il logging strutturato
Scrivere log strutturati

Configurare OpenTelemetry

La configurazione predefinita per l'SDK OpenTelemetry Node.js esporta le tracce utilizzando il protocollo OTLP. Inoltre, configura OpenTelemetry in modo da utilizzare il formato W3C Trace Context per propagare il contesto traccia. Questa configurazione garantisce che gli intervalli abbiano la corretta relazione padre-figlio all'interno di una traccia.

Il seguente esempio di codice illustra un modulo JavaScript per configurare OpenTelemetry.

Per visualizzare l'esempio completo, fai clic su Altro e poi seleziona Visualizza su GitHub.


diag.setLogger(
  new DiagConsoleLogger(),
  opentelemetry.core.getEnv().OTEL_LOG_LEVEL
);

const sdk = new opentelemetry.NodeSDK({
  instrumentations: getNodeAutoInstrumentations({
    // Disable noisy instrumentations
    '@opentelemetry/instrumentation-fs': {enabled: false},
  }),
  resourceDetectors: getResourceDetectorsFromEnv(),
  metricReader: getMetricReader(),
});

try {
  sdk.start();
  diag.info('OpenTelemetry automatic instrumentation started successfully');
} catch (error) {
  diag.error(
    'Error initializing OpenTelemetry SDK. Your application is not instrumented and will not produce telemetry',
    error
  );
}

// Gracefully shut down the SDK to flush telemetry when the program exits
process.on('SIGTERM', () => {
  sdk
    .shutdown()
    .then(() => diag.debug('OpenTelemetry SDK terminated'))
    .catch(error => diag.error('Error terminating OpenTelemetry SDK', error));
});

Il codice di esempio precedente configura OpenTelemetry per esportare le metriche utilizzando il protocollo OTLP e utilizza il pacchetto @opentelemetry/auto-instrumentations-node per configurare tutte le misurazioni Node.js disponibili.

Per assicurarsi che tutta la telemetria in attesa venga svuotata e che le connessioni vengano chiuse in modo corretto prima dell'arresto dell'applicazione, il gestore SIGTERM chiama shutdown.

Per ulteriori informazioni e opzioni di configurazione, consulta la strumentazione automatica di OpenTelemetry Node.js.

Configura l'app per precaricare la configurazione OpenTelemetry

Per configurare l'app in modo che scriva log strutturati e raccolga metriche e dati traccia utilizzando OpenTelemetry, aggiorna l'invocazione dell'app per precaricare il modulo di strumentazione con il flag --require di Node.js. Utilizzo Il flag --require assicura che OpenTelemetry venga inizializzato prima della tua app . Per ulteriori informazioni, consulta la guida introduttiva a OpenTelemetry Node.js.

Il seguente esempio di codice illustra un Dockerfile che passa il flag --require:

CMD node --require ./build/src/instrumentation.js build/src/index.js 2>&1 | tee /var/log/app.log

Configura il logging strutturato

Per includere le informazioni sulla traccia all'interno dei log in formato JSON scritti nell'output standard, configura l'app in modo da generare log strutturati in formato JSON. Fastify utilizza il framework di log Pino e fornisce un logger in ogni come gestore delle richieste. Il seguente esempio di codice illustra un LoggerOptions Pino che configura l'app per generare log strutturati JSON:


// Expected attributes that OpenTelemetry adds to correlate logs with spans
interface LogRecord {
  trace_id?: string;
  span_id?: string;
  trace_flags?: string;
  [key: string]: unknown;
}

// https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity
const PinoLevelToSeverityLookup: Record<string, string | undefined> = {
  trace: 'DEBUG',
  debug: 'DEBUG',
  info: 'INFO',
  warn: 'WARNING',
  error: 'ERROR',
  fatal: 'CRITICAL',
};

export const loggerConfig = {
  messageKey: 'message',
  // Same as pino.stdTimeFunctions.isoTime but uses "timestamp" key instead of "time"
  timestamp(): string {
    return `,"timestamp":"${new Date(Date.now()).toISOString()}"`;
  },
  formatters: {
    log(object: LogRecord): Record<string, unknown> {
      // Add trace context attributes following Cloud Logging structured log format described
      // in https://cloud.google.com/logging/docs/structured-logging#special-payload-fields
      const {trace_id, span_id, trace_flags, ...rest} = object;

      return {
        'logging.googleapis.com/trace': trace_id,
        'logging.googleapis.com/spanId': span_id,
        'logging.googleapis.com/trace_sampled': trace_flags
          ? trace_flags === '01'
          : undefined,
        ...rest,
      };
    },
    // See
    // https://getpino.io/#/docs/help?id=mapping-pino-log-levels-to-google-cloud-logging-stackdriver-severity-levels
    level(label: string) {
      return {
        severity:
          PinoLevelToSeverityLookup[label] ?? PinoLevelToSeverityLookup['info'],
      };
    },
  },
} satisfies LoggerOptions;

La configurazione precedente estrae le informazioni sull'intervallo attivo dal messaggio del log e le aggiunge come attributi al log strutturato JSON. Questi attributi possono quindi essere utilizzati per correlare un log a una traccia:

logging.googleapis.com/trace: nome della risorsa della traccia associata alla voce di log.
logging.googleapis.com/spanId: l'ID intervallo con la traccia associata alla voce di log.
logging.googleapis.com/trace_sampled: il valore di questo campo deve essere true o false.

Per ulteriori informazioni su questi campi, consulta la struttura LogEntry.

Per utilizzare la configurazione Pino con Fastify, passa l'oggetto di configurazione logger quando creando l'app Fastify:

// Create the Fastify app providing the Pino logger config
const fastify = Fastify({
  logger: loggerConfig,
});

Scrittura di log strutturati

Per scrivere log strutturati che si colleghino a una traccia, utilizza il metodo Pino fornito da Fastify logger. Ad esempio, l'istruzione seguente mostra come chiamare il metodo Logger.info():

request.log.info({subRequests}, 'handle /multi request');

OpenTelemetry compila automaticamente le voci di log di Pino con il contesto dell'ambito dell'ambito attivo corrente nel contesto OpenTelemetry. Questo contesto di intervallo viene quindi incluso nei log JSON descritti in Configura il logging strutturato.

Esegui un'app di esempio configurata per raccogliere dati di telemetria

L'app di esempio utilizza formati indipendenti dal fornitore, tra cui JSON per i log e OTLP per le metriche e le tracce, nonché il framework Fastify. Per indirizzare di telemetria a Google Cloud, questo esempio utilizza il valore di OpenTelemetry Collector configurato con gli esportatori di Google. L'app ha due endpoint:

L'endpoint /multi è gestito dalla funzione handleMulti. Il carico nell'app invia richieste all'endpoint /multi. Quando questo quando un endpoint riceve una richiesta, invia da 3 a 7 l'endpoint /single sul server locale.

/**
 * handleMulti handles an http request by making 3-7 http requests to the /single endpoint.
 *
 * OpenTelemetry instrumentation requires no changes here. It will automatically generate a
 * span for the handler body.
 */
fastify.get('/multi', async request => {
  const subRequests = randInt(3, 8);
  request.log.info({subRequests}, 'handle /multi request');

  for (let i = 0; i < subRequests; i++) {
    await axios.get(`http://localhost:${port}/single`);
  }
  return 'ok';
});

L'endpoint /single è gestito dalla funzione handleSingle. Quando questo endpoint riceve una richiesta, dorme per un breve ritardo e poi risponde con una stringa.

/**
 * handleSingle handles an http request by sleeping for 100-200 ms. It writes the number of
 * milliseconds slept as its response.
 */
fastify.get('/single', async request => {
  // Sleep between 100-200 milliseconds
  const sleepMillis = randInt(100, 200);
  request.log.info({sleepMillis}, 'Going to sleep');
  await sleep(sleepMillis);
  return `slept ${sleepMillis}\n`;
});

Scarica ed esegui il deployment dell'app

Per eseguire il sample:

In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

Clona il repository:

git clone https://github.com/GoogleCloudPlatform/opentelemetry-operations-js

Vai alla directory di esempio:

cd opentelemetry-operations-js/samples/instrumentation-quickstart

Crea ed esegui l'esempio:

docker compose up --abort-on-container-exit

Se non esegui l'applicazione su Cloud Shell, eseguila con la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS che rimanda a un file delle credenziali. Credenziali predefinite dell'applicazione fornisce un file delle credenziali in $HOME/.config/gcloud/application_default_credentials.json.

# Set environment variables
export GOOGLE_CLOUD_PROJECT="PROJECT_ID"
export GOOGLE_APPLICATION_CREDENTIALS="$HOME/.config/gcloud/application_default_credentials.json"
export USERID="$(id -u)"

# Run
docker compose -f docker-compose.yaml -f docker-compose.creds.yaml up --abort-on-container-exit

Visualizzare le metriche

La strumentazione OpenTelemetry nell'app di esempio genera Prometheus che puoi visualizzare utilizzando Esplora metriche:

Prometheus/http_server_duration_milliseconds/histogram registra la durata delle richieste del server e archivia i risultati in un istogramma.
Prometheus/http_client_duration_milliseconds/histogram registra la durata delle richieste del client e memorizza i risultati in un istogramma.

Per visualizzare le metriche generate dall'app di esempio, procedi nel seguente modo:

Nella console Google Cloud, vai alla pagina Esplora metriche:
Vai a Esplora metriche

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
Nell'elemento Metrica, espandi il menu Seleziona una metrica, inserisci http_server nella barra dei filtri, poi utilizza i sottomenu per selezionare un tipo di risorsa e una metrica specifici:
1. Nel menu Risorse attive, seleziona Target Prometheus.
2. Nel menu Categorie di metriche attive, seleziona Http.
3. Nel menu Metriche attive, seleziona una metrica.
4. Fai clic su Applica.
Configura la visualizzazione dei dati.
Quando le misurazioni di una metrica sono cumulative, Metrics Explorer normalizza automaticamente i dati misurati in base al periodo di allineamento, in modo che il grafico mostri una percentuale. Per per saperne di più, consulta Tipi, tipi e conversioni.

Quando vengono misurati valori interi o doppi, ad esempio con i due valori counter, Metrics Explorer somma automaticamente tutte le serie temporali. Per visualizzare i dati relativi alle route HTTP /multi e /single, imposta il primo menu della voce Aggregation su None.

Per ulteriori informazioni sulla configurazione di un grafico, consulta Seleziona le metriche quando utilizzi Esplora metriche.

Visualizza le tue tracce

Per visualizzare i dati di traccia:

Nella console Google Cloud, vai alla pagina Esplora tracce.
Vai a Trace Explorer

Puoi trovare questa pagina anche utilizzando la barra di ricerca.
Nel grafico a dispersione, seleziona una traccia con l'URI /multi.
Nel grafico di Gantt nel riquadro Dettagli su Trace, seleziona l'intervallo contrassegnato come /multi.

Si apre un riquadro che mostra informazioni sulla richiesta HTTP. Questi dettagli includono il metodo, il codice di stato, il numero di byte e l'agente utente del chiamante.
Per visualizzare i log associati a questa traccia, seleziona Log e Eventi.

La scheda mostra i singoli log. Per visualizzare i dettagli della voce di log, espandila. Puoi anche fare clic su Visualizza log e visualizzare il log. mediante Esplora log.

Per ulteriori informazioni sull'utilizzo di Trace Explorer, consulta Trovare ed esplorare le tracce.

Visualizza i log

Da Esplora log, puoi ispezionare i log e anche visualizzare le tracce associate, se esistono.

Nella console Google Cloud, vai alla pagina Esplora log:
Vai a Esplora log

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.
Individua un log con la descrizione di handle /multi request.

Per visualizzare i dettagli del log, espandi la voce di log.
Fai clic su Tracce in una voce di log con "handle /multi-richiesta" quindi seleziona Visualizza dettagli traccia.

Si apre un riquadro Dettagli traccia che mostra la traccia selezionata.

Per ulteriori informazioni sull'utilizzo di Esplora log, consulta Visualizza i log utilizzando Esplora log.