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: add documentation for Pyroscope SDK profiles through Alloy #3658

Merged
merged 4 commits into from
Nov 13, 2024

Conversation

marcsanmi
Copy link
Contributor

@marcsanmi marcsanmi commented Oct 31, 2024

DO NOT MERGE until next Alloy release happens.
As of now, latest is https://github.com/grafana/alloy/releases/tag/v1.4.3

This PR adds documentation for the new feature that allows sending profiles from Pyroscope SDKs through Alloy.

@marcsanmi marcsanmi added the type/docs Improvements for doc docs. Used by Docs team for project management label Oct 31, 2024

This document explains these two techniques and guide you when to choose each one.
This document explains these techniques and guide you when to choose each one.

![Pyroscope agent server diagram](https://grafana.com/media/docs/pyroscope/pyroscope_client_server_diagram_09_18_2024.png)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This needs to be updated with the new image @Rperry2174

Copy link
Contributor

Choose a reason for hiding this comment

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

just put in a request with design team sorry for delay!

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.

Excellent doc updates! Thank you for the additions! I don't think there will be many conflicts with. my other PR.

@marcsanmi marcsanmi force-pushed the marcsanmi/alloy-receive-http-docs branch from a11899b to f605bbb Compare November 5, 2024 10:05
@marcsanmi marcsanmi marked this pull request as ready for review November 5, 2024 10:08
@marcsanmi marcsanmi requested review from a team as code owners November 5, 2024 10:08
@marcsanmi marcsanmi changed the title docs: add documentation for Pyroscope SDK profiles through Alloy DO NOT MERGE (docs): add documentation for Pyroscope SDK profiles through Alloy Nov 5, 2024
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.

This is an excellent addition. I have some small changes, mostly very minor wording and formatting. Thank you for updating the content!

@knylander-grafana
Copy link
Contributor

When this is merged, do you want the content to be visible in the currently published Grafana docs for 11.3? If so, we'll need to add a backport label for 11.3 to the PR.

@marcsanmi marcsanmi force-pushed the marcsanmi/alloy-receive-http-docs branch from 5468a60 to 6e37b31 Compare November 12, 2024 16:41
@Rperry2174
Copy link
Contributor

Posting draft of new image to share with design team:
image

@marcsanmi marcsanmi changed the title DO NOT MERGE (docs): add documentation for Pyroscope SDK profiles through Alloy docs: add documentation for Pyroscope SDK profiles through Alloy Nov 13, 2024
@marcsanmi marcsanmi merged commit 44b9335 into main Nov 13, 2024
18 checks passed
@marcsanmi marcsanmi deleted the marcsanmi/alloy-receive-http-docs branch November 13, 2024 16:06
@knylander-grafana knylander-grafana added the backport release/v1.9 This label will backport a merged PR to the release/v1.9 branch label Nov 13, 2024
github-actions bot pushed a commit that referenced this pull request Nov 13, 2024
* docs: add documentation for Pyroscope SDK profiles through Alloy

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
(cherry picked from commit 44b9335)
@marcsanmi marcsanmi added the backport release/v1.10 This label will backport a merged PR to the release/v1.10 branch label Nov 14, 2024
github-actions bot pushed a commit that referenced this pull request Nov 14, 2024
* docs: add documentation for Pyroscope SDK profiles through Alloy

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
(cherry picked from commit 44b9335)
marcsanmi added a commit that referenced this pull request Nov 14, 2024
…) (#3685)

* docs: add documentation for Pyroscope SDK profiles through Alloy

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
(cherry picked from commit 44b9335)

Co-authored-by: Marc Sanmiquel <marcsanmiquel@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release/v1.9 This label will backport a merged PR to the release/v1.9 branch backport release/v1.10 This label will backport a merged PR to the release/v1.10 branch 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.

3 participants