Skip to content

Commit c8e458a

Browse files
[apm]: Document sampling.tail.discard_on_write_failure config (#4908)
* [apm]: Document sampling.tail.discard_on_write_failure config * [apm]: Add changes to storage limit behavior based on the Discard On Write Failure config * remove 8.19 version since it is not needed Co-authored-by: Carson Ip <[email protected]> --------- Co-authored-by: Carson Ip <[email protected]>
1 parent 83193bc commit c8e458a

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This final policy is used to catch remaining trace events that don't match a str
6767
=== Storage limit
6868
The amount of storage space allocated for trace events matching tail sampling policies. Caution: Setting this limit higher than the allowed space may cause APM Server to become unhealthy.
6969

70-
If the configured storage limit is insufficient, it logs "configured storage limit reached". The event will bypass sampling and will always be indexed when storage limit is reached.
70+
If the configured storage limit is insufficient, it logs "configured storage limit reached". When the storage limit is reached, the event will be indexed or discarded based on the <<sampling-tail-discard_on_write_failure-{input-type},Discard On Write Failure>> configuration.
7171

7272
Default: `3GB`. (text)
7373

@@ -76,6 +76,20 @@ Default: `3GB`. (text)
7676
| Fleet-managed | `Storage limit`
7777
|====
7878

79+
[float]
80+
[id="sampling-tail-discard_on_write_failure-{input-type}"]
81+
=== Discard On Write Failure
82+
Defines the indexing behavior when trace events fail to be written to storage (for example, when the storage limit is reached).
83+
When set to `false`, traces bypass sampling and are always indexed, which significantly increases the indexing load.
84+
When set to `true`, traces are discarded, causing data loss which can result in broken traces.
85+
86+
Default: `false`. (bool)
87+
88+
|====
89+
| APM Server binary | `sampling.tail.discard_on_write_failure`
90+
| Fleet-managed | `Discard On Write Failure`
91+
|====
92+
7993
[float]
8094
[id="sampling-tail-ttl-{input-type}"]
8195
=== TTL

0 commit comments

Comments
 (0)