Jedis
OpenTelemetry Java agent instrumentation
This instrumentation enables database client spans and database client metrics for Jedis Redis operations.
- Name:
jedis-3.0 - Scope:
io.opentelemetry.jedis-3.0 - Target versions:
redis.clients:jedis:[3.0.0,4) - Library: https://github.com/redis/jedis
Telemetry
When default
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | db.operation (STRING), db.statement (STRING), db.system (STRING), network.peer.address (STRING), network.peer.port (LONG), network.type (STRING), peer.service (STRING), server.address (STRING), server.port (LONG) |
When otel.semconv-stability.opt-in=database,service.peer
Metrics
| Metric | Instrument | Type | Unit | Description |
|---|---|---|---|---|
db.client.operation.duration | histogram | HISTOGRAM | s | Duration of database client operations. |
| Metric | Attributes |
|---|---|
db.client.operation.duration | db.namespace (STRING), db.operation.name (STRING), db.system.name (STRING), network.peer.address (STRING), network.peer.port (LONG), server.address (STRING), server.port (LONG) |
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | db.namespace (STRING), db.operation.batch.size (LONG), db.operation.name (STRING), db.query.text (STRING), db.system.name (STRING), network.peer.address (STRING), network.peer.port (LONG), server.address (STRING), server.port (LONG), service.peer.name (STRING) |
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
java.common.database.statement_sanitizer.enabled | boolean | true | Deprecated: use java.common.db.query_sanitization.enabled instead. It is ignored under v3 preview. |
otel.instrumentation.common.db-statement-sanitizer.enabled | boolean | true | Deprecated: use otel.instrumentation.common.db.query-sanitization.enabled instead. It is ignored under v3 preview and will be removed in 3.0. |
otel.instrumentation.common.db.query-sanitization.enabled | boolean | true | Enables query sanitization for database queries. |
otel.instrumentation.common.peer-service-mapping | map | Used to specify a mapping from server addresses or configured targets to peer services. Configured targets containing commas or equals signs can only be mapped with declarative service_peer_mapping. | |
otel.instrumentation.jedis.query-sanitization.enabled | boolean | Enables query sanitization for Jedis queries. Overrides otel.instrumentation.common.db.query-sanitization.enabled for this instrumentation; when unset, that setting applies. | |
otel.instrumentation.jedis.statement-sanitizer.enabled | boolean | Deprecated: use otel.instrumentation.jedis.query-sanitization.enabled instead. It is ignored under v3 preview and will be removed in 3.0. When unset, this setting falls back to otel.instrumentation.common.db.query-sanitization.enabled (including its deprecated aliases). |