Armeria
OpenTelemetry Java agent instrumentation
This instrumentation enables HTTP client spans and metrics for the Armeria HTTP client, and HTTP server spans and metrics for the Armeria HTTP server.
- Name:
armeria-1.3 - Scope:
io.opentelemetry.armeria-1.3 - Target versions:
com.linecorp.armeria:armeria:[1.3.0,) - Library: https://armeria.dev/
Telemetry
When default
Metrics
| Metric | Instrument | Type | Unit | Description |
|---|---|---|---|---|
http.client.request.duration | histogram | HISTOGRAM | s | Duration of HTTP client requests. |
http.server.request.duration | histogram | HISTOGRAM | s | Duration of HTTP server requests. |
| Metric | Attributes |
|---|---|
http.client.request.duration | http.request.method (STRING), http.response.status_code (LONG), network.protocol.version (STRING), server.address (STRING), server.port (LONG) |
http.server.request.duration | http.request.method (STRING), http.response.status_code (LONG), http.route (STRING), network.protocol.version (STRING), url.scheme (STRING) |
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | error.type (STRING), http.request.method (STRING), http.response.status_code (LONG), network.peer.address (STRING), network.peer.port (LONG), network.protocol.version (STRING), peer.service (STRING), server.address (STRING), server.port (LONG), url.full (STRING) |
| SERVER | client.address (STRING), error.type (STRING), http.request.method (STRING), http.response.status_code (LONG), http.route (STRING), network.peer.address (STRING), network.peer.port (LONG), network.protocol.version (STRING), server.address (STRING), server.port (LONG), url.path (STRING), url.query (STRING), url.scheme (STRING), user_agent.original (STRING) |
When otel.semconv-stability.opt-in=service.peer
Metrics
| Metric | Instrument | Type | Unit | Description |
|---|---|---|---|---|
http.client.request.duration | histogram | HISTOGRAM | s | Duration of HTTP client requests. |
http.server.request.duration | histogram | HISTOGRAM | s | Duration of HTTP server requests. |
| Metric | Attributes |
|---|---|
http.client.request.duration | http.request.method (STRING), http.response.status_code (LONG), network.protocol.version (STRING), server.address (STRING), server.port (LONG) |
http.server.request.duration | http.request.method (STRING), http.response.status_code (LONG), http.route (STRING), network.protocol.version (STRING), url.scheme (STRING) |
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | error.type (STRING), http.request.method (STRING), http.response.status_code (LONG), network.peer.address (STRING), network.peer.port (LONG), network.protocol.version (STRING), server.address (STRING), server.port (LONG), service.peer.name (STRING), url.full (STRING) |
| SERVER | client.address (STRING), error.type (STRING), http.request.method (STRING), http.response.status_code (LONG), http.route (STRING), network.peer.address (STRING), network.peer.port (LONG), network.protocol.version (STRING), server.address (STRING), server.port (LONG), url.path (STRING), url.query (STRING), url.scheme (STRING), user_agent.original (STRING) |
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
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.http.client.capture-request-headers | list | List of HTTP request headers to capture in HTTP client telemetry. | |
otel.instrumentation.http.client.capture-response-headers | list | List of HTTP response headers to capture in HTTP client telemetry. | |
otel.instrumentation.http.client.emit-experimental-telemetry | boolean | false | Enable the capture of experimental HTTP client telemetry. Adds the http.request.body.size and http.response.body.size attributes to spans, and records http.client.request.body.size and http.client.response.body.size metrics. |
otel.instrumentation.http.known-methods | list | CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE | Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as _OTHER. |
otel.instrumentation.http.server.capture-request-headers | list | List of HTTP request headers to capture in HTTP server telemetry. | |
otel.instrumentation.http.server.capture-response-headers | list | List of HTTP response headers to capture in HTTP server telemetry. | |
otel.instrumentation.http.server.emit-experimental-telemetry | boolean | false | Enable the capture of experimental HTTP server telemetry. Adds the http.request.body.size and http.response.body.size attributes to spans, and records http.server.request.body.size and http.server.response.body.size metrics. |
java.common.http.client.url_template_rules | list | Rules for deriving low-cardinality URL templates (routes) from HTTP client request URLs. Only applied when experimental HTTP client telemetry is enabled. | |
otel.instrumentation.sanitization.url.experimental.sensitive-query-parameters | list | AWSAccessKeyId,Signature,X-Amz-Signature,X-Amz-Credential,X-Amz-Security-Token,sig,X-Goog-Signature | List of URL query parameter names whose values are redacted in URL attributes. See https://opentelemetry.io/docs/specs/semconv/http/http-spans. |