APMのサービス、トレース、スパンを関連リソースにリンクする 🔗
Create global data links to link Splunk APM properties, such as services, traces, spans, and span tags, to relevant resources. For example, you can link APM properties to Infrastructure Monitoring navigators and dashboards, Splunk instances, Kibana logs, or custom URLs.
また、グローバルデータリンクを使用して、閲覧中のプロパティに関するコンテキスト情報をリンク済みのリソースに動的に転送し、関連情報に素早くアクセスできるようにすることができます。
グローバルデータリンクの利用方法については、APMのサービス、トレース、スパンにリンクされた関連リソースにアクセスする を参照してください。
前提条件 🔗
グローバルデータリンクを作成するには、adminロールが必要です。
APMのプロパティにグローバルデータリンクを作成するためのパラメータ 🔗
APMのプロパティにグローバルデータリンクを作成すると、そのプロパティのコンテキストパラメータ値をダッシュボードやカスタムURLに転送できます。以下は、APMのプロパティとそのコンテキストパラメータです。
プロパティ |
フィールド |
コンテキストパラメーター |
説明 |
---|---|---|---|
サービス |
|
|
APMでのサービス名。これは一般的にサービスのインストルメンテーションの設定時に指定されます。 |
トレースID |
|
|
特定のトレースに関連付けられた16文字または32文字の一意識別子。 |
スパンID |
|
|
特定のスパンに関連付けられた16文字の一意識別子。 |
スパンタグ |
既存のスパンタグの値。 |
|
スパンを記述するフィールドと値のペア。スパンタグを使用してスパンを記述します。タグは、サービスのインストルメンテーションを構成する際にタグを指定します。Splunk Distribution of OpenTelemetry Collector(または現在は非推奨のSmart Agent)の設定でもスパンタグを指定できます。 |
APMのプロパティをSplunk Infrastructure Monitoringのダッシュボードにリンクする 🔗
APMのサービス、トレース、スパンに関する情報を、Splunk Observability Cloudで利用可能なカスタムダッシュボードに渡すグローバルデータリンクを作成できます。Infrastructure Monitoringのダッシュボードへのグローバルデータリンクを選択すると、表示していたプロパティの完全なコンテキストがそのダッシュボードに転送されます。たとえば、サービスを表示していた場合、グローバルデータリンクは、選択した時間範囲内でフィルタリングしたエンドポイント、選択した環境、およびフィルタリングしたタグに関する情報を、ダッシュボードに転送します。
次のタスクは、Infrastructure Monitoringのダッシュボードにリンクするサービスのグローバルデータリンクを作成する方法について説明したものです。任意のサービスまたは特定のサービスのグローバルデータリンクを設定できます。
Splunk Observability Cloudのメインメニューで、Settings を選択し、次に Global Data Links を選択します。
新規リンク を選択します。
リンクラベル を入力します。これは、特定のサービスにドリルダウンするためにグローバルデータリンクを使用する際に選択するものです。たとえば、トレース取り込みダッシュボード と入力します。
表示先 には、任意の値 を選択し、sf_service と入力すると、このグローバルデータリンクがすべてのサービスに関連付けられます。特定のサービスに対してグローバルデータリンクを作成する場合は、プロパティ:値ペア を選択し、グローバルデータリンクを作成するサービスとして sf_service:<yourServiceName> を入力します。
グローバルデータリンクを 表示先 の値と1つ以上の追加条件に基づいて表示させたい場合は、条件の追加 を選択します。プロパティ名に基づいて条件を定義するには、任意の値 を選択し、プロパティ名を入力します。プロパティ名と特定の値に基づいて条件を定義する には、プロパティ:値ペア を選択し、プロパティ名と値のペアを入力します。複数の条件を定義すると 、リンクが表示されるためにはすべての条件が満たされる必要があります。
ダッシュボードの選択 を選択し、グローバルデータリンクに関連付けたいダッシュボードを選択します。
保存 を選択します。表示先 の値に一致するサービスを表示する際、サービスの完全なコンテキストがダッシュボードに届きます。
APMのプロパティをSplunkプラットフォームのログにリンクする 🔗
APMのサービス、トレース、スパンに関する情報をSplunk Cloud PlatformまたはSplunk Enterpriseのサーチに渡すグローバルデータリンクを作成できます。つまり、分析中のサービス、トレースID、スパンIDのログを解析するSplunkサーチクエリを実行するグローバルデータリンクを作成できます。
Splunkインスタンスのログに接続したいAPMのプロパティごとにグローバルデータリンクを作成します。たとえば、トレースIDをSplunkインスタンスのログに接続する場合は、トレースIDのコンテキストをSplunkインスタンスに届けるグローバルデータリンクを作成します。スパンIDをSplunkインスタンスのログに接続する場合は、スパンIDのコンテキストをSplunkインスタンスに届けるグローバルデータリンクを作成します。
次のタスクでは、トレースIDのグローバルデータリンクを作成する方法を説明します。このグローバルデータリンクは、Splunkインスタンスで特定のトレースIDを含むログイベントのSplunkサーチクエリを実行します。このプロセスは、サービス、スパンID、またはスパンタグのグローバルデータリンクを作成する場合でも同様です。グローバルデータリンクを作成したいプロパティの 表示先 の値を使用してください。
Splunk Observability Cloudのメインメニューで、Settings を選択し、次に Global Data Links を選択します。
新規リンク を選択します。
リンクラベル を入力します。これは、グローバルデータリンクを使用して特定のトレースIDにドリルダウンする際に選択するものです。たとえば、Splunk Cloud Platform サーチ と入力します。
リンク先 には、Splunk を選択します。
表示先 には、任意の値 を選択し、trace_id を入力します。
グローバルデータリンクを 表示先 の値と1つ以上の追加条件に基づいて表示させたい場合は、条件の追加 を選択します。プロパティ名に基づいて条件を定義するには、任意の値 を選択し、プロパティ名を入力します。プロパティ名と特定の値に基づいて条件を定義する には、プロパティ:値ペア を選択し、プロパティ名と値のペアを入力します。複数の条件を定義すると 、リンクが表示されるためにはすべての条件が満たされる必要があります。
URL に、Splunkインスタンスの完全修飾ドメイン名(FQDN)とポートを入力します。たとえば、Splunk Cloud Platformのインスタンスの場合は、https://<yourHostname>.splunkcloud.com:443 と入力することになります。また、アクセス可能なSplunk EnterpriseインスタンスのFQDNとポートを指定することもできます。
最小時間窓 は 1m に保ちます。
SplunkインスタンスがAPMとは異なる方法でフィールドを参照している場合は、APMのフィールドをSplunkの関連フィールドに関連付けます。たとえば、APM の
sf_service
は、Splunkインスタンスではservice
になる可能性があります。このような場合には、Splunk Observability Cloudの用語 の値を指定し、外部の用語 の値にマッピングします。保存 を選択します。特定のトレースを表示する際、このグローバルデータリンクにドリルダウンして、そのトレースの時間範囲内で、このトレースIDを持つすべてのログイベントを含むSplunkサーチを表示できます。
APMのプロパティをKibanaのログにリンクする 🔗
APMのサービス、トレース、スパンに関する情報をKibana URLに渡すグローバルデータリンクを作成できます。Kibana URLにAPMのプロパティとその特性を渡すことで、Splunk Observability CloudからKibanaにコンテキストを転送できます。
次のタスクでは、選択したトレース ID に対してKibanaのログフィルター用のグローバルデータリンクを作成する方法を説明します。他のAPMプロパティでフィルタリングすることもできます。表示先 の値に、グローバルリンクを作成したいプロパティを指定します。
Splunk Observability Cloudのメインメニューを開きます。
Data Configuration にカーソルを合わせ、Global Data Links を選択します。
新規リンク を選択します。
リンクラベル を入力します。これは、グローバルデータリンクを使用して特定のトレースIDにドリルダウンする際に選択するものです。たとえば、Kibanaフィルター と入力します。
リンク先 には、Kibana を選択します。
表示先 には、任意の値 を選択し、trace_id を入力します。
グローバルデータリンクを 表示先 の値と1つ以上の追加条件に基づいて表示させたい場合は、条件の追加 を選択します。プロパティ名に基づいて条件を定義するには、任意の値 を選択し、プロパティ名を入力します。プロパティ名と特定の値に基づいて条件を定義する には、プロパティ:値ペア を選択し、プロパティ名と値のペアを入力します。複数の条件を定義すると 、リンクが表示されるためにはすべての条件が満たされる必要があります。
URL のログフィルターに trace_id フィールドを含む Kibana URLを入力します。たとえば、次のようなURLを入力します:
http://<yourKibanaFQDN>/kibana/app/kibana#/discover?_g=(refreshInterval:(display:Off,pause:!f,value:0),time:(from:'{{start_time}}',mode:absolute,to:'{{end_time}}'))&_a=(columns:!(_source),interval:auto,query:(language:kuery,query:'traceId:{{value}}'),sort:!('@timestamp',desc))
お好みの 時間形式 を入力します。
最小時間窓 は 1m に保ちます。
KibanaがAPMとは異なる方法でフィールドを参照している場合は、APMのフィールドをKibanaの関連フィールドに関連付けます。たとえば、APMの
sf_service
は、Kibanaではservice
になる可能性があります。このような場合には、Splunk Observability Cloudの用語 と 外部の用語 を指定します。フィールド名が同じ場合は、この手順を飛ばしてください。保存 を選択します。特定のトレースを表示する際、このグローバルデータリンクにドリルダウンして、そのトレースの時間範囲内で、このトレースIDを持つすべてのログイベントを含むSplunkサーチを表示できます。
カスタムURLにAPMのコンテキストを転送する 🔗
APMのサービス、トレース、またはスパンに関する情報をカスタムURLに渡すグローバルデータリンクを作成できます。
例えば、次のようなカスタムURLを指定して、サービスのコンテキストをURLに転送することができます: https://www.example.com/search/?field={{key}}&value={{value}}&service={{properties.sf_service}}&st={{start_time}}&et={{end_time}}
。
さらに詳しく 🔗
カスタムURLへのグローバルデータリンクを作成する詳細な手順については、グローバル・データリンクを使用して、メタデータを関連リソースにリンクする を参照してください。
カスタムURLグローバル・データリンク設定例 を参照してください。
カスタムURLにコンテキストを転送するために使用できるパラメータについては、APMのプロパティにグローバルデータリンクを作成するためのパラメータ を参照してください。
データベースと推定サービスをInfrastructure Monitoringのダッシュボードにリンクする 🔗
Create a global data link specifically for a single inferred service to associate a navigator or dashboard with the inferred service as the top-ranked navigator or dashboard. The top-ranked entity is the View Navigator/View Dashboard option in the Monitoring tab when you view a service from the service list or service map.
Triggers for global data links for navigators or dashboards that use wildcards (*) for service names can’t be top-ranked navigators or dashboards for inferred services.
For example, a navigator or dashboard associated with a global data link that contains a Show On value of sf_service:*
can’t be a top-ranked navigator or dashboard for an inferred service. To create a global data link that acts as a default navigator or dashboard for an inferred service from the Monitoring tab, the Show On value must include the name of the inferred service. For example, if you are creating a global data link for a default navigator or dashboard for the inferred service mydb
, the Show On value must be sf_service:mydb
.