Create a Monitoring MetricSet with a custom dimension 🔗
Create Monitoring MetricSets (MMS) with custom dimensions to monitor your services in real time. Splunk APM provides a default set of MMS, but you can configure additional MMS using indexed span tags to create custom dimensions. Use your custom MMS to create custom charts, dashboards, and detectors to track what matters most to your team. See カスタムディメンションのチャート、ダッシュボード、アラートの設定.
MetricSetsとは 🔗
MetricSets are metric time series (MTS) you can use to track the performance of specific metrics over time. To help you analyze your service performance, APM provides 2 categories of MetricSets: Troubleshooting MetricSets (TMS) and Monitoring MetricSets (MMS). Use Troubleshooting MetricSets for high-cardinality troubleshooting. Use Monitoring MetricSets for real-time monitoring and alerting.
APM provides a collection of MetricSets by default. You can also index additional span tags or processes to create additional TMS and, as part of the indexing process, you can opt to create custom dimensionalized Monitoring MetricSets (MMS). See APMのMetricSetsについて for an overview of the types of MetricSets in APM and a list of the MetricSets available by default.
Use this topic to learn how to index a span tag or process to create Monitoring MetricSets. See Index span tags to create Troubleshooting MetricSets to learn how to create Troubleshooting MetricSets.
前提条件 🔗
To create a custom MMS, you must have an admin role.
To create a custom MMS, you need to index the span tag or process that you want to base your MMS on. See Index span tags to create Troubleshooting MetricSets.
If you are unfamiliar with MetricSets, see APMのMetricSetsについて.
(オプション)MetricSetsの基礎となる概念の概要については、メタデータ:ディメンション、カスタムプロパティ、タグ、属性 を参照してください。
Use custom Monitoring MetricSets to monitor important metrics 🔗
In addition to the MMS APM creates by default, you can create additional MMS with custom dimensions to filter and aggregate the default created metrics by a specific indexed span tag or process such as version
or cloud.provider
.
You can create custom MMS at the service level and the endpoint or span level. When you create a custom dimension for a service-level MMS, APM creates an MMS that includes the service-level metrics with your chosen indexed span tag or process as a custom dimension. If you add endpoint-level metrics, APM creates MMS that include span-level metrics, with your chosen indexed span tag or process as a custom dimension.
When you create an MMS with a custom dimension, you can use the custom dimension to create charts, dashboards, and alerts. See カスタムディメンションのチャート、ダッシュボード、アラートの設定.
カスタムMMSの具体的なシナリオについては、シナリオ:Kaiが、ある顧客グループ向けのサービスのレイテンシのディテクターを監視する を参照してください。
Create a Monitoring MetricSet with a custom dimension for an instrumented service 🔗
Before you create an MMS, first consider:
MMSを最も効率的にするために、データのカーディナリティをどのように割り当てる必要があるか。
組織のカーディナリティ制限。全体的なカーディナリティを最適化するためのMetricSet構成の編集に関するガイダンスは、Monitoring MetricSetsでのカーディナリティのトラブルシューティング を参照してください。
Monitoring MetricSetsの必要な構成方法を選択する 🔗
You can create a Monitoring MetricSet in 3 ways:
サービスレベルのMMSのみ
特定のサービス内の特定のエンドポイントに対するエンドポイントレベルのMMS
サービス内のすべてのエンドポイントに対して、サービスレベルのMMSとエンドポイントレベルのMMSの両方を適応させる
Select the best option for your needs to allocate your organization’s cardinality entitlement efficiently. See Configure your MMS to be more efficient to learn more.
You can also filter by specific tag values to further reduce the cardinality of your MMS.
オプション |
ガイダンス |
---|---|
サービスレベルMMSとサービス内のすべてのエンドポイントのエンドポイントレベルMMS |
このオプションは、選択した各サービスのカスタムディメンションMMSと、選択した各サービスの各エンドポイントのMMSを作成します。これは最もカーディナリティが高いオプションです。 |
サービスレベルMMSと特定のエンドポイントのエンドポイントレベルMMS |
This option creates a custom dimensionalized MMS for each selected service and an MMS for specific endpoints you select. In the box labeled Endpoint Filters, provide a list of endpoints or a regular expression pattern to create MMS for specific endpoints you’re interested in. This helps you to minimize unnecessary cardinality. |
サービスレベルのMMSのみ |
このオプションは、選択した各サービスのMMSを作成し、エンドポイントレベルのMMSは作成しません。これは最もカーディナリティが低いオプションです。 |
Monitoring MetricSetsのスコープ 🔗
You can create custom MMS for endpoints (metrics starting with span*
) and services (metrics starting with service.request.*
), but not for workflows (metrics starting with workflow*
) or traces (metrics starting with trace*
) at this time. Custom MMS aren’t supported for global tags. See Available default MMS metrics and dimensions.
Monitoring MetricSetを追加する 🔗
Follow these steps to create a Monitoring MetricSet for an instrumented service:
APM MetricSets ページには、以下のいずれかの方法で移動します:
Splunk APMで、APM Configuration を選択し、メニューから APM MetricSets を選択する。APM MetricSetsページが開きます。
Splunk Observability Cloudの任意の場所から、ナビゲーションバーで Settings を選択し、Data Configuration の下にある APM MetricSets を選択する。
On the APM MetricSets page, you have 2 options:
スパンタグまたはプロセスを既にインデックス化している場合、そのスパンタグはMetricSetsのリストに表示され、既にTroubleshooting MetricSetsを生成しています。そのスパンタグの編集アイコンを選択して、Edit MetricSet ダイアログボックスを開き、以下の手順でMonitoring MetricSetを構成に追加します。
タグまたはプロセスをまだインデックス化していない場合は、新規MetricSet を選択します。インデックス化したいスパンタグまたはプロセスの 名前 を入力します。次に、以下の手順で続行します。
スコープ は、APMがスパンタグやプロセスをトレース内のサービスとどのように関連付けるかを決定します。Service フィールドに、Monitoring MetricSetを作成するサービス(1つまたは複数)を入力します。カスタムディメンションMMSは、サービスレベルのインデックス付きスパンタグに対してのみ作成できます。グローバルにインデックス化されたスパンタグに対してカスタムMMSを作成することはできません。
Add MetricSet または Edit MetricSet ダイアログボックスで、Monitoring MetricSetも作成する のチェックボックスにチェックを入れます。
- ドロップダウンから、タグまたはプロセスのデータをMonitoring MetricSetに追加する方法を選択します。詳細は Monitoring MetricSetsの必要な構成方法を選択する を参照してください。
Service and all endpoint MMS: 選択した各サービスのMMSと、選択した各サービスの各エンドポイントのMMSを作成します。
Service and specific endpoint MMS: Create an MMS for each selected service and an MMS for specific endpoints you select. To add Endpoint Filters, provide a list of endpoints or a regular expression pattern to create MMS for specific endpoints you’re interested in.
Service MMS only: 選択した各サービスのMMSを作成し、エンドポイントレベルのMMSは作成しません。
(オプション) Filter by tag values というラベルの付いたフィールドで、タグフィルターを追加して、入力したタグ値に関連するデータのみを含むようにMMSの範囲を絞り込みます。これにより、MetricSetsのカーディナリティをさらに減らすことができます。
分析の開始 を選択して設定を送信します。Splunk APMがスパンタグまたはプロセスの分析を実行し、このMetricSetの潜在的なカーディナリティ寄与度を計算し、それがエンタイトルメントの制限内におさまるどうかを判断します。
Your new MetricSet shows under Pending MetricSets section of the table with an Analyzing status while the cardinality check runs. You might have to wait a few moments for the check to run.
注意
Your pending MetricSet expires after 1 hour. If your MetricSet times out before you activate it, run the analysis again.
After the cardinality check has run, review the cardinality and activate your new MetricSet.
If the cardinality impact of indexing this new MetricSet is within your subscription limit you see a green check mark and 「Within Entitlement.」 Select the check mark under Actions to activate your Monitoring MetricSet.
If the check times out before you activate the MetricSet, run the analysis again.
If the check shows as failed, your cardinality is over your subscription limit for MMS or is otherwise invalid. See インデックス付きスパンタグおよびプロセスのカーディナリティ寄与度. For steps to configure your MetricSet to be more efficient or other troubleshooting solutions, see Monitoring MetricSetsでのカーディナリティのトラブルシューティング.
注釈
For standard MMS Splunk APM replaces dots with underscores in dimension names for MMS time series. For histogram MMS underscores are preserved.
Create a Monitoring MetricSet with a custom dimension for an inferred service 🔗
注釈
Only 3rd-party or uninstrumented HTTP services are supported for MMS.
Follow these steps to create a Monitoring MetricSet for an inferred service:
APM MetricSets ページには、以下のいずれかの方法で移動します:
Splunk APMで、APM Configuration を選択し、メニューから APM MetricSets を選択する。APM MetricSetsページが開きます。
Splunk Observability Cloudの任意の場所から、ナビゲーションバーで Settings を選択し、Data Configuration の下にある APM MetricSets を選択する。
On the APM MetricSets page, scroll to the Inferred Service Monitoring MetricSets section and select Add Inferred Service MMS.
Select the inferred service for which you want to create a Monitoring MetricSet.
Select Save.
Your new MetricSet shows under Pending MetricSets section of the table with an Analyzing status while the cardinality check runs. You might have to wait a few moments for the check to run.
注意
Your pending MetricSet expires after 1 hour. If your MetricSet times out before you activate it, run the analysis again.
After the cardinality check has run, review the cardinality and activate your new MetricSet.
If the cardinality impact of indexing this new MetricSet is within your subscription limit you see a green check mark and 「Within Entitlement.」 Select the check mark under Actions to activate your Monitoring MetricSet.
If the check times out before you activate the MetricSet, run the analysis again.
If the check shows as failed, your cardinality is over your subscription limit for MMS or is otherwise invalid. See インデックス付きスパンタグおよびプロセスのカーディナリティ寄与度.
カスタムディメンションのチャート、ダッシュボード、アラートの設定 🔗
You can create charts, dashboards, and alerts based on your custom Monitoring MetricSet.
To use the custom dimensionalized Monitoring MetricSets you have created, apply the filter sf_dimensionalized:true
. This filters out the metrics created by the default Monitoring MetricSet. To filter your metrics even more, use the new dimension you have created which is the tag name you indexed.
タスク |
ドキュメント |
---|---|
チャートの作成 |
|
ダッシュボードの作成 |
|
アラートの作成 |
|
APMダッシュボードでのサービスの監視 |
Monitoring MetricSetsのメトリクスとディメンション 🔗
各MMSには、サービスパフォーマンスの監視とアラートに使用できる、スパンとトレースのメトリクスとディメンションのセットがあります。
To prevent over counting metrics in aggregations, the built-in dashboards and charts in Splunk APM automatically exclude custom dimensionalized MMS.
Custom dimensionalized MMS have a marker dimension, sf_dimensionalized: true
, to include custom dimensionalized MMS.
ダッシュボードやチャートを作成する際、!sf_dimensionalized: true
でフィルターを追加することで、カスタムディメンションMMSを除外することができます。カスタムディメンションMMSの時系列をチャートで見たい場合は、sf_dimensionalized: true
でフィルタリングしてから、表示したいカスタムディメンションで集計します。