-
Notifications
You must be signed in to change notification settings - Fork 717
chore(examples): update go push rideshare-alloy example #3776
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
chore(examples): update go push rideshare-alloy example #3776
Conversation
simonswine
left a comment
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.
LGTM
|
@marcsanmi if you get a chance, please take a look at the PR – the example and docs are exceptionally good, I only have a suggestion about the example placement |
examples/language-sdk-instrumentation/golang-push/rideshare-alloy/README.md
Outdated
Show resolved
Hide resolved
knylander-grafana
left a comment
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.
Thank you for updating the docs! I made one small suggestion.
…loy/README.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
|
This PR must be merged before a backport PR will be created. |
1 similar comment
|
This PR must be merged before a backport PR will be created. |
|
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-3776-to-release/v1.9 origin/release/v1.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 8438f881b945cfd74802283e265e00ff3c81c47eWhen 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-3776-to-release/v1.9
# Create the PR body template
PR_BODY=$(gh pr view 3776 --json body --template 'Backport 8438f881b945cfd74802283e265e00ff3c81c47e from #3776{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release/v1.9] chore(examples): update go push rideshare-alloy example' --body-file - --label 'type/docs' --label 'backport' --base release/v1.9 --milestone release/v1.9 --webOr, 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-3776-to-release/v1.9
# Create a pull request where the `base` branch is `release/v1.9` and the `compare`/`head` branch is `backport-3776-to-release/v1.9`.
# Remove the local backport branch
git switch main
git branch -D backport-3776-to-release/v1.9 |
|
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-3776-to-release/v1.10 origin/release/v1.10
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 8438f881b945cfd74802283e265e00ff3c81c47eWhen 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-3776-to-release/v1.10
# Create the PR body template
PR_BODY=$(gh pr view 3776 --json body --template 'Backport 8438f881b945cfd74802283e265e00ff3c81c47e from #3776{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release/v1.10] chore(examples): update go push rideshare-alloy example' --body-file - --label 'type/docs' --label 'backport' --base release/v1.10 --milestone release/v1.10 --webOr, 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-3776-to-release/v1.10
# Create a pull request where the `base` branch is `release/v1.10` and the `compare`/`head` branch is `backport-3776-to-release/v1.10`.
# Remove the local backport branch
git switch main
git branch -D backport-3776-to-release/v1.10 |
The PR adds links between the documentation and the example, as well as a link to the flame graph view in Explore Profiles for easier navigation.
The README and documentation are well-written. The example is accurate and uses the latest SDK version.
I'm a bit confused as to why the example resides in the Go push directory – application instrumentation is not the focus of what we're demonstrating. Additionally, it makes the example harder to discover.
I'd suggest moving it to
examples/grafana-alloy-receive(or something similar).Now the structure is as follows:
It could be moved to:
This would better align with the documentation, which outlines three methods:
Otherwise, it might be confusing for users browsing golang-push if they only want to ingest data from, for example, Java apps. We could add language-specific examples, but I think this is unnecessary.