From e4ff634819248eecf972a762c3d71846f0f814e1 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Wed, 12 Nov 2025 18:38:34 +0000 Subject: [PATCH] apm-server: Add missing TBS monitoring metrics docs --- .../apm/configure/sampling.asciidoc | 34 ++++++++++++++++--- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/docs/en/observability/apm/configure/sampling.asciidoc b/docs/en/observability/apm/configure/sampling.asciidoc index 8fca3b1951..c2ce260d56 100644 --- a/docs/en/observability/apm/configure/sampling.asciidoc +++ b/docs/en/observability/apm/configure/sampling.asciidoc @@ -166,7 +166,7 @@ APM Server produces metrics to monitor the performance and estimate the workload This metric tracks the number of dynamic services that the tail-based sampler is tracking per policy. Dynamic services are created for tail-based sampling policies that are defined without a `service.name`. -This is a counter metric so, should be visualized with `counter_rate`. +This is a counter metric, so it should be visualized with `counter_rate`. [float] [[sampling-tail-monitoring-events-processed-ref]] @@ -174,7 +174,7 @@ This is a counter metric so, should be visualized with `counter_rate`. This metric tracks the total number of events (including both transaction and span) processed by the tail-based sampler. -This is a counter metric so, should be visualized with `counter_rate`. +This is a counter metric, so it should be visualized with `counter_rate`. [float] [[sampling-tail-monitoring-events-stored-ref]] @@ -182,7 +182,7 @@ This is a counter metric so, should be visualized with `counter_rate`. This metric tracks the total number of events stored by the tail-based sampler in the database. Events are stored when the full trace is not yet available to make the sampling decision. This value is directly proportional to the storage required by the tail-based sampler to function. -This is a counter metric so, should be visualized with `counter_rate`. +This is a counter metric, so it should be visualized with `counter_rate`. [float] [[sampling-tail-monitoring-events-dropped-ref]] @@ -190,7 +190,33 @@ This is a counter metric so, should be visualized with `counter_rate`. This metric tracks the total number of events dropped by the tail-based sampler. Only the events that are actually dropped by the tail-based sampler are reported as dropped. Additionally, any events that were stored by the processor but never indexed will not be counted by this metric. -This is a counter metric so, should be visualized with `counter_rate`. +This is a counter metric, so it should be visualized with `counter_rate`. + +[float] +[[sampling-tail-monitoring-events-failed-writes-ref]] +=== `apm-server.sampling.tail.events.failed_writes` + +This metric tracks the total number of events that failed to be written to the tail-based sampling storage. Failed writes typically occur when the storage limit is reached or when there are issues with the local sampling database. + +The value of this metric should be 0 if tail-based sampling is functioning properly. If it is consistently increasing, check for misconfigured <>. + +This is a counter metric, so it should be visualized with `counter_rate`. + +[float] +[[sampling-tail-monitoring-events-sampled-ref]] +=== `apm-server.sampling.tail.events.sampled` + +This metric tracks the total number of events that were sampled (kept) by the tail-based sampler after applying the configured policies and were selected for indexing. This includes all events that belong to traces that matched tail-based sampling policies. + +This is a counter metric, so it should be visualized with `counter_rate`. + +[float] +[[sampling-tail-monitoring-events-head-unsampled-ref]] +=== `apm-server.sampling.tail.events.head_unsampled` + +This metric tracks the total number of events that were already unsampled by head-based sampling before reaching the tail-based sampler. These events are processed by the tail-based sampler but are not stored or indexed because they were already filtered out by head-based sampling decisions. + +This is a counter metric, so it should be visualized with `counter_rate`. [float] [[sampling-tail-monitoring-storage-lsm-size-ref]]