From 086ca90b24f71650d29331932db72e4aa4731116 Mon Sep 17 00:00:00 2001 From: Callum Styan Date: Wed, 1 Dec 2021 01:30:08 -0800 Subject: [PATCH] Update exemplar docs based on changes to exemplar storage configuration (#9868) * Update exemplar docs based on changes from #8974 Signed-off-by: Callum Styan * Fix missing code block closing + unindent one level. Signed-off-by: Callum Styan --- docs/configuration/configuration.md | 13 +++++++++++++ docs/feature_flags.md | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md index 95fc0ff8d..d8aa34736 100644 --- a/docs/configuration/configuration.md +++ b/docs/configuration/configuration.md @@ -95,6 +95,10 @@ remote_write: # Settings related to the remote read feature. remote_read: [ - ... ] + +# Storage related settings that are runtime reloadable. +storage: + [ - ... ] ``` ### `` @@ -2839,3 +2843,12 @@ tls_config: There is a list of [integrations](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage) with this feature. + +### `` + +Note that exemplar storage is still considered experimental and must be enabled via `--enable-feature=exemplar-storage`. + +```yaml +# Configures the maximum size of the circular buffer used to store exemplars for all series. Resizable during runtime. +[ max_exemplars: | default = 100000 ] +``` \ No newline at end of file diff --git a/docs/feature_flags.md b/docs/feature_flags.md index e5683c8ab..c175e6198 100644 --- a/docs/feature_flags.md +++ b/docs/feature_flags.md @@ -52,7 +52,7 @@ The remote write receiver allows Prometheus to accept remote write requests from [OpenMetrics](https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#exemplars) introduces the ability for scrape targets to add exemplars to certain metrics. Exemplars are references to data outside of the MetricSet. A common use case are IDs of program traces. -Exemplar storage is implemented as a fixed size circular buffer that stores exemplars in memory for all series. Enabling this feature will enable the storage of exemplars scraped by Prometheus. The flag `storage.exemplars.exemplars-limit` can be used to control the size of circular buffer by # of exemplars. An exemplar with just a `traceID=` uses roughly 100 bytes of memory via the in-memory exemplar storage. If the exemplar storage is enabled, we will also append the exemplars to WAL for local persistence (for WAL duration). +Exemplar storage is implemented as a fixed size circular buffer that stores exemplars in memory for all series. Enabling this feature will enable the storage of exemplars scraped by Prometheus. The config file block [storage](configuration/configuration.md#configuration-file)/[exemplars](configuration/configuration.md#exemplars) can be used to control the size of circular buffer by # of exemplars. An exemplar with just a `traceID=` uses roughly 100 bytes of memory via the in-memory exemplar storage. If the exemplar storage is enabled, we will also append the exemplars to WAL for local persistence (for WAL duration). ## Memory snapshot on shutdown