Hi there! thank you for trying out Pyroscope! In this guide you'll learn everything you need to know to start using Pyroscope to find bottlenecks in your code. If you have any questions or if something doesn't work reach out to us in our slack group or email us at email@example.com.
You can also schedule a call with an engineer if that's easier for you. We would love to learn about your use-case and help you get started.
Install Pyroscope Server
We provide a few different ways for you to install Pyroscope server:
- if you're on a Mac, we recommend using homebrew
- if you're on Linux, we recommend using our rpm or deb packages
- we also have a docker image that you can use anywhere
To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our Downloads page.
Verify the installation
After installing Pyroscope, verify that the installation worked by opening a new terminal session and running the command
- macOS / Linux
You should see something like this:
Start the server
To start pyroscope server run
pyroscope server command:
- macOS / Linux
Pyroscope server is the database where all the profiling information is stored. It also has a web UI (by default available on port
After you start the server you should be able to open http://localhost:4040/ and see that pyroscope server is profiling itself (
Profile your applications
Now that you have pyroscope server running you can start continuously profiling your own applications.
We currently support 3 platforms:
To start profiling a Ruby application, add
pyroscope exec before the command. For example, if you're working with a Rails application, here's how you profile it:
This will make pyroscope agent send profiling data over to pyroscope server. Open http://localhost:4040/ in your browser to explore the incoming profiling data.
Pyroscope can be configured with command line arguments, environment variables and config files. See Configuration for more info on this topic.
Deploy Pyroscope in production
If you're installing pyroscope in production environment, read Deployment Guide.