Module: OpenTelemetry::SemConv::Incubating::OTEL

Defined in:

lib/opentelemetry/semconv/incubating/otel/metrics.rb,
lib/opentelemetry/semconv/incubating/otel/attributes.rb

Metrics Names

OTEL_SDK_EXPORTER_LOG_EXPORTED =

Note:

Stability Level: development

The number of log records for which the export has finished, either successful or failed

For successful exports, error.type MUST NOT be set. For failed exports, error.type MUST contain the failure cause. For exporters with partial success semantics (e.g. OTLP with rejected_log_records), rejected log records MUST count as failed and only non-rejected log records count as success. If no rejection reason is available, rejected SHOULD be used as value for error.type.

'otel.sdk.exporter.log.exported'

OTEL_SDK_EXPORTER_LOG_INFLIGHT =

Note:

Stability Level: development

The number of log records which were passed to the exporter, but that have not been exported yet (neither successful, nor failed)

For successful exports, error.type MUST NOT be set. For failed exports, error.type MUST contain the failure cause.

'otel.sdk.exporter.log.inflight'

OTEL_SDK_EXPORTER_METRIC_DATA_POINT_EXPORTED =

Note:

Stability Level: development

The number of metric data points for which the export has finished, either successful or failed

For successful exports, error.type MUST NOT be set. For failed exports, error.type MUST contain the failure cause. For exporters with partial success semantics (e.g. OTLP with rejected_data_points), rejected data points MUST count as failed and only non-rejected data points count as success. If no rejection reason is available, rejected SHOULD be used as value for error.type.

'otel.sdk.exporter.metric_data_point.exported'

OTEL_SDK_EXPORTER_METRIC_DATA_POINT_INFLIGHT =

Note:

Stability Level: development

The number of metric data points which were passed to the exporter, but that have not been exported yet (neither successful, nor failed)

For successful exports, error.type MUST NOT be set. For failed exports, error.type MUST contain the failure cause.

'otel.sdk.exporter.metric_data_point.inflight'

OTEL_SDK_EXPORTER_OPERATION_DURATION =

Note:

Stability Level: development

The duration of exporting a batch of telemetry records.

This metric defines successful operations using the full success definitions for http and grpc. Anything else is defined as an unsuccessful operation. For successful operations, error.type MUST NOT be set. For unsuccessful export operations, error.type MUST contain a relevant failure cause.

'otel.sdk.exporter.operation.duration'

OTEL_SDK_EXPORTER_SPAN_EXPORTED =

Note:

Stability Level: development

The number of spans for which the export has finished, either successful or failed

For successful exports, error.type MUST NOT be set. For failed exports, error.type MUST contain the failure cause. 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. If no rejection reason is available, rejected SHOULD be used as value for error.type.

'otel.sdk.exporter.span.exported'

OTEL_SDK_EXPORTER_SPAN_EXPORTED_COUNT =

Deprecated.

“Replaced by otel.sdk.exporter.span.exported.”, “reason”: “renamed”, “renamed_to”: “otel.sdk.exporter.span.exported”

Note:

Stability Level: development

Deprecated, use otel.sdk.exporter.span.exported instead.

'otel.sdk.exporter.span.exported.count'

OTEL_SDK_EXPORTER_SPAN_INFLIGHT =

Note:

Stability Level: development

The number of spans which were passed to the exporter, but that have not been exported yet (neither successful, nor failed)

For successful exports, error.type MUST NOT be set. For failed exports, error.type MUST contain the failure cause.

'otel.sdk.exporter.span.inflight'

OTEL_SDK_EXPORTER_SPAN_INFLIGHT_COUNT =

Deprecated.

“Replaced by otel.sdk.exporter.span.inflight.”, “reason”: “renamed”, “renamed_to”: “otel.sdk.exporter.span.inflight”

Note:

Stability Level: development

Deprecated, use otel.sdk.exporter.span.inflight instead.

'otel.sdk.exporter.span.inflight.count'

OTEL_SDK_LOG_CREATED =

