2022-11-01 18:14:36 +08:00
---
2024-02-12 16:34:36 +08:00
description: Configure your Pyroscope data source for Grafana.
2022-11-01 18:14:36 +08:00
keywords:
2024-02-12 16:34:36 +08:00
- configure
2022-11-01 18:14:36 +08:00
- profiling
2023-05-12 16:38:15 +08:00
- pyroscope
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/enterprise-licensing pages to have 'Enterprise' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/recorded-queries pages to have labels cloud,enterprise
* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/stats-and-license pages to have labels cloud,enterprise
* Set alerting pages to have labels cloud,enterprise,oss
* Set breaking-changes pages to have labels cloud,enterprise,oss
* Set dashboards pages to have labels cloud,enterprise,oss
* Set datasources pages to have labels cloud,enterprise,oss
* Set explore pages to have labels cloud,enterprise,oss
* Set fundamentals pages to have labels cloud,enterprise,oss
* Set introduction/grafana-cloud pages to have labels cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix introduction pages products
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set panels-visualizations pages to have labels cloud,enterprise,oss
* Set release-notes pages to have labels cloud,enterprise,oss
* Set search pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set troubleshooting pages to have labels cloud,enterprise,oss
* Set whatsnew pages to have labels cloud,enterprise,oss
* Apply updated labels from review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 16:10:12 +08:00
labels:
products:
- cloud
- enterprise
- oss
2024-02-12 16:34:36 +08:00
title: Configure the Grafana Pyroscope data source
menuTitle: Configure Pyroscope
weight: 200
2024-05-28 22:17:49 +08:00
refs:
explore:
- pattern: /docs/grafana/
destination: /docs/grafana/< GRAFANA_VERSION > /explore/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/< GRAFANA_VERSION > /explore/
provisioning-data-sources:
- pattern: /docs/grafana/
destination: /docs/grafana/< GRAFANA_VERSION > /administration/provisioning/#datasources
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/< GRAFANA_VERSION > /administration/provisioning/#datasources
flame-graph:
- pattern: /docs/grafana/
destination: /docs/grafana/< GRAFANA_VERSION > /panels-visualizations/visualizations/flame-graph/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/< GRAFANA_VERSION > /panels-visualizations/visualizations/flame-graph/
configure-tempo-data-source:
- pattern: /docs/grafana/
destination: /docs/grafana/< GRAFANA_VERSION > /datasources/tempo/configure-tempo-data-source/
- pattern: /docs/grafana-cloud/
destination: docs/grafana-cloud/connect-externally-hosted/data-sources/tempo/configure-tempo-data-source/
2025-01-29 03:02:53 +08:00
explore-profiles:
2024-08-13 22:39:55 +08:00
- pattern: /docs/grafana/
2025-01-29 03:02:53 +08:00
destination: /docs/grafana/< GRAFANA_VERSION > /explore/simplified-exploration/profiles/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/visualizations/simplified-exploration/profiles/
2022-11-01 18:14:36 +08:00
---
2024-02-12 16:34:36 +08:00
# Configure the Grafana Pyroscope data source
2022-11-01 18:14:36 +08:00
2024-08-13 22:39:55 +08:00
The Pyroscope data source sets how Grafana connects to your Pyroscope database.
2023-04-07 00:45:45 +08:00
2024-08-13 22:39:55 +08:00
You can configure the data source using either the data source interface in Grafana or using a configuration file.
This page explains how to set up and enable the data source capabilities using Grafana.
2023-04-07 00:45:45 +08:00
2024-08-13 22:39:55 +08:00
If you make any changes, select **Save & test** to preserve those changes.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
If you're using your own installation of Grafana, you can provision the Pyroscope data source using a YAML configuration file.
For more information about provisioning and available configuration options, refer to [Provisioning Grafana ](ref:provisioning-data-sources ).
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
## Before you begin
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
To configure a Pyroscope data source, you need administrator rights to your Grafana instance and a Pyroscope instance configured to send data to Grafana.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
If you're provisioning a Pyroscope data source, then you also need administrative rights on the server hosting your Grafana instance.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
## Add or modify a data source
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
You can use these procedures to configure a new Pyroscope data source or to edit an existing one.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
### Create a new data source
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
To configure basic settings for the data source, complete the following steps:
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
1. Select **Connections** in the main menu.
1. Enter `Grafana Pyroscope` in the search bar.
1. Select **Grafana Pyroscope** .
1. Select **Add new data source** in the top-right corner of the page.
1. On the **Settings** tab, complete the **Name** , **Connection** , and **Authentication** sections.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
- Use the **Name** field to specify the name used for the data source in panels, queries, and Explore. Toggle the **Default** switch for the data source to be pre-selected for new panels.
2025-01-29 03:02:53 +08:00
- Under **Connection** , enter the **URL** of the Pyroscope instance. For example, `https://example.com:4100` . Refer to [Connection URL ](#connection-url ) for more information.
2024-08-13 22:39:55 +08:00
- Complete the [**Authentication** section ](#authentication ).
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
1. Optional: Use **Additional settings** to configure other options.
1. Select **Save & test** .
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
### Update an existing data source
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
To modify an existing Pyroscope data source:
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
1. Select **Connections** in the main menu.
1. Select **Data sources** to view a list of configured data sources.
1. Select the Pyroscope data source you wish to modify.
1. Optional: Use **Additional settings** to configure or modify other options.
1. After completing your updates, select **Save & test** .
2024-07-06 02:37:02 +08:00
2025-01-29 03:02:53 +08:00
#### Connection URL
The data source connection URL should point to a location of a running Pyroscope backend.
**Grafana Cloud Profiles**
Your Grafana Cloud instance automatically includes a fully provisioned data source.
If you are running a self-managed Grafana instance or need to configure an additional Pyroscope data source pointing to Grafana Cloud Profiles, you can find the Pyroscope URL under the **Manage your stack** section for your organization.
**Self-managed Pyroscope backend**
The connection URL for a self-managed Pyroscope backend depends on how Pyroscope is deployed.
Refer to the steps under [Query profiles in Grafana ](https://grafana.com/docs/pyroscope/<PYROSCOPE_VERSION>/deploy-kubernetes/helm/#query-profiles-in-grafana ) for more information on how to configure the data source.
2025-02-21 03:14:02 +08:00
If you plan to use the [Profiles Drilldown ](ref:explore-profiles ) application and you are running a self-managed Pyroscope backend in microservices mode, the data source connection URL should point to a gateway or proxy that routes requests to the corresponding Pyroscope service.
2025-01-29 03:02:53 +08:00
Refer to the [Helm ingress configuration ](https://github.com/grafana/pyroscope/blob/main/operations/pyroscope/helm/pyroscope/templates/ingress.yaml ) for specific routing requirements.
2024-08-13 22:39:55 +08:00
## Authentication
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
Use this section to select an authentication method to access the data source.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
{{< admonition type = "note" > }}
Use Transport Layer Security (TLS) for an additional layer of security when working with Pyroscope.
For additional information on setting up TLS encryption with Pyroscope, refer to [Pyroscope configuration ](https://grafana.com/docs/pyroscope/<PYROSCOPE_VERSION>/configure-server/reference-configuration-parameters/ ).
{{< / admonition > }}
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
[//]: # 'Shared content for authentication section procedure in data sources'
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
{{< docs / shared source = "grafana" lookup = "datasources/datasouce-authentication.md" leveloffset = "+2" version = "<GRAFANA_VERSION>" > }}
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
## Additional settings
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
Use the down arrow to expand the **Additional settings** section to view these options.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
### Advanced HTTP settings
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
The Grafana Proxy deletes forwarded cookies. Use the **Allowed cookies** field to specify cookies that should be forwarded to the data source by name.
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
The **Timeout** field sets the HTTP request timeout in seconds.
### Querying
2024-07-06 02:37:02 +08:00
**Minimum step** is used for queries returning time-series data. The default value is 15 seconds.
Adjusting this option can help prevent gaps when you zoom in to profiling data.
### Private data source connect
2024-08-13 22:39:55 +08:00
[//]: # 'Shared content for authentication section procedure in data sources'
2024-07-06 02:37:02 +08:00
2024-08-13 22:39:55 +08:00
{{< docs / shared source = "grafana" lookup = "datasources/datasouce-private-ds-connect.md" leveloffset = "+2" version = "<GRAFANA_VERSION>" > }}