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(alert): clarify remote rule evaluation #14481

Merged

Conversation

LukoJy3D
Copy link
Contributor

What this PR does / why we need it:

When scrolling alerting documentation, ruler remote evaluation is not mentioned, and for me, it solved many issues, so it would be great to have it in alerting docs.

Which issue(s) this PR fixes:
Fixes #14441

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • 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.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@LukoJy3D LukoJy3D requested a review from a team as a code owner October 12, 2024 09:45
@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 12, 2024
@LukoJy3D LukoJy3D force-pushed the docs/improve_remote_rule_evaluation_docs branch 2 times, most recently from 478ff18 to 7c14df9 Compare October 12, 2024 10:21
@pull-request-size pull-request-size bot added size/M and removed size/L labels Oct 12, 2024
@LukoJy3D LukoJy3D changed the title docs(alert): clarify remote rule evalutaion docs(alert): clarify remote rule evaluation Oct 14, 2024
@LukoJy3D LukoJy3D force-pushed the docs/improve_remote_rule_evaluation_docs branch from 7c14df9 to 65c1f00 Compare October 14, 2024 13:48
@LukoJy3D LukoJy3D force-pushed the docs/improve_remote_rule_evaluation_docs branch 6 times, most recently from c8be8c8 to 657bb1f Compare November 5, 2024 11:10
@LukoJy3D LukoJy3D force-pushed the docs/improve_remote_rule_evaluation_docs branch from 657bb1f to eadb50c Compare November 5, 2024 11:39
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] LGTM, thanks for taking the time to update the docs.

@JStickler JStickler merged commit d63fbed into grafana:main Nov 5, 2024
60 checks passed
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Nov 5, 2024

The backport to release-3.0.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14481-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x d63fbeddff238bffdf0abd8866a582049ea37058

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-14481-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 14481 --json body --template 'Backport d63fbeddff238bffdf0abd8866a582049ea37058 from #14481{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs(alert): clarify remote rule evaluation (backport release-3.0.x)' --body-file - --label 'size/M' --label 'type/docs' --label 'backport' --base release-3.0.x --milestone release-3.0.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-14481-to-release-3.0.x

# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-14481-to-release-3.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-14481-to-release-3.0.x

loki-gh-app bot pushed a commit that referenced this pull request Nov 5, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit d63fbed)
loki-gh-app bot pushed a commit that referenced this pull request Nov 5, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit d63fbed)
JStickler pushed a commit that referenced this pull request Nov 5, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit d63fbed)
JStickler added a commit that referenced this pull request Nov 5, 2024
Co-authored-by: Lukas Juozas Janusaitis <74900682+LukoJy3D@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x backport-failed size/M 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.

Ruler evaluation producing status 500 errors and inconsistent alerts
2 participants