メタデータ：ディメンション、カスタムプロパティ、タグ、属性

Splunk Observability Cloud でのディメンション、カスタムプロパティ、およびタグの違いについて確認します。

Splunk Observability Cloud のデータは、追加のメタデータで強化されています。


名前	説明	データ型	書式
寸法	メトリックにコンテキストを追加するため、取り込み時にメトリック時系列（MTS）で送信されます。メトリック名とともに、MTS を一意に識別します。ディメンション名は時間の経過とともに変更されません。	インフラストラクチャメトリック	キーと値のペア
カスタムプロパティ:	メトリックにコンテキストを追加するために、取り込み後にメトリックディメンションに適用されます。カスタムプロパティは MTS の一意の識別には関与しません。	インフラストラクチャメトリック	キーと値のペア
タグ	取り込み後にメトリックディメンションとカスタムプロパティに適用される、それらの分類に役立つラベルまたはキーワード。タグを使用して、 `sf_tags`を使用してチャートおよびディテクタで MTS をフィルタリングできます。	インフラストラクチャメトリック	文字列
属性またはスパンタグ	追跡対象の操作に関する情報を伝送する注釈。	APM メトリック、コレクタメトリック、スパン	キーと値のペア

メタデータを検索、編集、リンクする

メタデータの検索、編集、およびリンクの方法については、次のリソースを参照してください。

メタデータを検索して編集するには、メタデータカタログを使用します。詳細については、「メトリック Finder とメタデータカタログの検索」を参照してください。
メタデータを他のリソースにリンクするには、「グローバルデータリンクを使用した関連リソースへのメタデータのリンク」の方法を参照してください。
メトリックにメタデータを追加するには、「Metric Finder とメタデータカタログの検索」を参照してください。API を使用してメタデータを追加することもできます。詳細については、Splunk のデベロッパー向けドキュメントを参照してください。

データを活用するためのその他のツールについては、次を参照してください。

寸法

注意: OpenTelemetry データモデルは、ディメンションの代わりに 属性 を使用します。詳細については、「OpenTelemetry のタグ」を参照してください。

ディメンションは、モニタリングソフトウェアがメトリックとともに送信するキーと値のペア形式の不変のメタデータです。取り込み中に送信された MTS ディメンションのセットは、MTS を一意に識別するためにメトリック名とともに使用されます。

ディメンションは、メトリックを送信したホストの名前など、メトリックに関する追加情報を提供します。例： "hostname": "host1"。

以下が適用されます。

異なるキーを持つ 2 つのキーと値のペアは、値に関係なく、異なるディメンションです。たとえば、 "hostname": "bcn" と "clustername": "bcn"などです。
同じキーを持ち、値が異なる 2 つのキーと値のペアは、ディメンションが異なります。たとえば、 "hostname": "bcn" と "hostname": "gir" のようになります。
同じキーと値を持つ 2 つのキーと値のペアは、同じディメンションです。たとえば、 "hostname": "host" と "hostname": "host" のようになります。

ディメンションの使用方法については、「インフラストラクチャで各メタデータタイプを使用するタイミング」を参照してください。

寸法の基準

MTS ごとに最大 36 の一意のディメンションを定義できます。

ディメンション名の条件：

UTF-8 文字列で、最大長 128 文字（512 バイト）。
大文字または小文字から始める必要があります。
アンダースコア（_）から始めることはできません。
最初の文字の後、名前には文字、数字、アンダースコア（_）、ハイフン（-）、およびピリオド（.）を含めることはできますが、空白スペースを含めることはできません。
sf_hiresなど、Splunk Observability Cloud によって定義されたディメンションを除き、プレフィックス sf_から始まらないようにする必要があります。

カスタムプロパティ:

カスタムプロパティは、取り込み後に既存の MTS のディメンションに割り当てることができるキーと値のペアです。カスタムプロパティは単一の値であり、複数の値をサポートしていません。

たとえば、カスタムプロパティ use: QA を メトリックのホストディメンションに追加して、データを送信しているホストが QA に使用されていることを示すことができます。カスタムプロパティ use: QA は、そのディメンションを持つすべての MTS に伝播します。既存のメトリックディメンションにカスタムプロパティを追加する方法の詳細については、「メタデータカタログの検索」を参照してください。

