Skip to content
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

docs: add info about remotewrite client config in ruler #14401

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nickandreev
Copy link

@nickandreev nickandreev commented Oct 6, 2024

What this PR does / why we need it:
When setting up a remote write client for recording rules, I found it unclear what RemoteWriteConfig referred to. After checking the code, I realised it was actually a Prometheus remote write configuration. Adding this clarification in the documentation will make it easier for others to understand the setup without needing to dive into the code.

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.

@CLAassistant
Copy link

CLAassistant commented Oct 6, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Oct 6, 2024
@nickandreev nickandreev marked this pull request as ready for review October 6, 2024 11:37
@nickandreev nickandreev requested a review from a team as a code owner October 6, 2024 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/S type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants