Skip to content

Commit d1eb5e2

Browse files
bogdandrutuOberon00joaopgrassi
authored andcommitted
Define semantic conventions yaml for non-otlp conventions (open-telemetry#2850)
* Define semantic conventions yaml for non-otlp conventions Signed-off-by: Bogdan Drutu <[email protected]> * Update semantic_conventions/trace/exporter/exporter.yaml Co-authored-by: Christian Neumüller <[email protected]> * Update semantic_conventions/scope/exporter/exporter.yaml Co-authored-by: Joao Grassi <[email protected]> * Rename otel to otel_span Signed-off-by: Bogdan Drutu <[email protected]> Signed-off-by: Bogdan Drutu <[email protected]> Co-authored-by: Christian Neumüller <[email protected]> Co-authored-by: Joao Grassi <[email protected]>
1 parent 3fd804b commit d1eb5e2

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

specification/common/mapping-to-non-otlp.md

+25-12
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,22 @@ in this document.
2727
OpenTelemetry `InstrumentationScope`'s fields MUST be reported as key-value
2828
pairs associated with the Span, Metric Data Point or LogRecord using the following mapping:
2929

30-
| OpenTelemetry InstrumentationScope Field | non-OTLP Key | Notes |
31-
| ------------------- | --- | --- |
32-
| `InstrumentationScope.name`|`otel.scope.name`|since 1.10.0|
33-
| `InstrumentationScope.version`|`otel.scope.version`|since 1.10.0|
30+
<!-- semconv otel.scope -->
31+
| Attribute | Type | Description | Examples | Requirement Level |
32+
|---|---|---|---|---|
33+
| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | Recommended |
34+
| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | Recommended |
35+
<!-- endsemconv -->
3436

3537
The following deprecated aliases MUST also be reported with exact same values for
3638
backward compatibility reasons:
3739

38-
| non-OTLP Key | Alias for | Notes |
39-
| --- | --- | --- |
40-
|`otel.library.name`|`otel.scope.name`|deprecated since 1.10.0|
41-
|`otel.library.version`|`otel.scope.version`|deprecated since 1.10.0|
40+
<!-- semconv otel.library -->
41+
| Attribute | Type | Description | Examples | Requirement Level |
42+
|---|---|---|---|---|
43+
| `otel.library.name` | string | Deprecated, use the `otel.scope.name` attribute. | `io.opentelemetry.contrib.mongodb` | Recommended |
44+
| `otel.library.version` | string | Deprecated, use the `otel.scope.version` attribute. | `1.0.0` | Recommended |
45+
<!-- endsemconv -->
4246

4347
### Span Status
4448

@@ -48,10 +52,19 @@ unless the `Status` is `UNSET`. In the latter case it MUST NOT be reported.
4852
The following table defines the OpenTelemetry `Status`'s mapping to Span's
4953
key-value pairs:
5054

51-
|OpenTelemetry Status Field|non-OTLP Key|non-OTLP Value|
52-
|--|--|--|
53-
|Code | `otel.status_code` | Name of the code, either `OK` or `ERROR`. MUST NOT be set if the code is `UNSET`. |
54-
|Description | `otel.status_description` | Description of the `Status` if it has a value otherwise not set. |
55+
<!-- semconv otel_span -->
56+
| Attribute | Type | Description | Examples | Requirement Level |
57+
|---|---|---|---|---|
58+
| `otel.status_code` | string | Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. | `OK` | Recommended |
59+
| `otel.status_description` | string | Description of the Status if it has a value, otherwise not set. | `resource not found` | Recommended |
60+
61+
`otel.status_code` MUST be one of the following:
62+
63+
| Value | Description |
64+
|---|---|
65+
| `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. |
66+
| `ERROR` | The operation contains an error. |
67+
<!-- endsemconv -->
5568

5669
### Dropped Attributes Count
5770

0 commit comments

Comments
 (0)