Passer au contenu principal
Elasticsearch est un moteur de recherche et d’analyse populaire. L’intégration AppSignal pour Node.js pour Elasticsearch fournit une instrumentation automatique pour le client Node.js d’Elasticsearch.

Installation

Le client Node.js d’Elasticsearch inclut une instrumentation via OpenTelemetry. Il rapportera automatiquement les données au package AppSignal pour Node.js. Aucune configuration supplémentaire n’est nécessaire pour instrumenter Elasticsearch dans votre application.

Fonctionnalités

L’instrumentation intégrée capture des spans pour les requêtes de recherche, les opérations d’indexation et d’autres interactions avec votre cluster Elasticsearch. L’intégration enverra à AppSignal des spans représentant la durée d’exécution de chaque appel à l’API Elasticsearch avec des informations sur l’opération.

Configuration

L’instrumentation automatique peut être désactivée à partir de la version 9.x de @elastic/elasticsearch. Si vous utilisez la version 8.x de @elastic/elasticsearch, assurez-vous d’utiliser @elastic/transport version 8.10.0 ou supérieure.
Vous pouvez désactiver l’instrumentation d’Elasticsearch en :
  • définissant une variable d’environnement ;
OTEL_ELASTICSEARCH_ENABLED=false
  • utilisant un Transport personnalisé.
import {
  Transport,
  TransportRequestOptions,
  TransportRequestParams,
} from "@elastic/transport";

class CustomTransport extends Transport {
  async request(
    params: TransportRequestParams,
    options: TransportRequestOptions = {},
  ): Promise<any> {
    options.openTelemetry = { enabled: false };
    return super.request(params, options);
  }
}

const client = new Client({
  /*
   your client config...
  */
  Transport: CustomTransport,
});
Vous pouvez également laisser l’instrumentation activée et la désactiver pour un seul appel d’API en passant un objet TransportRequestOptions personnalisé comme deuxième argument à tout appel d’API :
const response = await client.search({ ... }, {
  openTelemetry: { enabled: false },
});