Note:

Stability Level: development

The number of logs submitted to enabled SDK Loggers

'otel.sdk.log.created'

OTEL_SDK_METRIC_READER_COLLECTION_DURATION =

Note:

Stability Level: development

The duration of the collect operation of the metric reader.

For successful collections, error.type MUST NOT be set. For failed collections, error.type SHOULD contain the failure cause. It can happen that metrics collection is successful for some MetricProducers, while others fail. In that case error.type SHOULD be set to any of the failure causes.

'otel.sdk.metric_reader.collection.duration'

OTEL_SDK_PROCESSOR_LOG_PROCESSED =

Note:

Stability Level: development

The number of log records for which the processing has finished, either successful or failed

For successful processing, error.type MUST NOT be set. For failed processing, error.type MUST contain the failure cause. For the SDK Simple and Batching Log Record Processor a log record is considered to be processed already when it has been submitted to the exporter, not when the corresponding export call has finished.

'otel.sdk.processor.log.processed'

OTEL_SDK_PROCESSOR_LOG_QUEUE_CAPACITY =

Note:

Stability Level: development

The maximum number of log records the queue of a given instance of an SDK Log Record processor can hold

Only applies to Log Record processors which use a queue, e.g. the SDK Batching Log Record Processor.

'otel.sdk.processor.log.queue.capacity'

OTEL_SDK_PROCESSOR_LOG_QUEUE_SIZE =

Note:

Stability Level: development

The number of log records in the queue of a given instance of an SDK log processor

Only applies to log record processors which use a queue, e.g. the SDK Batching Log Record Processor.

'otel.sdk.processor.log.queue.size'

OTEL_SDK_PROCESSOR_SPAN_PROCESSED =

Note:

Stability Level: development

The number of spans for which the processing has finished, either successful or failed

For successful processing, error.type MUST NOT be set. For failed processing, error.type MUST contain the failure cause. 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.

'otel.sdk.processor.span.processed'

OTEL_SDK_PROCESSOR_SPAN_PROCESSED_COUNT =

Deprecated.

“Replaced by otel.sdk.processor.span.processed.”, “reason”: “renamed”, “renamed_to”: “otel.sdk.processor.span.processed”

Note:

Stability Level: development

Deprecated, use otel.sdk.processor.span.processed instead.

'otel.sdk.processor.span.processed.count'

OTEL_SDK_PROCESSOR_SPAN_QUEUE_CAPACITY =

Note:

Stability Level: development

The maximum number of spans the queue of a given instance of an SDK span processor can hold

Only applies to span processors which use a queue, e.g. the SDK Batching Span Processor.

'otel.sdk.processor.span.queue.capacity'

OTEL_SDK_PROCESSOR_SPAN_QUEUE_SIZE =

Note:

Stability Level: development

The number of spans in the queue of a given instance of an SDK span processor

Only applies to span processors which use a queue, e.g. the SDK Batching Span Processor.

'otel.sdk.processor.span.queue.size'

OTEL_SDK_SPAN_ENDED =

Deprecated.

“Obsoleted.”, “reason”: “obsoleted”

Note:

Stability Level: development

Use otel.sdk.span.started minus otel.sdk.span.live to derive this value.

'otel.sdk.span.ended'

OTEL_SDK_SPAN_ENDED_COUNT =

Deprecated.

“Obsoleted.”, “reason”: “obsoleted”

Note:

Stability Level: development

Use otel.sdk.span.started minus otel.sdk.span.live to derive this value.

'otel.sdk.span.ended.count'

OTEL_SDK_SPAN_LIVE =

Note:

Stability Level: development

The number of created spans with recording=true for which the end operation has not been called yet

'otel.sdk.span.live'

OTEL_SDK_SPAN_LIVE_COUNT =

Deprecated.

“Replaced by otel.sdk.span.live.”, “reason”: “renamed”, “renamed_to”: “otel.sdk.span.live”

Note:

Stability Level: development

Deprecated, use otel.sdk.span.live instead.

