Hi there! thank you for trying out Pyroscope! In this guide you'll need just 3 steps in order to start monitoring your application's performance.
- Install Pyrocope server
- Start Pyroscope server
- Start your application using our Pyroscope Agent
This diagram shows the architecture of a typical application running with pyroscope:
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.
Step 1: Install the Pyroscope server
We provide a few different ways for you to install Pyroscope server. To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our Downloads page.
Step 2: Start the Pyroscope server
To start pyroscope server run
pyroscope server command:
- macOS / Linux
By default pyroscope server sends anonymized usage data to Pyroscope team. This helps us understand how people use Pyroscope and prioritize features accordingly. We take privacy of our users very seriously and only collect high-level stats such as number of apps added, types of spies used, etc. Source code for the analytics module is available on Github.
If you want to opt out of this, run pyroscope server with a flag or an environment variable:
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 (
Step 3: Start your app with Pyroscope agent
Now that you have pyroscope server running you can start continuously profiling your own applications.
We currently support 3 platforms:
To start profiling a Python application, just add
pyroscope exec before the command. For example, if you're working with a Django 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.