スキーマファイル形式 1.1.0

# ファイル形式を定義します。1.1.0にMUST設定するものとします。
file_format: 1.1.0

# このファイルが公開されるSchema URL。このURLのバージョン番号は、以下の
# "versions"セクションの最も高いバージョン番号にMUST一致するものとします。
# 注記：URL内のスキーマバージョン番号は、上記のfile_format設定とは
# まったく関係ありません。
schema_url: https://opentelemetry.io/schemas/1.2.0

# このファミリーに含まれる各スキーマバージョンの定義。
# 注記：バージョンの順序は、semverのバージョン番号順序付け規則に
# 従って定義されます。
versions:
  <version_number_last>:
    # このバージョンの定義。詳細は以下を参照。

  <version_number_previous>:
    # 前のバージョンの定義
    ...
  <version_number_first>:
    # 最初のバージョンを定義します。

  <version_number>:
    all:
      changes:
        # 変換の並び。

    resources:
      changes:
        # 変換の並び。

    spans:
      changes:
        # 変換の並び。

    span_events:
      changes:
        # 変換の並び。

    metrics:
      changes:
        # 変換の並び。

    logs:
      changes:
        # 変換の並び。

    all:
      changes:
        - rename_attributes:
            attribute_map:
              # キーと値の組のマップ。

    resources:
      changes:
        - rename_attributes:
            attribute_map:
              # キーと値の組のマップ。キーは前のバージョンで使われていた
              # 古い属性名、値はこのバージョンから始まる新しい属性名です。

    spans:
      changes:
        - rename_attributes:
            attribute_map:
              # キーと値の組のマップ。キーは前のバージョンで使われていた
              # 古い属性名、値はこのバージョンから始まる新しい属性名です。

            apply_to_spans:
              # 任意。指定がない場合、変換はすべてのスパンに適用されます。
              # 指定がある場合、変換は以下で指定される並びに見つかった名前を
              # 持つスパンにのみ適用されます。

    span_events:
      changes:
        - rename_events:
            name_map:
              # キーは前のバージョンで使われていた古いイベント名、値は
              # このバージョンから始まる新しいイベント名です。

    span_events:
      changes:
        - rename_attributes:
            attribute_map:
              # キーと値の組のマップ。キーは前のバージョンで使われていた
              # 古い属性名、値はこのバージョンから始まる新しい属性名です。

            apply_to_spans:
              # 任意の適用対象スパン名。空の場合はすべてのスパンに適用されます。

            apply_to_events:
              # 任意の適用対象イベント名。空の場合はすべてのイベントに適用されます。

    metrics:
      changes:
        - rename_metrics:
            # キーと値の組のマップ。キーは前のバージョンで使われていた
            # 古いメトリック名、値はこのバージョンから始まる新しい
            # メトリック名です。

    metrics:
      changes:
        - rename_attributes:
            attribute_map:
              # キーと値の組のマップ。キーは前のバージョンで使われていた
              # 古い属性名、値はこのバージョンから始まる新しい属性名です。

            apply_to_metrics:
              # 任意。指定がない場合、変換はすべてのメトリクスに適用されます。
              # 指定がある場合、変換は以下で指定される並びに見つかった名前を
              # 持つメトリクスにのみ適用されます。

    metrics:
      changes:
        - split:
            # 分割対象の古いメトリクスの名前。
            apply_to_metric:
            # 分割に使う、古いメトリクス内の属性の名前。この属性は排除され、
            # 新しいメトリクスはこの属性を持ちません。
            by_attribute:
            # 作成する新しいメトリクスの名前。属性の値ごとに1つ作成されます。
            metrics_from_attributes:
              # キーと値の組のマップ。キーはこのバージョンから始まる新しい
              # メトリクス名、値は前のバージョンで使われていた古い属性値です。

    logs:
      changes:
        - rename_attributes:
            attribute_map:
              # キーと値の組のマップ。キーは前のバージョンで使われていた
              # 古い属性名、値はこのバージョンから始まる新しい属性名です。

# ファイル形式を定義します。1.1.0にMUST設定するものとします。
file_format: 1.1.0

# このファイルが公開されるSchema URL。このURLのバージョン番号は、以下の
# "versions"セクションの最も高いバージョン番号にMUST一致するものとします。
# 注記：URL内のスキーマバージョン番号は、上記のfile_format設定とは
# まったく関係ありません。
schema_url: https://opentelemetry.io/schemas/1.1.0

