docs: clarify that --es.aliases requires --es.indices or --es.shards - #1236
Open
locker95 wants to merge 1 commit into
Open
docs: clarify that --es.aliases requires --es.indices or --es.shards#1236locker95 wants to merge 1 commit into
locker95 wants to merge 1 commit into
Conversation
The aliases metrics are collected by the Indices collector, which is only registered when --es.indices or --es.shards is enabled. Enabling --es.aliases alone has no effect. Document this in the flag help text and the README flags table. Fixes prometheus-community#1047 Signed-off-by: Dean Chen <862469039@qq.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
--es.aliasesflag looks like an independent toggle, but the alias metrics are emitted by the Indices collector, which is only registered when--es.indicesor--es.shardsis set (if *esExportIndices || *esExportShardsin main.go). Enabling--es.aliaseson its own silently does nothing, and neither--helpnor the README mentions the dependency.This updates the flag help text and the README flags table to state the requirement. No behavior change.
Fixes #1047