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

[DOC] Update metrics for Alloy troubleshooting doc #4137

Conversation

knylander-grafana
Copy link
Contributor

What this PR does:

Adds information about how to view metrics from Alloy and how to check them in Grafana Cloud using Explore

Which issue(s) this PR fixes:
Fixes https://grafana.com/docs/alloy/latest/troubleshoot/controller_metrics/

Checklist

  • Tests updated
  • Documentation added
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX]

Copy link
Contributor

This PR must be merged before a backport PR will be created.

1 similar comment
Copy link
Contributor

This PR must be merged before a backport PR will be created.

@@ -33,6 +34,24 @@ exporter_sent_spans_ratio_total
exporter_send_failed_spans_ratio_total
```

If you are using Grafana Alloy to send traces to Grafana Cloud, the metrics are visible at
`http://localhost:12345/metrics`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a bit misleading, this endpoint is local and it states Grafana Cloud

Copy link
Member

Choose a reason for hiding this comment

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

This is referring to the metrics emitted by Alloy itself, /metrics is its prometheus scrape endpoint. These should also end up in Grafana Cloud, but in case remote write isn't working yet this is a quick and easy way to check the metrics locally.

I think the bit that might be confusing is If you are using Grafana Alloy since this page is about Alloy already.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good points. I"ll write a suggestion to clarifiy.

Copy link
Member

@yvrhdn yvrhdn left a comment

Choose a reason for hiding this comment

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

With the suggestion this looks good to me 🙂

@knylander-grafana knylander-grafana merged commit 85cc4aa into grafana:main Oct 1, 2024
17 checks passed
@knylander-grafana knylander-grafana deleted the tempo-1135-add-troubleshooting-alloy branch October 1, 2024 17:29
Copy link
Contributor

github-actions bot commented Oct 1, 2024

The backport to release-v2.6 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-4137-to-release-v2.6 origin/release-v2.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 85cc4aaeab8e4fd61d3786466b99edc397cc5c93

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-4137-to-release-v2.6
# Create the PR body template
PR_BODY=$(gh pr view 4137 --json body --template 'Backport 85cc4aaeab8e4fd61d3786466b99edc397cc5c93 from #4137{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release-v2.6] [DOC] Update metrics for Alloy troubleshooting doc' --body-file - --label 'type/docs' --label 'backport' --base release-v2.6 --milestone release-v2.6 --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-4137-to-release-v2.6

# Create a pull request where the `base` branch is `release-v2.6` and the `compare`/`head` branch is `backport-4137-to-release-v2.6`.

# Remove the local backport branch
git switch main
git branch -D backport-4137-to-release-v2.6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-v2.6 backport-failed type/docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants