2.9 KiB
Semantic conventions
This document describes which OpenTelemetry Semantic Conventions are implemented by Java autoinstrumentation and which ones are not.
Http Server
| Attribute | Required | Implemented? |
|---|---|---|
http.method |
Y | + |
http.url |
N | + |
http.target |
N | - [1] |
http.host |
N | - [1] |
http.scheme |
N | - [1] |
http.status_code |
Y | + |
http.status_text |
N | - [2] |
http.flavor |
N | + [3] |
http.user_agent |
N | + |
http.request_content_length |
N | - |
http.request_content_length_uncompressed |
N | - |
http.response_content_length |
N | - |
http.response_content_length_uncompressed |
N | - |
http.server_name |
N | - |
http.route |
N | - |
http.client_ip |
N | + |
[1]: As the majority of Java frameworks don't provide a standard way to obtain "The full request
target as passed in a HTTP request line or equivalent.", we don't set http.target semantic
attribute. As either it or http.url is required, we set the latter. This, in turn, makes setting
http.schema and http.host unnecessary duplication. Therefore, we do not set them as well.
[2]: TODO After this PR is merged, remove this line. If it rejected, then implement this attribute.
[3]: In case of Armeria, return values are SessionProtocol, not values defined by spec.
Http Client
| Attribute | Required | Implemented? |
|---|---|---|
http.method |
Y | + |
http.url |
N | + |
http.target |
N | - [1] |
http.host |
N | - [1] |
http.scheme |
N | - [1] |
http.status_code |
Y | + |
http.status_text |
N | - [2] |
http.flavor |
N | + [3] |
http.user_agent |
N | + |
http.request_content_length |
N | - |
http.request_content_length_uncompressed |
N | - |
http.response_content_length |
N | - |
http.response_content_length_uncompressed |
N | - |
[1]: As the majority of Java frameworks don't provide a standard way to obtain "The full request
target as passed in a HTTP request line or equivalent.", we don't set http.target semantic
attribute. As either it or http.url is required, we set the latter. This, in turn, makes setting
http.schema and http.host unnecessary duplication. Therefore, we do not set them as well.
[2]: TODO After this PR is merged, remove this line. If it rejected, then implement this attribute.
[3]: In case of Armeria, return values are SessionProtocol, not values defined by spec.