Skip to content

Conversation

@kolesnikovae
Copy link
Collaborator

@kolesnikovae kolesnikovae commented Dec 13, 2024

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:

examples/grafana-alloy-auto-instrumentation
examples/language-sdk-instrumentation
examples/language-sdk-instrumentation/golang-push/rideshare-alloy

It could be moved to:

examples/grafana-alloy-auto-instrumentation
examples/grafana-alloy-receive
examples/language-sdk-instrumentation

This would better align with the documentation, which outlines three methods:

Pyroscope is a continuous profiling database that allows you to analyze the performance of your applications. When sending profiles to Pyroscope, you can choose between three methods:

  1. Auto-instrumentation using Grafana Alloy
  2. SDK instrumentation
  3. SDK instrumentation through Grafana Alloy

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.

Copy link
Contributor

@simonswine simonswine left a comment

Choose a reason for hiding this comment

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

LGTM

@kolesnikovae kolesnikovae marked this pull request as ready for review December 13, 2024 10:58
@kolesnikovae kolesnikovae requested review from a team as code owners December 13, 2024 10:58
@kolesnikovae
Copy link
Collaborator Author

@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

Copy link
Contributor

@knylander-grafana knylander-grafana left a 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.

@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label Dec 13, 2024
…loy/README.md

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
@simonswine simonswine added backport release/v1.9 backport release/v1.10 This label will backport a merged PR to the release/v1.10 branch labels Dec 16, 2024
@github-actions
Copy link
Contributor

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

1 similar comment
@github-actions
Copy link
Contributor

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

@simonswine simonswine merged commit 8438f88 into main Dec 16, 2024
19 checks passed
@simonswine simonswine deleted the chore(examples)/update-go-push-alloy-example branch December 16, 2024 10:36
@github-actions
Copy link
Contributor

The backport to release/v1.9 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-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 8438f881b945cfd74802283e265e00ff3c81c47e

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-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 --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-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

@github-actions
Copy link
Contributor

The backport to release/v1.10 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-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 8438f881b945cfd74802283e265e00ff3c81c47e

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-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 --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-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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport release/v1.10 This label will backport a merged PR to the release/v1.10 branch backport-failed type/docs Improvements for doc docs. Used by Docs team for project management

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants