Skip to content

Commit 0930b29

Browse files
carsonipmergify[bot]
authored andcommitted
apm-server: Add missing TBS monitoring metrics docs (#4963)
(cherry picked from commit 998d9f4)
1 parent 6e13c42 commit 0930b29

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

docs/en/observability/apm/configure/sampling.asciidoc

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,31 +140,57 @@ APM Server produces metrics to monitor the performance and estimate the workload
140140

141141
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`.
142142

143-
This is a counter metric so, should be visualized with `counter_rate`.
143+
This is a counter metric, so it should be visualized with `counter_rate`.
144144

145145
[float]
146146
[[sampling-tail-monitoring-events-processed-ref]]
147147
=== `apm-server.sampling.tail.events.processed`
148148

149149
This metric tracks the total number of events (including both transaction and span) processed by the tail-based sampler.
150150

151-
This is a counter metric so, should be visualized with `counter_rate`.
151+
This is a counter metric, so it should be visualized with `counter_rate`.
152152

153153
[float]
154154
[[sampling-tail-monitoring-events-stored-ref]]
155155
=== `apm-server.sampling.tail.events.stored`
156156

157157
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.
158158

159-
This is a counter metric so, should be visualized with `counter_rate`.
159+
This is a counter metric, so it should be visualized with `counter_rate`.
160160

161161
[float]
162162
[[sampling-tail-monitoring-events-dropped-ref]]
163163
=== `apm-server.sampling.tail.events.dropped`
164164

165165
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.
166166

167-
This is a counter metric so, should be visualized with `counter_rate`.
167+
This is a counter metric, so it should be visualized with `counter_rate`.
168+
169+
[float]
170+
[[sampling-tail-monitoring-events-failed-writes-ref]]
171+
=== `apm-server.sampling.tail.events.failed_writes`
172+
173+
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.
174+
175+
The value of this metric should be 0 if tail-based sampling is functioning properly. If it is consistently increasing, check for misconfigured <<sampling-tail-storage_limit-{input-type}>>.
176+
177+
This is a counter metric, so it should be visualized with `counter_rate`.
178+
179+
[float]
180+
[[sampling-tail-monitoring-events-sampled-ref]]
181+
=== `apm-server.sampling.tail.events.sampled`
182+
183+
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.
184+
185+
This is a counter metric, so it should be visualized with `counter_rate`.
186+
187+
[float]
188+
[[sampling-tail-monitoring-events-head-unsampled-ref]]
189+
=== `apm-server.sampling.tail.events.head_unsampled`
190+
191+
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.
192+
193+
This is a counter metric, so it should be visualized with `counter_rate`.
168194

169195
[float]
170196
[[sampling-tail-monitoring-storage-lsm-size-ref]]

0 commit comments

Comments
 (0)