You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: apm/span-tags/metricsets.rst
+73-20Lines changed: 73 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,35 +14,82 @@ MetricSets are key performance indicators, like request rate, error rate, and re
14
14
Monitoring MetricSets
15
15
=====================
16
16
17
-
Monitoring MetricSets (MMS) are metric time series (MTS) that power the real-time monitoring capabilities in Splunk APM, including charts and dashboards. MMS power the APM landing page and the dashboard view. MMS are also the metrics that detectors monitor to generate alerts.
17
+
Monitoring MetricSets (MMS) are metric time series (MTS) that power the monitoring capabilities in Splunk APM, including charts and dashboards. MMS power the APM landing page and the dashboard view. MMS are also the metrics that detectors monitor to generate alerts.
18
18
19
19
MMS are available for a specific endpoint or for the aggregate of all endpoints in a service.
20
20
21
-
Endpoint-level MMS reflect the activity of a single endpoint in a service, while service-level MMS aggregate the activity of all of the endpoints in the service. MMS are limited to spans where the ``span.kind`` has a value of ``SERVER`` or ``CONSUMER``.
21
+
Endpoint-level MMS reflect the activity of a single endpoint in a service, while service-level MMS aggregate the activity of all of the endpoints in the service. MMS are created for spans where the ``span.kind`` has a value of ``SERVER`` or ``CONSUMER``.
22
22
23
23
Spans might lack a ``kind`` value, or have a different ``kind`` value, in the following situations:
24
24
25
25
* The span originates in self-initiating operations or inferred services
26
26
* An error in instrumentation occurs.
27
27
28
-
In addition to the following default MMS, you can create custom MMS. See :ref:`cmms`.
29
-
30
28
.. _default-mms:
31
29
32
30
Available default MMS metrics and dimensions
33
31
-----------------------------------------------
34
32
35
-
MMS are available for the following APM components:
33
+
MMS are available for the APM components listed in the following table. Each MMS also has a set of dimensions you can use to monitor and alert on service performance. In addition to the following default MMS, you can create custom MMS to deep dive on your MMS. See :ref:`cmms`.
34
+
35
+
.. _service-mms:
36
+
.. _inferred-service-mms-dimensions:
36
37
37
-
- service.request
38
-
- spans
39
-
- inferred.services
40
-
- traces
41
-
- workflows (Workflow metrics are created by default when you create a Business Workflow. Custom MMS are not available for Business Workflows.)
42
38
43
-
Monitoring MetricSets in APM are generated as histogram metrics. Previously, MMS were classified as either a counter or gauge metric type. Histogram metrics represent a distribution of measurements or metrics, with complete percentile data available. Data is distributed into equally sized intervals, allowing you to compute percentiles across multiple services, and aggregate datapoints from multiple metric time series. Histogram metrics provide an advantage over other metric types when calculating percentiles, such as the p90 percentile for a single MTS. See more in :ref:`metric-types`.
39
+
.. list-table::
40
+
:widths: 33 33 33
41
+
:width: 100
42
+
:header-rows: 1
44
43
45
-
For each metric, there is 1 metric time series (MTS) with responses ``sf_error: true`` or ``sf_error: false``.
44
+
* - Metric name
45
+
- Dimensions
46
+
- Custom dimension available? (Yes/No)
47
+
* - ``service.request`` - the requests to endpoints in a service
48
+
- * ``sf_environment``
49
+
* ``deployment.environment`` - This dimension is only available for histogram MMS.
50
+
* ``sf_service``
51
+
* ``service.name`` - This dimension is only available for histogram MMS.
52
+
* ``sf_error``
53
+
- Yes
54
+
* - ``inferred.services`` -
55
+
- * ``sf_service``
56
+
* ``service.name`` - This dimension is only available for histogram MMS.
57
+
* ``sf_environment``
58
+
* ``deployment.environment`` - This dimension is only available for histogram MMS.
59
+
* ``sf_error``
60
+
* ``sf.kind``
61
+
* ``sf_operation``
62
+
* ``sf_httpMethod``
63
+
- No
64
+
* - ``spans`` - the count of spans (a single operation)
65
+
- * ``sf_environment``
66
+
* ``deployment.environment`` - This dimension is only available for histogram MMS.
67
+
* ``sf_service``
68
+
* ``service.name`` - This dimension is only available for histogram MMS.
69
+
* ``sf_operation``
70
+
* ``sf_kind``
71
+
* ``sf_error``
72
+
* ``sf_httpMethod``, where relevant
73
+
- Yes
74
+
* - ``traces`` - the count of traces (collection of spans that represents a transaction)
75
+
- * ``sf_environment``
76
+
* ``deployment.environment`` - This dimension is only available for histogram MMS.
77
+
* ``sf_service``
78
+
* ``service.name`` - This dimension is only available for histogram MMS.
79
+
* ``sf_operation``
80
+
* ``sf_httpMethod``
81
+
* ``sf_error``
82
+
- No
83
+
* - ``workflows`` - created by default when you create a business workflow
84
+
- * ``sf_environment``
85
+
* ``deployment.environment`` - This dimension is only available for histogram MMS.
86
+
* ``sf_workflow``
87
+
* ``sf_error``
88
+
- No
89
+
90
+
Monitoring MetricSets in APM are generated as histogram metrics. Histogram metrics represent a distribution of measurements or metrics, with complete percentile data available. Data is distributed into equally sized intervals, allowing you to compute percentiles across multiple services, and aggregate datapoints from multiple metric time series. Histogram metrics provide an advantage over other metric types when calculating percentiles, such as the p90 percentile for a single MTS. See more in :ref:`metric-types`. For histogram MMS, there is a single metric for each component.
91
+
92
+
Previously, MMS were classified as either a counter or gauge metric type. The previous MMS included 6 metrics for each component.
46
93
47
94
.. list-table::
48
95
:widths: 33 33 33
@@ -72,7 +119,7 @@ For each metric, there is 1 metric time series (MTS) with responses ``sf_error:
72
119
- ``<component>.duration.ns.p99``
73
120
74
121
75
-
Example histogram metrics in APM
122
+
Example metrics in APM
76
123
---------------------------------------------
77
124
78
125
A histogram MTS uses the following syntax using SignalFlow:
@@ -90,22 +137,26 @@ The following table displays example SignalFlow functions:
- ``filter_ = filter('sf_environment', 'us1') and filter('sf_service', 'apm-api-peanuts') and filter('sf_operation', 'POST /api/autosuggest/tagvalues') and filter('sf_httpMethod', 'POST') and filter('sf_error', 'false') A = data('spans.duration.ns.p90', filter=filter_, rollup='sum').publish(label='A')``
100
-
- ``filter_ = filter('sf_environment', 'us1') and filter('sf_service', 'apm-api-peanuts') and filter('sf_operation', 'POST /api/autosuggest/tagvalues') and filter('sf_httpMethod', 'POST') and filter('sf_error', 'false') A = histogram('spans', filter=filter_).percentile(pct=90).publish(label='A')``
146
+
- ``filter_ = filter('sf_environment', 'environment1') and filter('sf_service', 'service 1') and filter('sf_operation', 'operation1') and filter('sf_httpMethod', 'POST') and filter('sf_error', 'false') A = data('spans.duration.ns.p90', filter=filter_, rollup='sum').publish(label='A')``
147
+
- ``filter_ = filter('sf_environment', 'us1') and filter('sf_service', 'service1') and filter('sf_operation', 'POST /api/autosuggest/tagvalues') and filter('sf_httpMethod', 'POST') and filter('sf_error', 'false') A = data('spans.duration.ns.p90', filter=filter_, rollup='sum').publish(label='A')``
.. note:: Because an aggregation is applied on histogram(), to display all of the metric sets separately, each dimension needs to be applied as a groupby.
106
153
154
+
Dimensions
155
+
=====================
107
156
Each MMS has a set of dimensions you can use to monitor and alert on service performance.
108
157
158
+
In addition to the following default MMS, you can create custom MMS to deep dive on your MMS. See :ref:`cmms`.
159
+
109
160
.. _service-mms:
110
161
111
162
Service dimensions
@@ -128,6 +179,8 @@ Inferred service dimensions
128
179
* ``deployment.environment`` - This dimension is only available for histogram MMS.
0 commit comments