Add http request duration to SDK metrics #2007
Open
+181
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JonasKunz
reviewed
Mar 19, 2025
jsuereth
reviewed
Mar 19, 2025
…ventions into requests-duration
lmolkova
reviewed
Mar 29, 2025
| @@ -452,5 +454,131 @@ E.g. for Java the fully qualified classname SHOULD be used in this case. | |||
| <!-- END AUTOGENERATED TEXT --> | |||
| <!-- endsemconv --> | |||
|
|
|||
| ## Request Metrics | |||
|
|
|||
| ### Metric: `otel.sdk.exporter.request.duration` | |||
There was a problem hiding this comment.
suggesting
Suggested change
| ### Metric: `otel.sdk.exporter.request.duration` | |
| ### Metric: `otel.sdk.exporter.operation.duration` |
to match other logical operations
| type: metric | ||
| metric_name: otel.sdk.exporter.request.duration | ||
| stability: development | ||
| brief: "The duration of any request(s) made from the exporter during export." |
There was a problem hiding this comment.
Suggested change
| brief: "The duration of any request(s) made from the exporter during export." | |
| brief: "The duration of exporting a back of telemetry items. It cover the duration including all retries" |
| note: | | ||
| This metric defines successful requests using the full success definitions for [http](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success-1) | ||
| and [grpc](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success). Anything else is defined as an unsuccessful request. For successful requests, | ||
| `error.type` MUST NOT be set. For unsuccessful requests, `error.type` must contain a relevant failure cause. |
There was a problem hiding this comment.
Suggested change
| `error.type` MUST NOT be set. For unsuccessful requests, `error.type` must contain a relevant failure cause. | |
| `error.type` MUST NOT be set. For unsuccessful export operations, `error.type` must contain a relevant failure cause. | |
| It should be reported for export calls limited to a single batch. If exporter updates batch between retries, this metric SHOULD NOT be reported. |
| brief: "The duration of any request(s) made from the exporter during export." | ||
| note: | | ||
| This metric defines successful requests using the full success definitions for [http](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success-1) | ||
| and [grpc](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success). Anything else is defined as an unsuccessful request. For successful requests, |
There was a problem hiding this comment.
Suggested change
| and [grpc](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success). Anything else is defined as an unsuccessful request. For successful requests, | |
| and [grpc](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success). Anything else is defined as an unsuccessful operations. For successful operations, |
| stability: development | ||
| brief: "The duration of any request(s) made from the exporter during export." | ||
| note: | | ||
| This metric defines successful requests using the full success definitions for [http](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success-1) |
There was a problem hiding this comment.
Suggested change
| This metric defines successful requests using the full success definitions for [http](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success-1) | |
| This metric defines successful operations using the full success definitions for [http](https://github.com/open-telemetry/opentelemetry-proto/blob/v1.5.0/docs/specification.md#full-success-1) |
| recommended: when applicable | ||
| - ref: error.type | ||
| requirement_level: | ||
| conditionally_required: If request has ended with an error |
There was a problem hiding this comment.
Suggested change
| conditionally_required: If request has ended with an error | |
| conditionally_required: If the operation has ended with an error |
| requirement_level: | ||
| conditionally_required: If request has ended with an error | ||
| examples: ["rejected", "timeout", "500", "java.net.UnknownHostException"] | ||
| - ref: http.response.status_code |
There was a problem hiding this comment.
Suggested change
| - ref: http.response.status_code | |
| - ref: http.response.status_code | |
| brief: The HTTP status code of the last HTTP request performed in scope of this export call. |
| - ref: http.response.status_code | ||
| requirement_level: | ||
| recommended: when applicable | ||
| - ref: rpc.grpc.status_code |
There was a problem hiding this comment.
Suggested change
| - ref: rpc.grpc.status_code | |
| - ref: rpc.grpc.status_code | |
| brief: The gRPC status code of the last gRPC requests performed in scope of this export call. |
| component: 'otel' | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Adds SDK self-monitoring metrics for exporter request duration |
There was a problem hiding this comment.
Suggested change
| note: Adds SDK self-monitoring metrics for exporter request duration | |
| note: Adds SDK self-monitoring metrics for exporter call duration |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #1631 and partially addresses #1906
Changes
Adds a metric to track the duration of http requests made within an exporter.
Following the discussion in this issue, I wasn't exactly sure how we want to provide more detail regarding partial success. The
error.typecan indicate that it was a partial success but we can possibly also include information about which items succeeded/failed somewhere (perhaps in another attribute).I also made the distinction of making this metric specific to
httpbut am open to defining a generic one regardless of transport protocol (we can probably have protocol + response code as additional attributes if so).Looking forward to hearing your thoughts!
Merge requirement checklist
[chore]