Plugins 〉Pyroscope


Developer

Pyroscope

Sign up to receive occasional product news and updates:


Grafana Cloud
Grafana Cloud
  • Grafana, of course
  • 10k series Prometheus metrics
  • 50 GB logs
  • 50 GB traces
  • 2,232 app o11y host hours
  • ...and more
Create free account

No credit card needed, ever.


The Pyroscope plugin has been deprecated and is no longer maintained.

Data Source
community

Pyroscope

  • Overview
  • Installation
  • Change log
  • Related content

Pyroscope Grafana Datasource Plugin

Important: Grafana version 7.2 or later required

Getting started

  1. Install the plugin (Installation tab)
  2. Install panel plugin
  3. Open Grafana and go to Configuration -> Plugins
  4. Check that plugins are available
  5. Set up data source plugin:
    • Configuration -> Data Sources -> Add data source
    • click on pyroscope-datasource
    • Specify Pyroscope host in Endpoint field: endpoint
  6. Set up panel plugin:
    • Add an empty panel on your dashboard
    • Select pyroscope-panel from Visualization list
    • Under panel view in Query tab select pyroscope-datasource
    • In Application name input specify app name
    • Click Apply settings

Congratulations! Now you can monitor application flamegraph on your Grafana dashboard! dashboard

Datasource template variables

You can use variables of the type Query to query Pyroscope for a list of applications, labels, or label values. Variable query functions supported by Pyroscope data source:

NameDescription
apps()Returns a list of application names
label_names(app_name)Returns a list of label names for the application
label_values(app_name,label_name)Returns a list of label values for the application label

Example

Create a new variable in the dashboard settings:

  • Name: appName
  • Type: Query
  • Data source: select your Pyroscope data source
  • Query: apps()

Now you should see the list of applications returned from the Pyroscope data source, and use the variable in the panel Query field:

$appName{}

Installing Pyroscope on Grafana Cloud:

For more information, visit the docs on plugin installation.

Installing on a local Grafana:

For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.

1. Install the Data Source

Use the grafana-cli tool to install Pyroscope from the commandline:

grafana-cli plugins install 

The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.

2. Configure the Data Source

Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.

Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.

To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.

Changelog

1.2.0 (2023-03-13)

Features

Bug Fixes

1.2.0 (2023-03-09)

Features

1.1.3 (2022-07-11)

Add a CHANGELOG.md

1.1.2 (2022-02-24)

Add support for authenticated requests.