データベース呼び出しとシステムに関するセマンティック規約

この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/semconv/db/

翻訳元: open-telemetry/semantic-conventions v1.44.0(コミット e10a930

ステータス: Mixed

この文書では、データベースクライアントのスパンに関するセマンティック規約に加え、データベースのメトリクスとログに関するセマンティック規約を定義します。

[!IMPORTANT]

この文書のv1.24.0 以前のバージョンを使っている既存のデータベース計装は、次に従うべきです。

  • 既存のメジャーバージョンにおいて、デフォルトで発行するデータベース規約のバージョンを変更してはなりません(SHOULD NOT)。 規約には、属性、メトリクス名、スパン名、計測単位などが含まれますが、これらに限定されません。
  • 既存のメジャーバージョンにおいて、カテゴリー別の値をカンマ区切りで列挙するリストとして環境変数 OTEL_SEMCONV_STABILITY_OPT_IN を導入すべきです(SHOULD) (例: http、databases、messaging)。値の一覧は次のとおりです。
    • database - 安定版のデータベース規約を発行し、それまで計装が発行していた実験的なデータベース規約の発行を停止します。
    • database/dup - 実験的な規約と安定版の規約の両方を発行し、安定版セマンティック規約への段階的な移行を可能にします。
    • これらの値がいずれも指定されていない場合のデフォルトの動作は、その計装がそれまで発行していた実験的なデータベース規約のバージョンをそのまま発行し続けることです。
    • 注記: 両方の値が指定されている場合、database/dupdatabase よりも優先されます。
  • 両方の規約セットを発行し始めてから少なくとも6か月間は、既存のメジャーバージョンを(少なくともセキュリティパッチの適用という形で)維持すべきです(SHOULD)。
  • 次のメジャーバージョンでは、この環境変数を削除し、安定版のデータベース規約のみを発行してもかまいません(MAY)。

データベース操作に関するセマンティック規約は、次のシグナルについて定義されています。

  • DB Spans: データベースクライアントのスパンに関するセマンティック規約。
  • DB Metrics: データベース操作のメトリクスに関するセマンティック規約。
  • DB Exceptions: データベースクライアントの例外に関するセマンティック規約。

技術固有のセマンティック規約は、次のデータベースについて定義されています。

  • AWS DynamoDB: AWS DynamoDBに関するセマンティック規約。
  • Cassandra: Cassandraに関するセマンティック規約。
  • Azure Cosmos DB: Azure Cosmos DBに関するセマンティック規約。
  • CouchDB: CouchDBに関するセマンティック規約。
  • Elasticsearch: Elasticsearchに関するセマンティック規約。
  • HBase: HBaseに関するセマンティック規約。
  • MongoDB: MongoDBに関するセマンティック規約。
  • Microsoft SQL Server: Microsoft SQL Serverに関するセマンティック規約。
  • Oracle Database: Oracle Databaseに関するセマンティック規約。
  • Redis: Redisに関するセマンティック規約。
  • SQL: SQLデータベースに関するセマンティック規約。