Skip to content

Commit 2ebbf56

Browse files
committed
apm: Document sampling.tail.discard_on_write_failure config
1 parent cdabbe2 commit 2ebbf56

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

reference/apm/cloud/apm-settings.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ If a setting is not supported by {{ech}}, you will get an error message when you
5353
Some settings that could break your cluster if set incorrectly are blocklisted. The following settings are generally safe in cloud environments. For detailed information about APM settings, check the [APM documentation](/solutions/observability/apm/configure-apm-server.md).
5454
::::
5555

56+
### Version 9.1+ [ec_version_9_1]
57+
58+
`apm-server.sampling.tail.discard_on_write_failure`
59+
: Defines the indexing behavior when trace events fail to be written to storage (e.g. when the storage limit is reached). When set to `false`, traces will be indexed, significantly increasing the indexing load. When set to `true`, traces will be discarded, there will be data loss potentially resulting in broken traces. The default is `false`.
5660

5761
### Version 8.0+ [ec_version_8_0_3]
5862

solutions/observability/apm/configure-apm-server.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,11 @@ If a setting is not supported on {{ecloud}}, you will get an error message when
7777
Some settings that could break your cluster if set incorrectly are blocklisted. The following settings are generally safe in cloud environments. For detailed information about APM settings, check the [APM documentation](/solutions/observability/apm/configure-apm-server.md).
7878
::::
7979

80+
### Version 9.1+ [ec_version_9_1]
81+
82+
`apm-server.sampling.tail.discard_on_write_failure`
83+
: Defines the indexing behavior when trace events fail to be written to storage (e.g. when the storage limit is reached). When set to `false`, traces will be indexed, significantly increasing the indexing load. When set to `true`, traces will be discarded, there will be data loss potentially resulting in broken traces. The default is `false`.
84+
8085
### Version 8.0+ [ec_version_8_0_3]
8186

8287
This stack version removes support for some previously supported settings. These are all of the supported settings for this version:

solutions/observability/apm/tail-based-sampling.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,18 @@ Policies map trace events to a sample rate. Each policy must specify a sample ra
8585
| APM Server binary | `sampling.tail.policies` |
8686
| Fleet-managed | `Policies` |
8787

88+
### Discard On Write Failure [sampling-tail-discard-on-write-failure-ref]
89+
90+
Defines the indexing behavior when trace events fail to be written to storage (e.g. when the storage limit is reached). When set to `false`, traces will be indexed, significantly increasing the indexing load. When set to `true`, traces will be discarded, there will be data loss potentially resulting in broken traces.
91+
92+
Default: `false`. (bool)
93+
94+
| | |
95+
|------------------------------|------------------------------------------|
96+
| APM Server binary | `sampling.tail.discard_on_write_failure` |
97+
| Fleet-managed (version 9.1+) | `Discard On Write Failure` |
98+
99+
88100
### Storage limit [sampling-tail-storage_limit-ref]
89101

90102
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.
@@ -93,7 +105,7 @@ A value of `0GB` (or equivalent) does not set a concrete limit, but rather allow
93105

94106
If this is not desired, a concrete `GB` value can be set for the maximum amount of disk used for tail-based sampling.
95107

96-
If the configured storage limit is insufficient, it logs "configured limit reached". The event will bypass sampling and will always be indexed when storage limit is reached.
108+
If the configured storage limit is insufficient, it logs "configured limit reached". When the storage limit is reached, the event will be indexed or discarded based on the [Discard On Write Failure](#sampling-tail-discard-on-write-failure-ref) configuration.
97109

98110
Default: `0GB`. (text)
99111

0 commit comments

Comments
 (0)