Splunk Observability Cloud が統合またはモニターから取得したディメンションに別の名前を割り当てた場合、そのディメンションは、取り込み後にメトリックに割り当てられるため、カスタムプロパティにもなります。たとえば、AWS EC2 統合は instance-id ディメンションを送信し、Splunk Observability Cloud はディメンションの名前を aws_instance_idに変更します。この名前が変更されたディメンションはカスタムプロパティです。

Splunk Observability Cloud がカスタムプロパティを使用して、モニタリングソフトウェアによって生成されるディメンションの名前を変更する方法の詳細については、「メトリックとディメンションの名前に関するガイダンス」を参照してください。

タグにカスタムプロパティを適用することもできます。これを行うと、そのタグを持つものはすべて、タグに関連付けられているプロパティを継承します。たとえば、 tier:web カスタムプロパティを apps-team タグと関連付けると、Splunk Observability Cloud は、 tier:web カスタムプロパティを apps-team タグを持つ任意のメトリックまたはディメンションにアタッチします。

カスタムプロパティ基準

ディメンションごとに最大 75 のカスタムプロパティを定義できます。

カスタムプロパティ名と値の基準：

名前は、最大長が 128 文字（512 バイト）の UTF-8 文字列である必要があります。すでにディメンション名として使用されているカスタムプロパティ名は避けてください。
値は、最大長が 256 文字（1024 バイト）の UTF-8 文字列である必要があります。
オプションの description プロパティを使用すると、メトリック、ディメンション、またはタグの詳細な説明を入力できます。説明には最大 1024 文字の UTF-8 文字を使用できます。

カスタムプロパティ値では、Splunk Observability Cloud は数値を数値文字列として保存します。

インフラストラクチャモニタリングタグ

インフラストラクチャモニタリングでは、タグはディメンションとカスタムプロパティに割り当てることができるラベルまたはキーワードであり、複数のディメンションに同じ検索可能な値を与えることができます。カスタムプロパティとは異なり、タグはディメンションの sf_tags プロパティの下にあり、複数の値を持つことができます。

既存のメトリックへのタグの追加の詳細については、「メタデータカタログの検索」を参照してください。

タグの基準

タグは、最大長が 256 UTF-8 文字/1024 バイトの UTF-8 文字列です。

ディメンションごとに最大 50 個のタグを使用できます。
カスタムプロパティごとに最大 50 個のタグを作成できます。

スパン属性またはタグ

タグは、オブジェクトとタグの多対 1 の関係、またはタグとタグの適用先オブジェクトとの間に 1 対多の関係が必要な場合に使用されます。これらは、本来は関連付けられていない可能性のあるメトリックをグループ化するのに役立ちます。

OpenTelemetry の属性

OpenTelemetry データモデルでは、メタデータは SPAN 属性またはタグとして提供されます。コレクタのトレースパイプラインで属性プロセッサを使用して、それらを追加および変更できます。

詳細については、「OpenTelemetry のタグ」を参照してください。

Splunk APM の属性

Splunk APM では、スパンタグは、スパンが表す操作に関する情報とコンテキストを提供するためにインストゥルメンテーションを介してスパンに追加されるキーと値のペアです。

APM の span タグの詳細については、以下を参照してください。

Splunk RUM の属性

RUM でグローバル属性を設定するには、次を参照してください。

インフラストラクチャで各メタデータタイプを使用するタイミング

次の表に、IM メタデータのタイプ間の主な違いを示します。


メタデータ	作成日時	追加対象	フィルタ処理するか	グループ化の対象
寸法	Splunk Observability Cloud がデータを取り込むとき	メトリック時系列	対応	対応
カスタムプロパティ:	取り込み後、ユーザーインターフェイスまたは REST API を介して	寸法とタグ	対応	対応
タグ	取り込み後、ユーザーインターフェイスまたは REST API を介して	ディメンションおよびカスタムプロパティ	対応	いいえ

