Skip to content

Commit

Permalink
docs: Add clarifications for ruler remote write config options
Browse files Browse the repository at this point in the history
  • Loading branch information
avanish-vaghela committed Nov 27, 2024
1 parent 008e2cb commit c424310
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/sources/shared/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4915,6 +4915,8 @@ remote_write:
# Configure remote write clients. A map with remote client id as key. For
# details, see
# https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write
# Specifying a header with key 'X-Scope-OrgID' under the 'headers' section of RemoteWriteConfig
# is not permitted. If specified, it will be dropped during config parsing.
[clients: <map of string to RemoteWriteConfig>]
# Enable remote-write functionality.
Expand All @@ -4927,7 +4929,8 @@ remote_write:
# CLI flag: -ruler.remote-write.config-refresh-period
[config_refresh_period: <duration> | default = 10s]
# Add X-Scope-OrgID header in remote write requests.
# Add an X-Scope-OrgID header in remote write requests with the tenant ID
# of a Loki tenant that the recording rules are part of.
# CLI flag: -ruler.remote-write.add-org-id-header
[add_org_id_header: <boolean> | default = true]
Expand Down

0 comments on commit c424310

Please sign in to comment.