opentelemetry-instrumentation-elasticsearch

What it is and what it does

This package integrates Elasticsearch query tracing into OpenTelemetry, the industry standard for distributed observability. When installed and activated, it automatically captures telemetry data from all Elasticsearch operations made through the elasticsearch library—query details, response times, and errors—and exports them to your configured OpenTelemetry backend. It's part of the broader OpenTelemetry ecosystem and works alongside other instrumentation packages to give you end-to-end visibility into your application's database interactions.

The package wraps the elasticsearch library using wrapt and relies on opentelemetry-instrumentation to handle the instrumentation lifecycle. It emits semantic conventions defined by opentelemetry-semantic-conventions, ensuring your traces follow industry standards. Installation is straightforward and it supports Python versions 3.10, 3.11, 3.12, 3.13, and 3.14.

Use it for:

• Trace Elasticsearch queries in microservices to identify slow or failing database operations across distributed systems.
• Monitor Elasticsearch performance in production by exporting traces to a backend.
• Debug application issues by correlating Elasticsearch query traces with logs and metrics from other instrumented services.
• Analyze query patterns and latency distribution to optimize Elasticsearch usage and identify bottlenecks.
• Ensure compliance and audit requirements by capturing detailed Elasticsearch operation telemetry.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Adds distributed tracing to Elasticsearch queries made via the elasticsearch library, capturing request and response telemetry for OpenTelemetry-compatible observability platforms.

Yes, if you already use OpenTelemetry and the elasticsearch library. The package is actively maintained, has no known vulnerabilities, and low install friction. It is in beta (0.64b0) but widely used (top 5000 PyPI packages). Install it only if you have an OpenTelemetry collector or exporter configured; without one, instrumentation will run but produce no actionable output.

Install

opentelemetry-instrumentation-elasticsearch on PyPI

pip install opentelemetry-instrumentation-elasticsearch

uv add opentelemetry-instrumentation-elasticsearch

poetry add opentelemetry-instrumentation-elasticsearch

Installing opentelemetry-instrumentation-elasticsearch

Before you install

Low friction installation with four stable runtime dependencies (opentelemetry-api, opentelemetry-instrumentation, opentelemetry-semantic-conventions, wrapt). Package is actively maintained with recent releases and no known vulnerabilities.

License in practice

Apache-2.0 permissive license allows commercial and private use with minimal restrictions; suitable for most production environments.

Quickstart

pip install opentelemetry-instrumentation-elasticsearch

from opentelemetry.instrumentation.elasticsearch import ElasticsearchInstrumentor

ElasticsearchInstrumentor().instrument()

Requires Python >=3.10; elasticsearch library must be installed separately for instrumentation to take effect.

Verify before relying

• Whether instrumentation works with all elasticsearch-py versions or has specific version constraints.
• Performance overhead of tracing on typical Elasticsearch workloads.
• Compatibility with specific OpenTelemetry exporters and backends.

Package facts

Evidence: opentelemetry_instrumentation_elasticsearch-0.64b0-py3-none-any.whl

Tags

More Monitoring packages