非OTLP形式へのマッピング
この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/otel/common/mapping-to-non-otlp/
翻訳元: open-telemetry/opentelemetry-specification v1.60.0（コミット 29ae8c7）
ステータス: Stable
OpenTelemetry APIを使って記録されるすべてのOpenTelemetryの概念とデータは、OTLP形式の対応するメッセージとフィールドを使って直接かつ正確に表現できます。しかし、他の形式では常にそうとは限りません。ある形式が、特定のOpenTelemetryの概念や概念のフィールドをネイティブに表現する方法を持たない場合があります。
本文書は、OTLP以外の形式のうち、OpenTelemetryのフィールドや概念に直接対応する意味論的な等価物を持たないものについて、OpenTelemetryとそれらの形式との間の変換を定義します。
注: ある形式が特定のフィールドや概念に対して直接対応する意味論的な等価物を持つ場合、本文書の推奨事項はMUST無視されるものとします。
PrometheusとZipkinについての追加の具体的な変換規則も参照してください。PrometheusとZipkinについての具体的な規則は、本文書で定義される汎用的な規則より優先されます。
Mappings
InstrumentationScope
OpenTelemetryのInstrumentationScopeのフィールドは、以下のマッピングを使って、Span・Metric Data Point・LogRecordに関連付けられたキーと値の組としてMUST報告されるものとします。
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
otel.scope.name | string | Instrumentation Scopeの名前（OTLPにおけるInstrumentationScope.Name）。 | io.opentelemetry.contrib.mongodb | Recommended |
otel.scope.version | string | Instrumentation Scopeのバージョン（OTLPにおけるInstrumentationScope.Version）。 | 1.0.0 | Recommended |
以下の非推奨のエイリアスも、後方互換性のため、まったく同じ値でMUST報告されるものとします。
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
otel.library.name | string | 非推奨。otel.scope.name属性を使用してください。 | io.opentelemetry.contrib.mongodb | Recommended |
otel.library.version | string | 非推奨。otel.scope.version属性を使用してください。 | 1.0.0 | Recommended |
Span Status
SpanのStatusは、StatusがUNSETである場合を除き、Spanに関連付けられたキーと値の組としてMUST報告されるものとします。UNSETの場合はMUST NOT報告されるものとします。
以下の表は、OpenTelemetryのStatusのSpanのキーと値の組へのマッピングを定義します。
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
otel.status_code | string | コードの名前。“OK"または"ERROR”。ステータスコードが UNSET の場合は設定してはならない。 | OK | Recommended |
otel.status_description | string | Statusに値がある場合のその説明、それ以外の場合は設定しない。 | resource not found | Recommended |
otel.status_codeは以下のいずれかでなければなりません（MUST）。
| Value | Description |
|---|---|
OK | アプリケーション開発者またはオペレーターによって、その操作が正常に完了したと検証済みであることを示す。 |
ERROR | その操作にエラーが含まれることを示す。 |
Dropped Attributes Count
OpenTelemetryのdropped attributes countは、対応するデータエンティティ（Span、Span Link、Span Event、Metricのデータポイント、LogRecordなど）に関連付けられたキーと値の組としてMUST報告されるものとします。キー名はotel.dropped_attributes_countでなければなりません（MUST）。
このキーと値の組は、値が0でない場合にのみ記録すべきです。
Dropped Events Count
OpenTelemetryのSpanのdropped events countは、Spanに関連付けられたキーと値の組としてMUST報告されるものとします。キー名はotel.dropped_events_countでなければなりません（MUST）。
このキーと値の組は、値が0でない場合にのみ記録すべきです。
Dropped Links Count
OpenTelemetryのSpanのdropped links countは、Spanに関連付けられたキーと値の組としてMUST報告されるものとします。キー名はotel.dropped_links_countでなければなりません（MUST）。
このキーと値の組は、値が0でない場合にのみ記録すべきです。
Instrumentation Scope Attributes
Scopeに相当する概念を持たない形式へのエクスポーターは、それぞれの形式においてSpan・Metric・LogRecordに相当するもののうち最も適した場所に、これらの属性を記録すべきです（SHOULD）。