Skip to content

Commit 998d9f4

Browse files
authored
apm-server: Add missing TBS monitoring metrics docs (#4963)
1 parent c8e458a commit 998d9f4

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
@@ -166,31 +166,57 @@ APM Server produces metrics to monitor the performance and estimate the workload
166166

167167
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`.
168168

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

171171
[float]
172172
[[sampling-tail-monitoring-events-processed-ref]]
173173
=== `apm-server.sampling.tail.events.processed`
174174

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

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

179179
[float]
180180
[[sampling-tail-monitoring-events-stored-ref]]
181181
=== `apm-server.sampling.tail.events.stored`
182182

183183
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.
184184

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

187187
[float]
188188
[[sampling-tail-monitoring-events-dropped-ref]]
189189
=== `apm-server.sampling.tail.events.dropped`
190190

191191
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.
192192

193-
This is a counter metric so, should be visualized with `counter_rate`.
193+
This is a counter metric, so it should be visualized with `counter_rate`.
194+
195+
[float]
196+
[[sampling-tail-monitoring-events-failed-writes-ref]]
197+
=== `apm-server.sampling.tail.events.failed_writes`
198+
199+
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.
200+
201+
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}>>.
202+
203+
This is a counter metric, so it should be visualized with `counter_rate`.
204+
205+
[float]
206+
[[sampling-tail-monitoring-events-sampled-ref]]
207+
=== `apm-server.sampling.tail.events.sampled`
208+
209+
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.
210+
211+
This is a counter metric, so it should be visualized with `counter_rate`.
212+
213+
[float]
214+
[[sampling-tail-monitoring-events-head-unsampled-ref]]
215+
=== `apm-server.sampling.tail.events.head_unsampled`
216+
217+
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.
218+
219+
This is a counter metric, so it should be visualized with `counter_rate`.
194220

195221
[float]
196222
[[sampling-tail-monitoring-storage-lsm-size-ref]]

0 commit comments

Comments
 (0)