OTel

OTel 属性

为 OpenTelemetry 保留的属性

Attributes

StabilityValue Type描述Example Values
otel.span.parent.originDevelopment字符串确定 span 是否有父 span,如果有,则确定 是否为远程父 spannonelocalremote
otel.span.sampling_resultDevelopment字符串此 span 的采样器返回的结果值DROPRECORD_ONLYRECORD_AND_SAMPLE
otel.status_codeStable字符串代码名称,“OK”或“ERROR”。如果状态码为 UNSET,则 MUST NOT 设置。OKERROR
otel.status_descriptionStable字符串状态的描述,如果存在则显示,否则不设置。未找到资源

otel.span.parent.origin 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。

描述Stability
localspan 具有父 span,并且父 span 的 span context isRemote() 返回 falseDevelopment
span 没有父 span,它是根 spanDevelopment
remotespan 具有父 span,并且父 span 的 span context isRemote() 返回 trueDevelopment

otel.span.sampling_result 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。

描述Stability
DROPspan 未采样且不记录Development
RECORD_AND_SAMPLEspan 已采样且正在记录Development
RECORD_ONLYspan 未采样,但正在记录Development

otel.status_code 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。

描述Stability
ERROR操作包含错误。Stable
OK应用程序开发人员或操作员已验证操作成功完成。Stable

OTel 组件属性

用于 OpenTelemetry 组件自我监控的属性

Attributes

StabilityValue Type描述Example Values
otel.component.nameDevelopment字符串唯一标识 OpenTelemetry 组件实例在其包含的 SDK 实例内的名称。[1]otlp_grpc_span_exporter/0custom-name
otel.component.typeDevelopment字符串标识 OpenTelemetry 组件类型的名称。[2]batching_span_processorcom.example.MySpanExporter

[1] otel.component.name: 实现应确保此属性的基数较低,即使在应用程序或 SDK 重启时也是如此。例如,实现不能使用 UUID 作为此属性的值。

实现可以通过遵循 <otel.component.type>/<instance-counter> 模式来实现这些目标,例如 batching_span_processor/0。其中 otel.component.type 指的是组件的相应属性值。

instance-counter 的值可以由组件自动分配,并且必须保证在包含的 SDK 实例内具有唯一性。例如,<instance-counter> 可以通过使用单调递增的计数器(从 0 开始)来实现,该计数器在给定组件类型的实例启动时递增。

通过这种实现,例如第一个 Batching Span Processor 的 otel.component.name 将是 batching_span_processor/0,第二个是 batching_span_processor/1,依此类推。因此,在应用程序重启时,这些值将得以重用。

[2] otel.component.type: 如果没有标准值适用,实现应使用该类型的语言定义的名称。例如,对于 Java,在这种情况下应使用完全限定的类名。


otel.component.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。

描述Stability
batching_log_processor内置 SDK 批处理日志记录处理器Development
batching_span_processor内置 SDK 批处理 span 处理器Development
otlp_grpc_log_exporter通过 gRPC 进行 OTLP 日志记录导出,使用 protobuf 序列化Development
otlp_grpc_metric_exporter通过 gRPC 进行 OTLP 指标导出,使用 protobuf 序列化Development
otlp_grpc_span_exporter通过 gRPC 进行 OTLP span 导出,使用 protobuf 序列化Development
otlp_http_json_log_exporter通过 HTTP 进行 OTLP 日志记录导出,使用 JSON 序列化Development
otlp_http_json_metric_exporter通过 HTTP 进行 OTLP 指标导出,使用 JSON 序列化Development
otlp_http_json_span_exporter通过 HTTP 进行 OTLP span 导出,使用 JSON 序列化Development
otlp_http_log_exporter通过 HTTP 进行 OTLP 日志记录导出,使用 protobuf 序列化Development
otlp_http_metric_exporter通过 HTTP 进行 OTLP 指标导出,使用 protobuf 序列化Development
otlp_http_span_exporter通过 HTTP 进行 OTLP span 导出,使用 protobuf 序列化Development
periodic_metric_reader内置 SDK 定期导出指标的读取器Development
prometheus_http_text_metric_exporter通过 HTTP 进行 Prometheus 指标导出,使用默认的文本格式Development
simple_log_processor内置 SDK 简单日志记录处理器Development
simple_span_processor内置 SDK 简单 span 处理器Development
zipkin_http_span_exporter通过 HTTP 进行 Zipkin span 导出Development

OTel 作用域属性

非 OTLP 导出器用于表示 OpenTelemetry 作用域概念的属性。

Attributes

StabilityValue Type描述Example Values
otel.scope.nameStable字符串Instrumentation Scope 的名称 - (OTLP 中的 InstrumentationScope.Name)。io.opentelemetry.contrib.mongodb
otel.scope.schema_urlDevelopment字符串Instrumentation Scope 的模式 URL。/schemas/1.31.0
otel.scope.versionStable字符串Instrumentation Scope 的版本 - (OTLP 中的 InstrumentationScope.Version)。1.0.0

已弃用的 OTel 库属性

描述已弃用的 otel.library 属性。

Attributes

StabilityValue Type描述Example Values
otel.library.nameDeprecated
已替换为 otel.scope.name
字符串已弃用。请使用 otel.scope.name 属性io.opentelemetry.contrib.mongodb
otel.library.versionDeprecated
已替换为 otel.scope.version
字符串已弃用。请使用 otel.scope.version 属性。1.0.0