メタデータの各タイプが Splunk Observability Cloud で独自の関数を持ちます。次のセクションでは、メトリックに最適なタイプのメタデータを選択するのに役立ついくつかの考慮事項について説明します。

ディメンションまたはカスタムプロパティの使用

注: ディメンションとカスタムプロパティは UI で互いに区別できませんが、異なる方法で動作し、異なる目的で使用されます。

ディメンションとカスタムプロパティは、両方ともキーと値のペアであるという点で似ており、メトリックにコンテキストを追加し、メトリックを効果的にグループ化および集約するためのツールを提供します。ディメンションとカスタムプロパティの主な違いは次のとおりです。

取り込み時にディメンションで送信し、取り込み後にカスタムプロパティを追加します。
ディメンションを変更することはできませんが、カスタムプロパティを変更することはできます。

これらの違いにより、次の状況でディメンションを使用します。

メタデータで一意の MTS を定義する必要がある場合。「例：複数のデータセンターからの同じメトリックの送信」を参照してください。
メタデータの履歴値を追跡する場合。「例：履歴値の追跡と比較」を参照してください。

例：複数のデータセンターから同じメトリックを送信する

2 つのデータセンターから cpu.utilization というメトリックを使用して送信するとします。各データセンター内には、次のキーと値のペアで表される一意の名前を持つ 10 台のサーバーがあります。host :server1、 host:server2、…、 host:server10。ただし、サーバー名はデータセンター内でのみ一意であり、環境全体で一意ではありません。区別しやすくするために、データセンターにメタデータ（ dc:west と dc:east）を追加します。この場合、環境内のすべてのホストに個別の MTS が必要であることを取り込む前に知っているため、ホストとデータセンターに関するメタデータをディメンションとして送信する必要があります。

例：履歴値の追跡と比較

アプリケーションに対するリクエストの遅延を測定するために、 latency というメトリックを収集するとします。すでに顧客のディメンションがありますが、アプリケーションのバージョン 1.0 と 2.0 間の改善も追跡する必要があります。この場合、 version:1.0 と version:2.0 の ディメンションを作成する必要があります。 version:1.0 を カスタムプロパティとして設定し、アプリケーションの新しいバージョンをリリースする際に version:2.0 に変更すると、 version:1.0 で定義された遅延 MTS の 遅延MTS の履歴値がすべて失われます。

カスタムプロパティは、次の状況で使用します。

メトリックに追加のコンテキストを提供するメタデータがあるが、そのメタデータで別の一意に識別可能な MTS を作成する必要がない場合。
メタデータがある場合は、将来変更を加えることができます。

例：MTS を追加せずにコンテキストを追加

顧客がサービスに関する問題を抱えているタイミングを知るために、 service.errors というメトリックを収集するとします。このメトリックの MTS は、顧客およびサービスディメンションによってすでに一意に識別できます。すべての顧客に対する各サービスのエスカレーション連絡先をメトリックに添付する必要があります。この場合、エスカレーション連絡先をカスタムプロパティとして特定のサービスディメンションまたは顧客ディメンションに割り当てます。チームが成長し再編成するにつれて、このメタデータを変更できるようにする必要があります。また、顧客とサービスのディメンションによってすでに個別の MTS が生成されているため、ディメンションとしてエスカレーションの連絡先を使用する必要はありません。

インフラストラクチャモニタリングタグを使用する

インフラストラクチャモニタリングでは、タグとタグを割り当てるオブジェクトの間に 1 対多の関係がある場合にタグを使用します。

例：Canary テスト

ご使用の環境で Canary のテストを行うとします。Canary 展開を作成するとき、 canary タグを使用して、新しいコードを受信したホストをマークできます。これにより、メトリックを特定し、新しいコードを受信しなかったホストのパフォーマンスを比較できます。単一の値、 canaryしかないため、キーと値のペアは必要ありません。

例：複数のアプリケーションを実行するホスト

環境内で複数のアプリケーションを実行するホストがあるとします。特定のホストが実行しているアプリを識別するには、アプリごとにタグを作成し、次のタグの 1 つ以上を ホストに適用します。 <name>各ホストで実行されているアプリを指定するための次元。