HTTP and the web
as of v1.44.0Client and server HTTP calls, the URL they address, and the browser that made them.
http 26url 13browser 11user_agent 6graphql 3webengine 3
- attributes
- 62
- metrics
- 10
- signals
- 9
- stable
- 13
- deprecated
- 14
Signals
What this domain emits, and the attributes each one carries, most strongly required first. An attribute marked * is required on that signal; * is conditionally required.
Spans 3
- graphql.serverserverDevelopmentThis span represents an incoming operation on a GraphQL server implementation.
graphql.operation.namegraphql.operation.typegraphql.document
- http.clientclientStableThis span represents an outbound HTTP request.
http.request.method*server.address*server.port*url.full*error.type*http.request.method_original*http.response.status_code*network.protocol.name*http.request.resend_countnetwork.peer.addressnetwork.peer.portnetwork.protocol.version+11 more
- http.serverserverStableThis span represents an inbound HTTP request.
http.request.method*url.path*url.scheme*error.type*http.request.method_original*http.response.status_code*http.route*network.protocol.name*server.port*url.query*client.addressnetwork.peer.address+15 more
Events 3
- browser.web_vitalDevelopmentThis event describes the website performance metrics introduced by Google, See web vitals.
browser.web_vital.delta*browser.web_vital.id*browser.web_vital.name*browser.web_vital.value*browser.web_vital.navigation_typebrowser.web_vital.rating
- http.client.request.exceptionDevelopmentThis event represents an exception that occurred during an HTTP client request, such as network failures, timeouts, or o
- http.server.request.exceptionDevelopmentThis event represents an exception that occurred during HTTP server request processing, such as application errors, inte
Entities 3
- browserDevelopmentThe web browser in which the application represented by the resource is running. The browser.* attributes MUST be used o
browser.brandsbrowser.languagebrowser.mobilebrowser.platformuser_agent.original
- browser.documentDevelopmentThe web page document loaded in the browser.
- webengineDevelopmentResource describing the packaged software running the application code. Web engines are typically executed using process
Metrics 10
- http.client.active_requestsDevelopmentupdowncounter · {request}Number of active HTTP requests.
- http.client.connection.durationDevelopmenthistogram · sThe duration of the successfully established outbound HTTP connections.
- http.client.open_connectionsDevelopmentupdowncounter · {connection}Number of outbound HTTP connections that are currently active or idle on the client.
- http.client.request.body.sizeDevelopmenthistogram · BySize of HTTP client request bodies.
- http.client.request.durationStablehistogram · sDuration of HTTP client requests.
- http.client.response.body.sizeDevelopmenthistogram · BySize of HTTP client response bodies.
- http.server.active_requestsDevelopmentupdowncounter · {request}Number of active HTTP server requests.
- http.server.request.body.sizeDevelopmenthistogram · BySize of HTTP server request bodies.
- http.server.request.durationStablehistogram · sDuration of HTTP server requests.
- http.server.response.body.sizeDevelopmenthistogram · BySize of HTTP server response bodies.
Specification
- Spansare bound by the trace specification — 289 requirements across 7 documents, 166 of them MUST or SHALL.
- Metricsare bound by the metrics specification — 548 requirements across 8 documents, 279 of them MUST or SHALL.
- Eventsare bound by the logs specification — 162 requirements across 5 documents, 83 of them MUST or SHALL.
- Entitiesare bound by the entities specification — 53 requirements across 3 documents, 23 of them MUST or SHALL.
Requirements that name this domain 9
If the getter is intended to work with an HTTP request object, the getter MUST be case insensitive.
If the getter is intended to work with an HTTP request object, the getter MUST be case insensitive.
In order to increase compatibility, the key-value pairs MUST only consist of US-ASCII characters that make up valid HTTP header fields as per RFC 9110.
A W3C Trace Context propagator MUST parse and validate the
traceparentandtracestateHTTP headers as specified in W3C Trace Context Level 2.The fetcher MUST follow the HTTP standard and honour the redirect response and fetch the file from the redirected URL.
MUST NOT be set if the status code is UNSET. |
OK| Recommended | |otel.statusdescription| string | Description of the Status if it has a value, otherwise not set. |resource not found| Recommended |The status code SHOULD remain unset, except for the following circumstances:
Generally, Instrumentation Libraries SHOULD NOT set the status code to
Ok, unless explicitly configured to do so.
On the wire, this lands in trace/v1/trace, metrics/v1/metrics, logs/v1/logs, resource/v1/resource. Field-by-field definitions are under OTLP.
Attributes 62
http26 attributes
- http.client_ip
- http.connection.stateDevelopmentState of the HTTP connection in the HTTP connection pool.
- http.flavorDeprecatedDeprecated, use network.protocol.name and network.protocol.version instead.
- http.hostDeprecatedDeprecated, use one of server.address, client.address or http.request.header.host instead, depending on the usage.
- http.method
- http.request_content_lengthDeprecatedDeprecated, use http.request.header.content-length instead.
- http.request_content_length_uncompressed
- http.request.body.sizeDevelopmentThe size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Le
- http.request.headerStableHTTP request headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values.
- http.request.methodStableHTTP request method.
- http.request.method_originalStableOriginal HTTP method sent by the client in the request line.
- http.request.resend_countStableThe ordinal number of request resending attempt (for any reason, including redirects).
- http.request.sizeDevelopmentThe total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and
- http.response_content_lengthDeprecatedDeprecated, use http.response.header.content-length instead.
- http.response_content_length_uncompressed
- http.response.body.sizeDevelopmentThe size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-L
- http.response.headerStableHTTP response headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values.
- http.response.sizeDevelopmentThe total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and
- http.response.status_codeStableHTTP response status code.
- http.routeStableThe matched route template for the request. This MUST be low-cardinality and include all static path segments, with dynamic path segments represented with place
- http.scheme
- http.server_name
- http.status_code
- http.targetDeprecatedDeprecated, use url.path and url.query instead.
- http.url
- http.user_agent
url13 attributes
- url.domainDevelopmentDomain extracted from the url.full, such as "opentelemetry.io".
- url.extensionDevelopmentThe file extension extracted from the url.full, excluding the leading dot.
- url.fragmentStableThe URI fragment component
- url.fullStableAbsolute URL describing a network resource according to RFC3986
- url.originalDevelopmentUnmodified original URL as seen in the event source.
- url.pathStableThe URI path component
- url.portDevelopmentPort extracted from the url.full
- url.queryStableThe URI query component
- url.registered_domainDevelopmentThe highest registered URL domain, stripped of the subdomain.
- url.schemeStableThe URI scheme component identifying the used protocol.
- url.subdomainDevelopmentThe subdomain portion of a fully qualified domain name includes all of the names except the hostname under the registered_domain. In a partially qualified domai
- url.templateDevelopmentThe low-cardinality template of an absolute path reference.
- url.top_level_domainDevelopmentThe effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com i
browser11 attributes
- browser.brandsDevelopmentArray of brand name and version separated by a space
- browser.document.url.fullDevelopmentAbsolute URL of the current browser document according to RFC3986.
- browser.languageDevelopmentPreferred language of the user using the browser
- browser.mobileDevelopmentA boolean that is true if the browser is running on a mobile device
- browser.platformDevelopmentThe platform on which the browser is running
- browser.web_vital.deltaDevelopmentThe delta between the current value and the last-reported value. See delta.
- browser.web_vital.idDevelopmentA unique ID representing this particular metric instance.
- browser.web_vital.nameDevelopmentName of the web vital.
- browser.web_vital.navigation_typeDevelopmentThe type of navigation, as reported by the Navigation Timing API, with additional values reported by the web-vitals library.
- browser.web_vital.ratingDevelopmentThe rating of the web vital value against the "good", "needs improvement", and "poor" thresholds defined for the metric.
- browser.web_vital.valueDevelopmentValue of the web vital.
user_agent6 attributes
- user_agent.nameDevelopmentName of the user-agent extracted from original. Usually refers to the browser's name.
- user_agent.originalStableValue of the HTTP User-Agent header sent by the client.
- user_agent.os.nameDevelopmentHuman readable operating system name.
- user_agent.os.versionDevelopmentThe version string of the operating system as defined in Version Attributes.
- user_agent.synthetic.typeDevelopmentSpecifies the category of synthetic traffic, such as tests or bots.
- user_agent.versionDevelopmentVersion of the user-agent extracted from original. Usually refers to the browser's version
graphql3 attributes
- graphql.documentDevelopmentThe GraphQL document being executed.
- graphql.operation.nameDevelopmentThe name of the operation being executed.
- graphql.operation.typeDevelopmentThe type of the operation being executed.
webengine3 attributes
- webengine.descriptionDevelopmentAdditional description of the web engine (e.g. detailed version and edition information).
- webengine.nameDevelopmentThe name of the web engine.
- webengine.versionDevelopmentThe version of the web engine.
Topics are this site's grouping of upstream namespaces, not a structure the OpenTelemetry project publishes. JSON · All domains