# このファミリーに含まれる各スキーマバージョンの定義。
# 注記：バージョンの順序は、semverのバージョン番号順序付け規則に
# 従って定義されます。
versions:
  1.1.0:
    # バージョン1.1.0の定義。
    all:
      # すべてのデータ種別に適用される定義。
      changes:
        # バージョン1.0.0から1.1.0へ変換する際に適用する変換。
        - rename_attributes:
            # キーと値の組のマップ。キーは前のバージョンで使われていた
            # 古い属性名、値はこのバージョンから始まる新しい属性名です。
            # k8s.*をkubernetes.*へ名前変更
            k8s.cluster.name: kubernetes.cluster.name
            k8s.namespace.name: kubernetes.namespace.name
            k8s.node.name: kubernetes.node.name
            k8s.node.uid: kubernetes.node.uid
            k8s.pod.name: kubernetes.pod.name
            k8s.pod.uid: kubernetes.pod.uid
            k8s.container.name: kubernetes.container.name
            k8s.replicaset.name: kubernetes.replicaset.name
            k8s.replicaset.uid: kubernetes.replicaset.uid
            k8s.cronjob.name: kubernetes.cronjob.name
            k8s.cronjob.uid: kubernetes.cronjob.uid
            k8s.job.name: kubernetes.job.name
            k8s.job.uid: kubernetes.job.uid
            k8s.statefulset.name: kubernetes.statefulset.name
            k8s.statefulset.uid: kubernetes.statefulset.uid
            k8s.daemonset.name: kubernetes.daemonset.name
            k8s.daemonset.uid: kubernetes.daemonset.uid
            k8s.deployment.name: kubernetes.deployment.name
            k8s.deployment.uid: kubernetes.deployment.uid

    resources:
      # Resourceデータ種別に適用される定義。
      changes:
        - rename_attributes:
            telemetry.auto.version: telemetry.auto_instr.version

    spans:
      # Spanデータ種別に適用される定義。
      changes:
        - rename_attributes:
            attribute_map:
              # キーと値の組のマップ。キーは前のバージョンで使われていた
              # 古い属性名、値はこのバージョンから始まる新しい属性名です。
              peer.service: peer.service.name
            apply_to_spans:
              # "HTTP GET"という名前のスパンにのみ適用
              - "HTTP GET"

    span_events:
      # Span Eventデータ種別に適用される定義。
      changes:
        - rename_events:
            # キーは前のバージョンで使われていた古いイベント名、値は
            # このバージョンから始まる新しいイベント名です。
            name_map: {stacktrace: stack_trace}

        - rename_attributes:
            attribute_map:
              peer.service: peer.service.name
            apply_to_events:
              # 任意の適用対象イベント名。空の場合はすべてのイベントに適用されます。
              - exception.stack_trace

    metrics:
      # Metricデータ種別に適用される定義。
      changes:
        - rename_metrics:
            # キーと値の組のマップ。キーは前のバージョンで使われていた
            # 古いメトリック名、値はこのバージョンから始まる新しい
            # メトリック名です。
            container.cpu.usage.total: cpu.usage.total
            container.memory.usage.max: memory.usage.max

        - rename_attributes:
            attribute_map:
              status: state
            apply_to_metrics:
              # 任意。指定がない場合、変換はすべてのメトリクスに適用されます。
              # 指定がある場合、変換は以下で指定される並びに見つかった名前を
              # 持つメトリクスにのみ適用されます。
              - system.cpu.utilization
              - system.memory.usage
              - system.memory.utilization
              - system.paging.usage

        - split:
            # https://github.com/open-telemetry/opentelemetry-specification/pull/2617 で行われた変更の例
            # 分割対象の古いメトリクスの名前。
            apply_to_metric: system.paging.operations
            # 分割に使う、古いメトリクス内の属性の名前。この属性は排除され、
            # 新しいメトリクスはこの属性を持ちません。
            by_attribute: direction
            # 作成する新しいメトリクスの名前。属性の値ごとに1つ作成されます。
            metrics_from_attributes:
              # "direction"属性が"in"に等しい場合、"system.paging.operations.in"
              # という名前の新しいメトリクスを作成します。
              system.paging.operations.in: in
              # "direction"属性が"out"に等しい場合、"system.paging.operations.out"
              # という名前の新しいメトリクスを作成します。
              system.paging.operations.out: out

    logs:
      # LogRecordデータ種別に適用される定義。
      changes:
        - rename_attributes:
            attribute_map:
              process.executable_name: process.executable.name

  1.0.0:
    # このスキーマファミリーの最初のバージョン。