You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| <aid="otel-span-sampling-result"href="#otel-span-sampling-result">`otel.span.sampling_result`</a> | string | The result value of the sampler for this span |`DROP`; `RECORD_ONLY`; `RECORD_AND_SAMPLE`||
16
18
| <aid="otel-status-code"href="#otel-status-code">`otel.status_code`</a> | string | Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. |`OK`; `ERROR`||
17
19
| <aid="otel-status-description"href="#otel-status-description">`otel.status_description`</a> | string | Description of the Status if it has a value, otherwise not set. |`resource not found`||
18
20
19
21
---
20
22
23
+
`otel.span.sampling_result` 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.
24
+
25
+
| Value | Description | Stability |
26
+
|---|---|---|
27
+
|`DROP`| The span is not sampled and not recording ||
28
+
|`RECORD_AND_SAMPLE`| The span is sampled and recording ||
29
+
|`RECORD_ONLY`| The span is not sampled, but recording ||
30
+
31
+
---
32
+
21
33
`otel.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.
22
34
23
35
| Value | Description | Stability |
24
36
|---|---|---|
25
37
|`ERROR`| The operation contains an error. ||
26
38
|`OK`| The operation has been validated by an Application developer or Operator to have completed successfully. ||
27
39
40
+
## OTel Component Attributes
41
+
42
+
Attributes used for OpenTelemetry component self-monitoring
| <aid="otel-component-name"href="#otel-component-name">`otel.component.name`</a> | string | A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance. [1]|`otlp_grpc_span_exporter/0`; `custom-name`||
47
+
| <aid="otel-component-type"href="#otel-component-type">`otel.component.type`</a> | string | A name identifying the type of the OpenTelemetry component. [2]|`batching_span_processor`; `com.example.MySpanExporter`||
48
+
49
+
**[1]`otel.component.name`:** Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts.
50
+
E.g. implementations MUST NOT use UUIDs as values for this attribute.
51
+
52
+
Implementations MAY achieve these goals by following a `<otel.component.type>/<instance-counter>` pattern, e.g. `batching_span_processor/0`.
53
+
Hereby `otel.component.type` refers to the corresponding attribute value of the component.
54
+
55
+
The value of `instance-counter` MAY be automatically assigned by the component and uniqueness within the enclosing SDK instance MUST be guaranteed.
56
+
For example, `<instance-counter>` MAY be implemented by using a monotonically increasing counter (starting with `0`), which is incremented every time an
57
+
instance of the given component type is started.
58
+
59
+
With this implementation, for example the first Batching Span Processor would have `batching_span_processor/0`
60
+
as `otel.component.name`, the second one `batching_span_processor/1` and so on.
61
+
These values will therefore be reused in the case of an application restart.
62
+
63
+
**[2]`otel.component.type`:** If none of the standardized values apply, implementations SHOULD use the language-defined name of the type.
64
+
E.g. for Java the fully qualified classname SHOULD be used in this case.
65
+
66
+
---
67
+
68
+
`otel.component.type` 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.
69
+
70
+
| Value | Description | Stability |
71
+
|---|---|---|
72
+
|`batching_span_processor`| The builtin SDK Batching Span Processor ||
73
+
|`otlp_grpc_span_exporter`| OTLP span exporter over gRPC with protobuf serialization ||
74
+
|`otlp_http_json_span_exporter`| OTLP span exporter over HTTP with JSON serialization ||
75
+
|`otlp_http_span_exporter`| OTLP span exporter over HTTP with protobuf serialization ||
76
+
|`simple_span_processor`| The builtin SDK Simple Span Processor ||
77
+
28
78
## OTel Scope Attributes
29
79
30
80
Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts.
Copy file name to clipboardexpand all lines: docs/general/metrics.md
+1
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ The following semantic conventions surrounding metrics are defined:
34
34
*[K8s](/docs/system/k8s-metrics.md): For K8s metrics.
35
35
*[Process](/docs/system/process-metrics.md): For standard process metrics.
36
36
*[Runtime Environment](/docs/runtime/README.md#metrics): For runtime environment metrics.
37
+
*[OTel SDK Telemetry](/docs/otel/sdk-metrics.md): Metrics emitted by the OpenTelemetry SDK components.
37
38
38
39
Apart from semantic conventions for metrics, [traces](trace.md), [logs](logs.md), and [events](events.md), OpenTelemetry also
39
40
defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.41.0/specification/resource/sdk.md) with
0 commit comments