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 Pyroscope for Agent > Alloy #3271

Closed
9 of 11 tasks
knylander-grafana opened this issue May 2, 2024 · 4 comments · Fixed by #3621
Closed
9 of 11 tasks

[DOC] Update Pyroscope for Agent > Alloy #3271

knylander-grafana opened this issue May 2, 2024 · 4 comments · Fixed by #3621
Assignees
Labels
type/docs Improvements for doc docs. Used by Docs team for project management

Comments

@knylander-grafana
Copy link
Contributor

knylander-grafana commented May 2, 2024

Update the Pyroscope documentation to use Alloy examples since Agent is being deprecated.

Related: #3277

SME: Marc S

Remove Agent content and use Alloy instead.

Page updates

Configure the client . Grafana Agent
https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent/

  • Change page to be Alloy or Agent

Set up Go profiling in pull mode
On https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent

Install Grafana Agent section:

Add > Install Grafana Alloy > https://grafana.com/docs/alloy/latest/get-started/install/

Prepare configuration file
Alloy - config file can be anything .alloy
Blocks should stay the same for Agent flow and Alloy.

Start Grafana Agent Flow
Start a local Pyroscope instance for testing purposes (stays the same)

docker run -p 4040:4040 grafana/pyroscope

Start the collector

Start Grafana Alloy: alloy run <configuration-file.file>
Start Grafana Agent: grafana-agent-flow run configuration.river

Open a browser to http://localhost:4040. The page should list profiles.

eBPF

k8s install -- see https://grafana.com/docs/alloy/latest/get-started/install/kubernetes/

All ebpf docs:

  • Updates to configuration files and specifics for agent vs alloy
  • Update links to Alloy and Agent

Tasks

@knylander-grafana knylander-grafana changed the title Update Pyroscope for Agent > Alloy [DOC] Update Pyroscope for Agent > Alloy May 2, 2024
@knylander-grafana knylander-grafana self-assigned this May 2, 2024
@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label May 2, 2024
@knylander-grafana
Copy link
Contributor Author

knylander-grafana commented Jun 21, 2024

From #3381:

This change will disable the agent by default and enable alloy instead.

Fixes #3282

This is breaking change for all helm chart users.

It is required that their custom options are either migrated by replacing agent with alloy or they maintain the previous behaviour by agent.enabled: true alloy.enable: false

@knylander-grafana
Copy link
Contributor Author

Feedback from Ashley for the install docs for Pyroscope based on a customer's feedback:

  • grafana agent referenced frequently which confused the prospect
  • as a suggestion, it would be easier if the components were named the same so as we're copy/pasting from the different sections it will work without changes
    • EX - all the full examples in this page have a local pyro as the write output (even though its called send to cloud), but if you copy the cloud profiles config at the top this component is called endpoint while the rest of the sample config writes to example
  • this page references and installs the grafana agent, not alloy - is it intentional? with a new prospect they have already installed alloy, so this is confusing if they want to just add the relevant config lines and also agent is being deprecated soon
  • I think it would be helpful to have a tab answering 'what if im running opentelemetry collector' since this is what most (of my) prospects are using
  • it would be helpful if the helm chart or instructions to install alloy were at the beginning of the instructions, since it doesn't list as a pre req that you need to first install it
  • from the cloud profiles doc when you start to follow the instructions to configure it brings you to the oss docs. So my prospect clicked into "Deploy on K8s" thinking it would be what he needed, but these are instructions to deploy actual pyro.

@knylander-grafana
Copy link
Contributor Author

Additional update:

https://grafana.com/docs/pyroscope/latest/configure-client/grafana-agent/go_pull/

This page does not mention that the default Alloy configuration uses
annotations to control discovery of targets. So to enable
scraping/collection you also have to annotate the target pods with
annotations like profiles.grafana.com/goroutine.scrape=true

@knylander-grafana
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Improvements for doc docs. Used by Docs team for project management
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants