Skip to content

Commit 684fd82

Browse files
lzchenlzchen
committed
remove http
1 parent 08a55d2 commit 684fd82

File tree

2 files changed

+45
-14
lines changed

2 files changed

+45
-14
lines changed

‎docs/otel/sdk-metrics.md

+35-8
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This document describes metrics emitted by the OpenTelemetry SDK components them
2121
- [Metric: `otel.sdk.exporter.span.inflight.count`](#metric-otelsdkexporterspaninflightcount)
2222
- [Metric: `otel.sdk.exporter.span.exported.count`](#metric-otelsdkexporterspanexportedcount)
2323
- [Request Metrics](#request-metrics)
24-
- [Metric: `otel.sdk.exporter.http.request.duration`](#metric-otelsdkexporterhttprequestduration)
24+
- [Metric: `otel.sdk.exporter.request.duration`](#metric-otelsdkexporterrequestduration)
2525

2626
<!-- tocstop -->
2727

@@ -456,15 +456,15 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
456456

457457
## Request Metrics
458458

459-
### Metric: `otel.sdk.exporter.http.request.duration`
459+
### Metric: `otel.sdk.exporter.request.duration`
460460

461-
This metric is [recommended][MetricRecommended].
461+
This metric is [opt-in][MetricOptIn].
462462

463463
This metric SHOULD be specified with
464464
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.42.0/specification/metrics/api.md#instrument-advisory-parameters)
465465
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
466466

467-
<!-- semconv metric.otel.sdk.exporter.http.request.duration -->
467+
<!-- semconv metric.otel.sdk.exporter.request.duration -->
468468
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
469469
<!-- see templates/registry/markdown/snippet.md.j2 -->
470470
<!-- prettier-ignore-start -->
@@ -473,17 +473,19 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
473473

474474
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
475475
| -------- | --------------- | ----------- | -------------- | --------- |
476-
| `otel.sdk.exporter.http.request.duration` | Histogram | `s` | The duration of any http request(s) made from the exporter during export. [1] | ![Development](https://img.shields.io/badge/-development-blue) |
476+
| `otel.sdk.exporter.request.duration` | Histogram | `s` | The duration of any request(s) made from the exporter during export. [1] | ![Development](https://img.shields.io/badge/-development-blue) |
477477

478-
**[1]:** 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).
479-
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.
478+
**[1]:** 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)
479+
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,
480+
`error.type` MUST NOT be set. For unsuccessful requests, `error.type` must contain a relevant failure cause.
480481

481482
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
482483
|---|---|---|---|---|---|
483484
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `rejected`; `timeout`; `500`; `java.net.UnknownHostException` | `Conditionally Required` If request has ended with an error | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
484-
| [`http.response.status_code`](/docs/attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | `Conditionally Required` If and only if one was received/sent. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
485+
| [`http.response.status_code`](/docs/attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | `Recommended` when applicable | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
485486
| [`otel.component.name`](/docs/attributes-registry/otel.md) | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [2] | `otlp_grpc_span_exporter/0`; `custom-name` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
486487
| [`otel.component.type`](/docs/attributes-registry/otel.md) | string | A name identifying the type of the OpenTelemetry component. [3] | `batching_span_processor`; `com.example.MySpanExporter` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) |
488+
| [`rpc.grpc.status_code`](/docs/attributes-registry/rpc.md) | int | The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request. | `0`; `1`; `2` | `Recommended` when applicable | ![Development](https://img.shields.io/badge/-development-blue) |
487489
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [4] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` when applicable | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
488490
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [5] | `80`; `8080`; `443` | `Recommended` when applicable | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
489491

@@ -548,10 +550,35 @@ E.g. for Java the fully qualified classname SHOULD be used in this case.
548550
| `otlp_http_span_exporter` | OTLP span exporter over HTTP with protobuf serialization | ![Development](https://img.shields.io/badge/-development-blue) |
549551
| `simple_span_processor` | The builtin SDK Simple Span Processor | ![Development](https://img.shields.io/badge/-development-blue) |
550552

553+
---
554+
555+
`rpc.grpc.status_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
556+
557+
| Value | Description | Stability |
558+
|---|---|---|
559+
| `0` | OK | ![Development](https://img.shields.io/badge/-development-blue) |
560+
| `1` | CANCELLED | ![Development](https://img.shields.io/badge/-development-blue) |
561+
| `2` | UNKNOWN | ![Development](https://img.shields.io/badge/-development-blue) |
562+
| `3` | INVALID_ARGUMENT | ![Development](https://img.shields.io/badge/-development-blue) |
563+
| `4` | DEADLINE_EXCEEDED | ![Development](https://img.shields.io/badge/-development-blue) |
564+
| `5` | NOT_FOUND | ![Development](https://img.shields.io/badge/-development-blue) |
565+
| `6` | ALREADY_EXISTS | ![Development](https://img.shields.io/badge/-development-blue) |
566+
| `7` | PERMISSION_DENIED | ![Development](https://img.shields.io/badge/-development-blue) |
567+
| `8` | RESOURCE_EXHAUSTED | ![Development](https://img.shields.io/badge/-development-blue) |
568+
| `9` | FAILED_PRECONDITION | ![Development](https://img.shields.io/badge/-development-blue) |
569+
| `10` | ABORTED | ![Development](https://img.shields.io/badge/-development-blue) |
570+
| `11` | OUT_OF_RANGE | ![Development](https://img.shields.io/badge/-development-blue) |
571+
| `12` | UNIMPLEMENTED | ![Development](https://img.shields.io/badge/-development-blue) |
572+
| `13` | INTERNAL | ![Development](https://img.shields.io/badge/-development-blue) |
573+
| `14` | UNAVAILABLE | ![Development](https://img.shields.io/badge/-development-blue) |
574+
| `15` | DATA_LOSS | ![Development](https://img.shields.io/badge/-development-blue) |
575+
| `16` | UNAUTHENTICATED | ![Development](https://img.shields.io/badge/-development-blue) |
576+
551577
<!-- markdownlint-restore -->
552578
<!-- prettier-ignore-end -->
553579
<!-- END AUTOGENERATED TEXT -->
554580
<!-- endsemconv -->
555581

556582
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
583+
[MetricOptIn]: /docs/general/metric-requirement-level.md#opt-in
557584
[MetricRecommended]: /docs/general/metric-requirement-level.md#recommended

‎model/otel/metrics.yaml

+10-6
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,15 @@ groups:
111111
- ref: error.type
112112
examples: ["rejected", "timeout", "500", "java.net.UnknownHostException"]
113113

114-
- id: metric.otel.sdk.exporter.http.request.duration
114+
- id: metric.otel.sdk.exporter.request.duration
115115
type: metric
116-
metric_name: otel.sdk.exporter.http.request.duration
116+
metric_name: otel.sdk.exporter.request.duration
117117
stability: development
118-
brief: "The duration of any http request(s) made from the exporter during export."
118+
brief: "The duration of any request(s) made from the exporter during export."
119119
note: |
120-
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).
121-
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.
120+
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)
121+
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,
122+
`error.type` MUST NOT be set. For unsuccessful requests, `error.type` must contain a relevant failure cause.
122123
instrument: histogram
123124
unit: "s"
124125
attributes:
@@ -136,4 +137,7 @@ groups:
136137
examples: ["rejected", "timeout", "500", "java.net.UnknownHostException"]
137138
- ref: http.response.status_code
138139
requirement_level:
139-
conditionally_required: If and only if one was received/sent.
140+
recommended: when applicable
141+
- ref: rpc.grpc.status_code
142+
requirement_level:
143+
recommended: when applicable

0 commit comments

Comments
 (0)