-
Notifications
You must be signed in to change notification settings - Fork 106
apm: Document sampling.tail.discard_on_write_failure config #1453
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
2ebbf56
76fadaa
ad5d6c0
5f874ab
7041c81
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -53,6 +53,11 @@ If a setting is not supported by {{ech}}, you will get an error message when you | |||||||||||
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). | ||||||||||||
:::: | ||||||||||||
|
||||||||||||
### Version 9.1+ [ec_version_9_1] | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For other version sections, we specify that
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 9.1 will have 2 more configs than 9.0. One mentioned here, another in #1269 . I agree that explicitly mentioning these are new configs on top of 9.0 would be useful. On a side note as a heads-up, before we spend too much time polishing this doc, I'm also thinking removing this doc altogether since it isn't providing much value after being moved from cloud to apm: elastic/apm-server#13602 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the review @florent-leborgne. I updated to specify the stack versions adds new configs. |
||||||||||||
This {{stack}} version adds support for the following settings: | ||||||||||||
|
||||||||||||
`apm-server.sampling.tail.discard_on_write_failure` | ||||||||||||
: Defines the indexing behavior when trace events fail to be written to storage (for example, when the storage limit is reached). When set to `false`, traces bypass sampling and are always indexed, which significantly increases the indexing load. When set to `true`, traces are discarded, causing data loss which can result in broken traces. The default is `false`. | ||||||||||||
Comment on lines
+56
to
+60
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Can be removed thanks to elastic/apm-server#13602 |
||||||||||||
|
||||||||||||
### Version 8.0+ [ec_version_8_0_3] | ||||||||||||
|
||||||||||||
|
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -77,6 +77,12 @@ If a setting is not supported on {{ecloud}}, you will get an error message when | |||||||||||
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). | ||||||||||||
:::: | ||||||||||||
|
||||||||||||
### Version 9.1+ [ec_version_9_1] | ||||||||||||
isaacaflores2 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||
This {{stack}} version adds support for the following settings: | ||||||||||||
|
||||||||||||
`apm-server.sampling.tail.discard_on_write_failure` | ||||||||||||
: Defines the indexing behavior when trace events fail to be written to storage (for example, when the storage limit is reached). When set to `false`, traces bypass sampling and are always indexed, which significantly increases the indexing load. When set to `true`, traces are discarded, causing data loss which can result in broken traces. The default is `false`. | ||||||||||||
|
||||||||||||
Comment on lines
+80
to
+85
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Can be removed thanks to elastic/apm-server#13602 |
||||||||||||
### Version 8.0+ [ec_version_8_0_3] | ||||||||||||
|
||||||||||||
This stack version removes support for some previously supported settings. These are all of the supported settings for this version: | ||||||||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -85,6 +85,18 @@ Policies map trace events to a sample rate. Each policy must specify a sample ra | |||||
| APM Server binary | `sampling.tail.policies` | | ||||||
| Fleet-managed | `Policies` | | ||||||
|
||||||
### Discard On Write Failure [sampling-tail-discard-on-write-failure-ref] | ||||||
|
||||||
Defines the indexing behavior when trace events fail to be written to storage (for example, when the storage limit is reached). When set to `false`, traces bypass sampling and are always indexed, which significantly increases the indexing load. When set to `true`, traces are discarded, causing data loss which can result in broken traces. The default is `false`. | ||||||
|
||||||
Default: `false`. (bool) | ||||||
|
||||||
| | | | ||||||
|------------------------------|------------------------------------------| | ||||||
| APM Server binary | `sampling.tail.discard_on_write_failure` | | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Align with #2038 |
||||||
| Fleet-managed (version 9.1+) | `Discard On Write Failure` | | ||||||
|
||||||
|
||||||
### Storage limit [sampling-tail-storage_limit-ref] | ||||||
|
||||||
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 | |||||
|
||||||
If this is not desired, a concrete `GB` value can be set for the maximum amount of disk used for tail-based sampling. | ||||||
|
||||||
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. | ||||||
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. | ||||||
|
||||||
Default: `0GB`. (text) | ||||||
|
||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This config also applies to
8.19+
but I left it out based on @carsonip comment in another PR. Let me know if I should add8.19+
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@florent-leborgne @colleenmcginnis My initial plan was to backport this PR to 8.X branch for the 8.19 release (and change the versions from 9.1 to 8.19). But I just realized 8.19 is being released before 9.1.
Should I create a separate PR for 8.X? Or do you have any other suggestions? Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @isaacaflores2. Thanks for this PR. You would need a different PR anyways for 8.19 docs because:
I am happy to help if you need
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it thanks for sharing. I will start a PR for 8.19 docs in the other repo. I'll reach out on slack for any help