ビジネスワークフロールールの設定 🔗
Enterprise Editionで利用できる機能です
Business Workflow rules use span tags to make trace behavior in transaction processing explicit and transparent. You can create rules that correlate traces from a specific service or from multiple services that include the same global span tag.
[ビジネスワークフロー]ページには、「すべてのトレースは、そのトレースの開始操作によって識別されるワークフローに関連付けられる」という、システムが生成したルールがデフォルトで含まれています。これは唯一のデフォルトルールです。このデフォルトルールを編集することはできませんが、無効にすることはできます。
前提条件 🔗
You must have an admin role to configure Business Workflow rules.
To create a Business Workflow rule that uses span tags, you have to first index the tag. See Index span tags to create Troubleshooting MetricSets for steps to index a span tag.
ルールを設定する 🔗
Splunk APMから新しいルールを設定するには、以下の手順に従ってください。ルールの有効化と適用には違いがあります。有効化/無効化スイッチは、オンオフを切り替えることで、個々のルールのオン/オフに影響します。1つまたは複数のルールを変更したら、ルールセット全体に作用するボタンを使用して変更を保存または破棄します。保存しない限り、変更は適用されません。
Data Configuration、Business Workflow の順に移動します。
新規ルール を選択します。
Select 1 of the following options from the Rule Type menu:
オプション
説明
グローバルタグ
トレースに関連付けられたスパンのグローバルタグの値に基づいてワークフローを定義します。これにより、そのグローバルタグを持つスパンを含むトレースが関連付けられます。
サービス
選択したサービスを含むトレースに基づいてワークフローを定義します。トレースがルールに一致すると、指定したタグ値またはそのサービスのトレースに関連付けられているエンドポイントも表示されます。
Select a Target Global Tag or Target Service according to the Rule Type you selected.
Target Global Tag prompts you to select an indexed global tag. When you select a tag, the rule correlates all traces with the global tag. To create a Business Workflow rule that uses span tags, you have to first index the tag. See Index span tags to create Troubleshooting MetricSets for steps to index a span tag.
Target Service prompts you to select a service and enter the Source of Workflow Name, which is extra metadata to view about the workflow. You can select to correlate traces for a service by an endpoint for the initiating span or a span tag value. To create a Business Workflow rule that uses span tags, you have to first index the tag. See Index span tags to create Troubleshooting MetricSets for steps to index a span tag.
作成 を選択して変更を保存し、ルールを作成します。
ルールのリストを表示して、作成したルールが有効になっていることを確認します。
デフォルトでは、最も新しいルールの優先度が最も高くなります。これは、Splunk APMが他のルールを適用する前に新しいルールを適用するということです。他に先に適用したいルールがある場合は、新しいルールの優先度を調整してください。
変更を保存 を選択し、新しいルールと優先度リストを適用します。
When to use the default rule 🔗
トレースの開始操作が、例えばAPIコールを使ったワークフローのような意味のあるワークフローをキャプチャするのに十分な粒度である場合、デフォルトルールを使うと、他の開始操作とは異なるそのトレースの開始操作によって関連トレースをグループ化するので便利です。
ゲートウェイが存在するなどの理由により、多くのトレースが同じ開始操作を持つシステムでは、その開始操作以外のサービスからビジネスワークフロー名を抽出した方が良いでしょう。この場合、service: endpoint または service name のどちらかをビジネスワークフローに使用することができます。
ルールの動作と制限 🔗
To reduce the likelihood of partial rule changes generating unexpected results, changes to rules accumulate throughout a single computing session and are applied all together when you select Apply Changes. Change encompasses all of the following:
ルールの作成
ルールの編集
ルールの削除または無効化
ビジネスワークフローの設定UIは、ルールがアクティブであるかどうかに関係なく、1から n までの連続した順序で番号付けされたルールを表示します。各トレースは1つのワークフロールールにのみ属するため、優先度が重要になります。複数のルールが同じトレースに適用可能な場合、そのトレースは最も優先度の高いルールに適合させられます。ルールの作成と設定は、以下のプロパティによって支配されます：
ルール数の上限は99です。
ルールの内容に影響を与えることなく、トグルスイッチを使ってルールのオン/オフを切り替えることができます。
UIで上下矢印を使用して、ルールをリスト内で上下に移動すると、他のルールとの相対的なルール優先度が変更されます。リストの先頭にあるルールの優先度が、リストの末尾にあるルールよりも高くなります。
Matched service:endpointの命名規則について、トレースにサービスの複数のエンドポイントが含まれる場合は、最も古いサービスエンドポイントスパンがワークフロー名に使用されます。Tag valueの命名規則について、サービスが、トレース内の複数のスパンで、選択したタグにさまざまな値をもって出現する場合、最も古い出現がワークフロー名に使用されます。