Activer les signaux de télémétrie dans les bibliothèques clientes Node.js

Cloud de Confiance by S3NS fournit des fonctionnalités de surveillance, de journalisation et de diagnostic performantes pour les applications Node.js.

Les bibliothèques clientes Node.js sont instrumentées pour émettre des données de traçage. L'instrumentation est facultative. Vous devez l'activer explicitement. Ce document décrit les signaux disponibles et explique comment les activer.

Signaux disponibles

Les bibliothèques clientes Node.js sont instrumentées pour générer les signaux suivants :

  1. Plages INFO pour chaque requête client logique. En règle générale, un seul appel de méthode dans la structure du client obtient une telle plage (par exemple, l'appel de accessSecretVersion sur un SecretManagerServiceClient).
  2. Plages INFO pour chaque tentative de RPC de bas niveau. En règle générale, une seule méthode dans la structure du client obtient une telle plage, mais il peut y en avoir plus si la bibliothèque doit réessayer le RPC.

Ces plages et ces journaux suivent les conventions sémantiques OpenTelemetry avec des Cloud de Confiance by S3NS attributs supplémentaires. Les plages et les journaux doivent être adaptés à la surveillance de la production. Les signaux incluent des attributs OpenTelemetry standards (par exemple, http.response.status_code et rpc.system.name).

Pour obtenir la liste complète des attributs standards, consultez les conventions sémantiques HTTP et gRPC OpenTelemetry.

Activer les signaux de télémétrie

Pour protéger les données sensibles, les signaux de télémétrie sont désactivés par défaut.

Dans Node.js, vous devez configurer le client pour qu'il émette des traces et configurer des abonnés et des exportateurs pour envoyer ces signaux à un service externe.

Pour configurer le client, vous pouvez définir la variable d'environnement suivante :

export GOOGLE_SDK_NODE_ENABLE_TRACING=true

Lorsque le traçage est activé et que votre application comporte une plage OpenTelemetry active dans le contexte actuel lorsque vous appelez une méthode de bibliothèque cliente, la bibliothèque cliente associe automatiquement ses plages en tant qu'enfants de votre plage active.

Exporter les traces

Une fois la télémétrie activée dans les bibliothèques clientes, votre application doit être configurée pour collecter et exporter ces données vers votre service d'observabilité.

Pour obtenir des instructions détaillées sur la configuration des données de corrélation des traces OpenTelemetry, consultez l'exemple d'observabilité dans le dépôt Node.js.

Pour exporter les tracing plages générées par les Cloud de Confiance by S3NS bibliothèques clientes vers OpenTelemetry, vous devez configurer un fournisseur de traceurs et un exportateur :

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

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