grafana / pyroscope

Continuous Profiling Platform. Debug performance issues down to a single line of code
https://grafana.com/oss/pyroscope/
GNU Affero General Public License v3.0
9.65k stars 577 forks source link

[DOC] Update Pyroscope for Agent > Alloy #3271

Open knylander-grafana opened 2 months ago

knylander-grafana commented 2 months ago

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

Related: https://github.com/grafana/pyroscope/issues/3277

Page updates

Configure the client . Grafana Agent https://grafana.com/docs/pyroscope/latest/configure-client/grafana-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 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:

### Tasks
- [x] Update Grafana Agent index page
- [x] Update Set up Go profiling in pull mode
- [ ] Update Profiling Java using the Grafana Agent
- [ ] Update Profiling with eBPF index
- [ ] Update Profiling with eBPF K8s
- [ ] Update Profiling with eBPF Linux
- [ ] Update Profiling with eBPF Docker
- [ ] Update Profiling with eBPF config reference
- [ ] Update Profiling with eBPF Troubleshooting
- [ ] Update sampling scrape targets
- [ ] Helm chart doc updates, refer to https://github.com/grafana/pyroscope/pull/3381
knylander-grafana commented 2 weeks ago

From https://github.com/grafana/pyroscope/pull/3381:

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

Fixes https://github.com/grafana/pyroscope/issues/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