'otel.sdk.span.live.count'

OTEL_SDK_SPAN_STARTED =

Note:

Stability Level: development

The number of created spans

Implementations MUST record this metric for all spans, even for non-recording ones.

'otel.sdk.span.started'

Attribute Names

OTEL_COMPONENT_NAME =

Note:

Stability Level: development

A name uniquely identifying the instance of the OpenTelemetry component within its containing SDK instance.

Implementations SHOULD ensure a low cardinality for this attribute, even across application or SDK restarts. E.g. implementations MUST NOT use UUIDs as values for this attribute.

Implementations MAY achieve these goals by following a <otel.component.type>/<instance-counter> pattern, e.g. batching_span_processor/0. Hereby otel.component.type refers to the corresponding attribute value of the component.

The value of instance-counter MAY be automatically assigned by the component and uniqueness within the enclosing SDK instance MUST be guaranteed. For example, <instance-counter> MAY be implemented by using a monotonically increasing counter (starting with 0), which is incremented every time an instance of the given component type is started.

With this implementation, for example the first Batching Span Processor would have batching_span_processor/0 as otel.component.name, the second one batching_span_processor/1 and so on. These values will therefore be reused in the case of an application restart.

Examples:

Sample Values

otlp_grpc_span_exporter/0
custom-name

'otel.component.name'

OTEL_COMPONENT_TYPE =

Note:

Stability Level: development

A name identifying the type of the OpenTelemetry component.

If none of the standardized values apply, implementations SHOULD use the language-defined name of the type. E.g. for Java the fully qualified classname SHOULD be used in this case.

Examples:

Sample Values

batching_span_processor
com.example.MySpanExporter

'otel.component.type'

OTEL_LIBRARY_NAME =

Deprecated.

“Replaced by otel.scope.name.”, “reason”: “renamed”, “renamed_to”: “otel.scope.name”

Note:

Stability Level: development

Deprecated. Use the otel.scope.name attribute

Examples:

Sample Values

io.opentelemetry.contrib.mongodb

'otel.library.name'

OTEL_LIBRARY_VERSION =

Deprecated.

“Replaced by otel.scope.version.”, “reason”: “renamed”, “renamed_to”: “otel.scope.version”

Note:

Stability Level: development

Deprecated. Use the otel.scope.version attribute.

Examples:

Sample Values

1.0.0

'otel.library.version'

OTEL_SCOPE_NAME =

Deprecated.

Now available in the stable namespace at OTEL::OTEL_SCOPE_NAME.

Note:

Stability Level: stable

The name of the instrumentation scope - (InstrumentationScope.Name in OTLP).

Examples:

Sample Values

io.opentelemetry.contrib.mongodb

'otel.scope.name'

OTEL_SCOPE_VERSION =

Deprecated.

Now available in the stable namespace at OTEL::OTEL_SCOPE_VERSION.

Note:

Stability Level: stable

The version of the instrumentation scope - (InstrumentationScope.Version in OTLP).

Examples:

Sample Values

1.0.0

'otel.scope.version'

OTEL_SPAN_PARENT_ORIGIN =

Note:

Stability Level: development

Determines whether the span has a parent span, and if so, whether it is a remote parent

'otel.span.parent.origin'

OTEL_SPAN_SAMPLING_RESULT =

Note:

Stability Level: development

The result value of the sampler for this span

'otel.span.sampling_result'

OTEL_STATUS_CODE =

Deprecated.

Now available in the stable namespace at OTEL::OTEL_STATUS_CODE.

Note:

Stability Level: stable

Name of the code, either “OK” or “ERROR”. MUST NOT be set if the status code is UNSET.

'otel.status_code'

OTEL_STATUS_DESCRIPTION =

Deprecated.

Now available in the stable namespace at OTEL::OTEL_STATUS_DESCRIPTION.

Note:

Stability Level: stable

Description of the Status if it has a value, otherwise not set.

Examples:

Sample Values

resource not found

'otel.status_description'