doc: Add note about the Alertmanager URL path #4518
Merged
Conversation
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
I believe this can often be a source of confusion during initial configuration because even though the implicit HTTP API prefix set when using `--alertmanager.external-url` is documented, it is non obvious behavior. For example, in cortexproject#3919. Signed-off-by: Jack Baldry <[email protected]>
pracucci
approved these changes
Nov 16, 2021
| RulePath string `yaml:"rule_path"` | ||
|
|
||
| // URL of the Alertmanager to send notifications to. | ||
| // If your are configuring the ruler to send to a Cortex Alertmanager, |
There was a problem hiding this comment.
Nice addition. If you move this to the CLI flag description, than it would be part of the auto-generated config.
There was a problem hiding this comment.
Yea would be nice to have this in auto generated doc. However, it's also nice to have this as inline doc, so I will get this merged and we can work on have it auto generated later on.
alvinlin123
approved these changes
Jan 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I believe this can often be a source of confusion during initial
configuration because even though the implicit HTTP API prefix set
when using
--alertmanager.external-urlis documented, it is nonobvious behavior.
For example, in #3919.
Signed-off-by: Jack Baldry [email protected]
Checklist