This documentation has an index for AI agents at /llms.txt. A Markdown version of this page is available at https://explorer.opentelemetry.io/java-agent/instrumentation/servlet-5.0.md.

Servlet

OpenTelemetry Java agent instrumentation

This instrumentation enables HTTP server spans and metrics for Jakarta Servlet API.

  • Name: servlet-5.0
  • Scope: io.opentelemetry.servlet-5.0
  • Target versions: jakarta.servlet:jakarta.servlet-api:[5.0.0,)
  • Library: https://jakarta.ee/specifications/servlet/

Telemetry

  • Metrics: http.server.request.duration
  • Span attributes: client.address, error.type, http.request.method, http.request.method_original, http.response.status_code, http.route, network.peer.address, network.peer.port, network.protocol.version, server.address, server.port, url.path, url.query, url.scheme, user_agent.original, code.function, code.namespace

Configuration

OptionTypeDefaultDescription
otel.experimental.javascript-snippetstringExperimental setting to inject a JavaScript snippet into HTML responses after the opening <head> tag.
otel.instrumentation.servlet.experimental-span-attributesbooleanfalseEnables capturing the experimental servlet.timeout span attribute.
otel.instrumentation.servlet.experimental.capture-request-parameterslistList of request parameter names to capture as span attributes.
otel.instrumentation.servlet.experimental.trace-id-request-attribute.enabledbooleantrueEnables adding the trace ID and span ID as request attributes for downstream servlet access.

Data

  • JSON: /data/javaagent/instrumentations/servlet-5.0/servlet-5.0-7e202dc64e56.json
  • Explore: /java-agent/instrumentation/servlet-5.0