Skip to content

Commit 1c949f2

Browse files
committed
More review suggestions
1 parent 08af962 commit 1c949f2

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/otel/sdk-metrics.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ This metric is [recommended][MetricRecommended].
4040
| -------- | --------------- | ----------- | -------------- | --------- |
4141
| `otel.sdk.span.live.count` | UpDownCounter | `{span}` | The number of created spans for which the end operation has not been called yet [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
4242

43-
**[1]:** For spans with `recording=true` implementations MUST record both `metric.otel.sdk.span.live.count` and `otel.sdk.span.ended.count`.
44-
For spans with `recording=false` implementations SHOULD record this metric, they MUST either record both `metric.otel.sdk.span.live.count` and `otel.sdk.span.ended.count` or none.
43+
**[1]:** For spans with `recording=true`: Implementations MUST record both `otel.sdk.span.live.count` and `otel.sdk.span.ended.count`.
44+
For spans with `recording=false`: If implementations decide to record this metric, they MUST also record `otel.sdk.span.ended.count`.
4545

4646
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
4747
|---|---|---|---|---|---|
@@ -77,8 +77,8 @@ This metric is [recommended][MetricRecommended].
7777
| -------- | --------------- | ----------- | -------------- | --------- |
7878
| `otel.sdk.span.ended.count` | Counter | `{span}` | The number of created spans for which the end operation was called [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
7979

80-
**[1]:** For spans with `recording=true` implementations MUST record both `metric.otel.sdk.span.live.count` and `otel.sdk.span.ended.count`.
81-
For spans with `recording=false` implementations SHOULD record this metric, they MUST either record both `metric.otel.sdk.span.live.count` and `otel.sdk.span.ended.count` or none.
80+
**[1]:** For spans with `recording=true`: Implementations MUST record both `otel.sdk.span.live.count` and `otel.sdk.span.ended.count`.
81+
For spans with `recording=false`: If implementations decide to record this metric, they MUST also record `otel.sdk.span.live.count`.
8282

8383
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
8484
|---|---|---|---|---|---|
@@ -226,7 +226,7 @@ This metric is [recommended][MetricRecommended].
226226
| -------- | --------------- | ----------- | -------------- | --------- |
227227
| `otel.sdk.processor.span.processed.count` | Counter | `{span}` | The number of spans for which the processing has finished, either successful or failed [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
228228

229-
**[1]:** For successful processing, `error.type` must be empty. For failed processing, `error.type` must contain the failure cause.
229+
**[1]:** For successful processing, `error.type` MUST NOT be set. For failed processing, `error.type` must contain the failure cause.
230230
For the SDK Simple and Batching Span Processor a span is considered to be processed already when it has been submitted to the exporter, not when the corresponding export call has finished.
231231

232232
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
@@ -312,7 +312,7 @@ This metric is [recommended][MetricRecommended].
312312
| -------- | --------------- | ----------- | -------------- | --------- |
313313
| `otel.sdk.exporter.span.inflight.count` | UpDownCounter | `{span}` | The number of spans which were passed to the exporter, but that have not been exported yet (neither successful, nor failed) [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
314314

315-
**[1]:** For successful exports, `error.type` must be empty. For failed exports, `error.type` must contain the failure cause.
315+
**[1]:** For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
316316

317317
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
318318
|---|---|---|---|---|---|
@@ -374,7 +374,7 @@ This metric is [recommended][MetricRecommended].
374374
| -------- | --------------- | ----------- | -------------- | --------- |
375375
| `otel.sdk.exporter.span.exported.count` | Counter | `{span}` | The number of spans for which the export has finished, either successful or failed [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
376376

377-
**[1]:** For successful exports, `error.type` must be empty. For failed exports, `error.type` must contain the failure cause.
377+
**[1]:** For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
378378
For exporters with partial success semantics (e.g. OTLP with `rejected_spans`), rejected spans must count as failed and only non-rejected spans count as success.
379379
If no rejection reason is available, `rejected` SHOULD be used as value for `error.type`.
380380

model/otel/metrics.yaml

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ groups:
88
unit: "{span}"
99
note: |
1010
For spans with `recording=true`: Implementations MUST record both `otel.sdk.span.live.count` and `otel.sdk.span.ended.count`.
11-
For spans with `recording=false`: If implementations decide to record this metric, they MUST also record `otel.sdk.span.ended.count` or not declare none.
11+
For spans with `recording=false`: If implementations decide to record this metric, they MUST also record `otel.sdk.span.ended.count`.
1212
attributes:
1313
- ref: otel.span.sampling_result
1414

@@ -21,7 +21,7 @@ groups:
2121
unit: "{span}"
2222
note: |
2323
For spans with `recording=true`: Implementations MUST record both `otel.sdk.span.live.count` and `otel.sdk.span.ended.count`.
24-
For spans with `recording=false` implementations SHOULD record this metric, they MUST either record both `metric.otel.sdk.span.live.count` and `otel.sdk.span.ended.count` or none.
24+
For spans with `recording=false`: If implementations decide to record this metric, they MUST also record `otel.sdk.span.live.count`.
2525
attributes:
2626
- ref: otel.span.sampling_result
2727

@@ -57,7 +57,7 @@ groups:
5757
stability: development
5858
brief: "The number of spans for which the processing has finished, either successful or failed"
5959
note: |
60-
For successful processing, `error.type` SHOULD NOT be set. For failed processing, `error.type` must contain the failure cause.
60+
For successful processing, `error.type` MUST NOT be set. For failed processing, `error.type` must contain the failure cause.
6161
For the SDK Simple and Batching Span Processor a span is considered to be processed already when it has been submitted to the exporter, not when the corresponding export call has finished.
6262
instrument: counter
6363
unit: "{span}"
@@ -75,7 +75,7 @@ groups:
7575
stability: development
7676
brief: "The number of spans which were passed to the exporter, but that have not been exported yet (neither successful, nor failed)"
7777
note: |
78-
For successful exports, `error.type` must be empty. For failed exports, `error.type` must contain the failure cause.
78+
For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
7979
instrument: updowncounter
8080
unit: "{span}"
8181
attributes:
@@ -94,7 +94,7 @@ groups:
9494
stability: development
9595
brief: "The number of spans for which the export has finished, either successful or failed"
9696
note: |
97-
For successful exports, `error.type` must be empty. For failed exports, `error.type` must contain the failure cause.
97+
For successful exports, `error.type` MUST NOT be set. For failed exports, `error.type` must contain the failure cause.
9898
For exporters with partial success semantics (e.g. OTLP with `rejected_spans`), rejected spans must count as failed and only non-rejected spans count as success.
9999
If no rejection reason is available, `rejected` SHOULD be used as value for `error.type`.
100100
instrument: counter

0 commit comments

Comments
 (0)