-
Notifications
You must be signed in to change notification settings - Fork 583
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 index and java for Alloy #3272
[DOC] Update index and java for Alloy #3272
Conversation
2. Install Grafana Agent | ||
3. Prepare Grafana Agent configuration file | ||
4. Start Grafana Agent | ||
2. Install a collector, either Grafana Alloy (preferred) or Grafana Agent |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same question nere... this spot missed (legacy)
, but I'm thinking both could be dropped once it's stated up at the top of the topic.
We may want to mention, that for alloy, users need extra argument |
Good point. Both There's a note with all Public preview components... documented here: https://grafana.com/docs/alloy/latest/reference/cli/run/#permitted-stability-levels that might be important to link to? |
Would users need to use this flag every time they start Alloy? Is this because Golang pull for Agent/Alloy is considered public preview? |
Users would only need this if they are using components flagged as |
@simonswine and @clayton-cornell Would you be willing to re-review? |
This PR must be merged before a backport PR will be created. |
* Update index and java for Alloy * Apply suggestions from code review * Update docs/sources/configure-client/grafana-agent/go_pull.md * Update docs/sources/configure-client/grafana-agent/go_pull.md * Updates for Java * Apply suggestions from code review (cherry picked from commit b58be93)
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3272-to-release/v1.5 origin/release/v1.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x b58be939077b84385d3752c9588f0f8ca1975171 When the conflicts are resolved, stage and commit the changes:
If you have the GitHub CLI installed: # Push the branch to GitHub:
git push --set-upstream origin backport-3272-to-release/v1.5
# Create the PR body template
PR_BODY=$(gh pr view 3272 --json body --template 'Backport b58be939077b84385d3752c9588f0f8ca1975171 from #3272{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "[release/v1.5] [DOC] Update index and java for Alloy" --body-file - --label "type/docs" --label "backport" --base release/v1.5 --milestone release/v1.5 --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-3272-to-release/v1.5
# Create a pull request where the `base` branch is `release/v1.5` and the `compare`/`head` branch is `backport-3272-to-release/v1.5`.
# Remove the local backport branch
git switch main
git branch -D backport-3272-to-release/v1.5 |
Starts updating the Agent documentation for Alloy.
This PR addresses the Grafana Agent _index, Java, and Golang push docs.
Down the road, the Agent docs will be removed or at least moved to the bottom of the pages in a collapsed section.
Related to #3271