This is documentation for the next version of Pyroscope. For the latest stable release, go to the latest version.

Get started

Open source

Get started with Pyroscope

Choose one of the following options to get started with Pyroscope:

The written tutorial below provides a series of imperative commands to start a single Pyroscope process, or monolith, which is designed for users getting started with the project.

You can also use multiple examples to help you quickly get started using Pyroscope and Grafana.

Every example has a docker-compose.yml manifest that includes all of the options needed to explore profiling data in Grafana, including resource configuration and profiling data generation.

For more information on the different ways to deploy Pyroscope, see Pyroscope deployment modes.

Before you begin

Verify that you have installed Docker.

Download and configure Pyroscope

Download Pyroscope.
You can use Docker or download a binary to install Pyroscope.
- To install with Docker, run the following command:
  bash
```
docker pull grafana/pyroscope:latest
```
- To use a local binary:
  Download the appropriate release asset for your operating system and architecture and make it executable.
  For example, for Linux with the AMD64 architecture:
  bash
```
# Download Pyroscope v1.0.0 and unpack it to the current folder
curl -fL https://github.com/grafana/pyroscope/releases/download/v1.0.0/pyroscope_1.0.0_linux_amd64.tar.gz | tar xvz
```

Run Pyroscope.

In a terminal, run one of the following commands:

Using Docker:

docker network create pyroscope-demo
docker run --rm --name pyroscope --network=pyroscope-demo -p 4040:4040 grafana/pyroscope:latest

Using a local binary:
bash
```
./pyroscope
```

Verify that Pyroscope is ready. Pyroscope listens on port 4040.
bash
```
curl localhost:4040/ready
```
Configure Pyroscope to scrape profiles.
By default, Pyroscope is configured to scrape itself. To collect more profiles, you must either instrument your application with an SDK or use Grafana Alloy.
To learn more about language integrations and the Pyroscope agent, refer to Pyroscope Agent.

Add a Pyroscope data source and query data

In a terminal, run a local Grafana server using Docker:

docker run --rm --name=grafana \
  --network=pyroscope-demo \
  -p 3000:3000 \
  -e "GF_INSTALL_PLUGINS=grafana-pyroscope-app"\
  -e "GF_AUTH_ANONYMOUS_ENABLED=true" \
  -e "GF_AUTH_ANONYMOUS_ORG_ROLE=Admin" \
  -e "GF_AUTH_DISABLE_LOGIN_FORM=true" \
  grafana/grafana:main

In a browser, go to the Grafana server at http://localhost:3000/datasources.
Use the following settings to configure a Pyroscope data source to query the local Pyroscope server:
Field Value
Name Pyroscope
URL http://pyroscope:4040/ OR http://host.docker.internal:4040/ if using Docker

Field	Value
Name	Pyroscope
URL	http://pyroscope:4040/ OR http://host.docker.internal:4040/ if using Docker

To learn more about adding data sources, refer to Add a data source.

In a browser, go to Explore Profiles in your Grafana instance at https://localhost:3000/a/grafana-pyroscope-app/profiles-explorer. This will let you use an intuitive interface for exploring your profile data.

When you have completed the tasks in this getting started guide, you can create dashboard panels using the newly configured Pyroscope data source. For more information on working with dashboards with Grafana, refer to Panels and visualizations in the Grafana documentation.