diff --git a/semantic_conventions/scope/exporter/exporter.yaml b/semantic_conventions/scope/exporter/exporter.yaml index 9fc88b2eda6..3bbf3fe0735 100644 --- a/semantic_conventions/scope/exporter/exporter.yaml +++ b/semantic_conventions/scope/exporter/exporter.yaml @@ -2,29 +2,29 @@ groups: - id: otel.scope prefix: otel.scope type: resource - brief: Attributes used by non OTLP exporters to represent OpenTelemetry Scope's concepts. + brief: Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. attributes: - id: name type: string - brief: The name of the instrumentation scope - `InstrumentationScope.Name`. + brief: The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). examples: ['io.opentelemetry.contrib.mongodb'] - id: version type: string - brief: The version of the instrumentation scope - `InstrumentationScope.Version`. + brief: The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). examples: ['1.0.0'] - id: otel.library prefix: otel.library type: resource brief: > - Span attributes used by non OTLP exporters to represent OpenTelemetry Scope's concepts. + Span attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. attributes: - id: name type: string stability: "deprecated" - brief: Use `otel.scope.name` attribute. + brief: Deprecated, use the `otel.scope.name` attribute. examples: ['io.opentelemetry.contrib.mongodb'] - id: version type: string stability: "deprecated" - brief: Use `otel.scope.version` attribute. + brief: Deprecated, use the `otel.scope.version` attribute. examples: ['1.0.0'] diff --git a/semantic_conventions/trace/exporter/exporter.yaml b/semantic_conventions/trace/exporter/exporter.yaml index 6f57c4a278f..816e17d3f0e 100644 --- a/semantic_conventions/trace/exporter/exporter.yaml +++ b/semantic_conventions/trace/exporter/exporter.yaml @@ -1,21 +1,21 @@ groups: - - id: otel + - id: otel_span prefix: otel type: span - brief: Span attributes used by non OTLP exporters to represent OpenTelemetry Span's concepts. + brief: Span attributes used by non-OTLP exporters to represent OpenTelemetry Span's concepts. attributes: - id: status_code type: allow_custom_values: false members: - id: ok - value: ok + value: OK brief: 'The operation has been validated by an Application developer or Operator to have completed successfully.' - id: error - value: error + value: ERROR brief: 'The operation contains an error.' - brief: Name of the code, either OK or ERROR. MUST NOT be set if the status code is UNSET. - - id: status_message + brief: Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. + - id: status_description type: string brief: Description of the Status if it has a value otherwise not set. examples: ['resource not found'] diff --git a/specification/common/mapping-to-non-otlp.md b/specification/common/mapping-to-non-otlp.md index 06f81851d45..b67b392193d 100644 --- a/specification/common/mapping-to-non-otlp.md +++ b/specification/common/mapping-to-non-otlp.md @@ -30,8 +30,8 @@ pairs associated with the Span, Metric Data Point or LogRecord using the followi | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `otel.scope.name` | string | The name of the instrumentation scope - `InstrumentationScope.Name`. | `io.opentelemetry.contrib.mongodb` | Recommended | -| `otel.scope.version` | string | The version of the instrumentation scope - `InstrumentationScope.Version`. | `1.0.0` | Recommended | +| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | Recommended | +| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | Recommended | The following deprecated aliases MUST also be reported with exact same values for @@ -40,8 +40,8 @@ backward compatibility reasons: | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `otel.library.name` | string | Use `otel.scope.name` attribute. | `io.opentelemetry.contrib.mongodb` | Recommended | -| `otel.library.version` | string | Use `otel.scope.version` attribute. | `1.0.0` | Recommended | +| `otel.library.name` | string | Deprecated, use the `otel.scope.name` attribute. | `io.opentelemetry.contrib.mongodb` | Recommended | +| `otel.library.version` | string | Deprecated, use the `otel.scope.version` attribute. | `1.0.0` | Recommended | ### Span Status @@ -52,18 +52,18 @@ unless the `Status` is `UNSET`. In the latter case it MUST NOT be reported. The following table defines the OpenTelemetry `Status`'s mapping to Span's key-value pairs: - + | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `otel.status_code` | string | Name of the code, either OK or ERROR. MUST NOT be set if the status code is UNSET. | `ok` | Recommended | -| `otel.status_message` | string | Description of the Status if it has a value otherwise not set. | `resource not found` | Recommended | +| `otel.status_code` | string | Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. | `OK` | Recommended | +| `otel.status_description` | string | Description of the Status if it has a value otherwise not set. | `resource not found` | Recommended | -`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. +`otel.status_code` MUST be one of the following: | Value | Description | |---|---| -| `ok` | The operation has been validated by an Application developer or Operator to have completed successfully. | -| `error` | The operation contains an error. | +| `OK` | The operation has been validated by an Application developer or Operator to have completed successfully. | +| `ERROR` | The operation contains an error. | ### Dropped Attributes Count