Metrics reference¶
TrackMe writes numeric KPIs to its metrics index (default trackme_metrics), all
under the trackme.* namespace. There are two kinds:
Metrics TrackMe controls — a fixed catalogue it emits for every entity and tracker: the SLA state, the feed KPIs (delay, latency, volume…), workload counters, and operational health. These are documented below.
Metrics you define — for Flex and FQM, the metric names come from your tracker’s SPL, so there is no fixed list (see below).
Tip
The authoritative list for your deployment is always live in Splunk. List every metric name with:
| mcatalog values(metric_name) WHERE index=trackme_metrics
The tables below name the metrics as of current TrackMe; treat mcatalog as the source
of truth if a name differs in your version.
Common to all components¶
One metric is emitted for every entity, regardless of component — it is the backbone of SLA reporting:
Metric |
Meaning |
Unit |
|---|---|---|
|
The entity’s health state expressed as a number (the green / orange / red / blue state, including ack), one sample per entity per cycle. This is what SLA dashboards integrate over time. |
state code |
Operational / system-level¶
These describe how TrackMe itself is running — the health and runtime of its trackers, and the scoring pipeline. They are per tracker / per entity rather than per data feed.
Metric |
Meaning |
Unit |
|---|---|---|
|
Execution run time of a tracker / report — how long a hybrid tracker (or any component tracker) took on its last run. |
seconds |
|
Last execution status of a tracker — |
status code |
|
The computed score sample for an entity. |
score |
|
Durable record of impact-score adjustments (false-positive and manual increase / decrease). Leaves are the numeric keys of the adjustment record. |
score |
The components_register metrics are the ones to watch for tracker performance — for
example, average hybrid-tracker runtime per tenant — and feed the Performance Deepdive
dashboards.
Feed KPIs — DSM, DHM, MHM¶
The data-flow components share a single family, trackme.splk.feeds.*, emitted by their
hybrid trackers. These are the delay, latency, and volume KPIs behind the entities table and
the entity overview charts. The object_category dimension (splk-dsm / splk-dhm /
splk-mhm) tells you which component a sample belongs to.
Metric |
Meaning |
Unit |
|---|---|---|
|
Delay — seconds since the most recent event (now − last event time). |
seconds |
|
Latency — seconds between an event’s time and its index time. |
seconds |
|
Event count over the tracker window. |
count |
|
Distinct host count over the tracker window. |
count |
|
Average events per 5-minute bucket. |
count |
|
Latest 5-minute event count. |
count |
|
95th-percentile 5-minute event count. |
count |
|
Standard deviation of the 5-minute event count. |
count |
|
Average ingestion latency per 5 minutes. |
seconds |
|
Latest 5-minute latency. |
seconds |
|
95th-percentile 5-minute latency. |
seconds |
|
Standard deviation of the 5-minute latency. |
seconds |
|
Average distinct host count per 5 minutes. |
count |
|
Latest 5-minute distinct host count. |
count |
|
95th-percentile 5-minute distinct host count. |
count |
|
Standard deviation of the 5-minute distinct host count. |
count |
|
Global distinct host count for the entity. |
count |
Note
Not every component emits every leaf. DSM emits the full set above. DHM emits
a subset — the event-count, latency, eventcount_4h, and the two lag metrics — but
not the distinct-host-count metrics. MHM rides the same family for the lag /
availability metrics (notably lag_event_sec).
Component-specific metrics¶
On top of the shared feed KPIs, each data component emits a small set under its own root
(note the underscore — trackme.splk_dsm etc., distinct from the dotted
trackme.splk.feeds):
Metric |
Meaning |
Unit |
|---|---|---|
|
DSM data sampling — % of sampled events matching a format model (per |
percent |
|
DSM data sampling — events matched by the model. |
count |
|
DSM data sampling — events parsed. |
count |
|
DSM data-sampling run time. |
seconds |
|
DHM — last event count for the host, per index / sourcetype. |
count |
|
DHM — last ingestion lag. |
seconds |
|
DHM — last event lag (delay). |
seconds |
|
MHM — last lag of the monitored metric series, per |
seconds |
Workload (WLK)¶
Workload monitoring emits a fixed set of scheduled-search execution KPIs under
trackme.splk.wlk.* (object_category=splk-wlk):
Metric |
Meaning |
Unit |
|---|---|---|
|
Scheduled-search executions. |
count |
|
Executions that completed. |
count |
|
Skipped executions. |
count |
|
Errored executions. |
count |
|
Search run time. |
seconds |
|
Events scanned. |
count |
|
CPU usage. |
percent |
|
Memory usage. |
percent |
|
Splunk Cloud SVC consumption. |
SVC |
|
ES notable events produced (where applicable). |
count |
|
Last status of the scheduled search. |
status code |
Flex and FQM — your own metrics¶
Flex and FQM are different: you
decide the metrics. Whatever numeric keys your tracker’s SPL puts in its metrics JSON
become metrics, one per key:
Flex →
trackme.splk.flx.<your_metric_key>FQM →
trackme.splk.fqm.<your_field_metric>(field-quality results land under thetrackme.splk.fqm.fields_quality.*sub-family, e.g.percent_success).
So there is no fixed catalogue for these — list what a given tracker produces with
mcatalog filtered by object_id. A few leaves are reserved (TrackMe’s own, not
your data): trackme.splk.flx.status, and for converging trackers
trackme.splk.flx.count_entities_up / count_entities_down; likewise
trackme.splk.fqm.status.
Note
There is no trackme.splk.cim.* namespace — CIM compliance tracking is built on
Flex, so its KPIs are emitted as trackme.splk.flx.* from the CIM tracker’s SPL.
Dimensions and how to query¶
Every metric carries identifying dimensions — most commonly tenant_id, object,
object_id, and object_category (the component), plus alias and priority on
the SLA metric, component / tracker on the operational metrics, model_name on
DSM sampling, idx / st on DHM, and metric_category on MHM. The value itself is
in _value.
# List every metric name in the index
| mcatalog values(metric_name) WHERE index=trackme_metrics
# See the dimensions carried by a metric
| mcatalog values(_dims) WHERE index=trackme_metrics metric_name="trackme.splk.feeds.lag_event_sec"
# Preview raw data points
| mpreview index=trackme_metrics filter="metric_name=trackme.sla.object_state" earliest=-1h
# Aggregate — average DSM latency per entity over 5-minute spans
| mstats avg(trackme.splk.feeds.avg_latency_5m) AS avg_latency
WHERE index=trackme_metrics object_category="splk-dsm" BY object span=5m
See also
Events & sourcetypes — the event sourcetypes and indexes.
Impact scoring & thresholds — how delay, latency, and thresholds drive the score.
SLA policies — SLA reporting built on
trackme.sla.object_state.