IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-01-24 23:37:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] Update the Pyroscope data source config doc (#89648)

Browse Source 
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Kim Nylander 2024-07-05 14:37:02 -04:00 committed by GitHub
parent 5f9ce12542
commit 863c9fc34e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 85 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/sources/administration/provisioning/index.md
View File

@ -269,9 +269,8 @@ The _HTTP\*_ tag denotes data sources that communicate using the HTTP protocol,
#### Custom HTTP headers for data sources
Data sources managed by Grafanas provisioning can be configured to add HTTP headers to all requests
going to that data source. The header name is configured in the `jsonData` field and the header value should be
configured in `secureJsonData`.
Data sources managed with provisioning can be configured to add HTTP headers to all requests.
The header name is configured in the `jsonData` field and the header value is configured in `secureJsonData`.
```yaml
apiVersion: 1

93
docs/sources/datasources/pyroscope/configure-pyroscope-data-source.md
View File

@ -42,16 +42,89 @@ To configure basic settings for the data source, complete the following steps:
1. Click **Connections** in the left-side menu.
1. Under Your connections, click **Data sources**.
1. Enter `Grafana Pyroscope` in the search bar.
1. Select **Add new data source**.
1. Click **Grafana Pyroscope** to display the **Settings** tab of the data source.
1. Set the data source's basic configuration options.
1. Select **Save & test**.
1. Set the data source's basic configuration options:
## Configuration options
| Name | Description |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Name` | A name to specify the data source in panels, queries, and Explore. |
| `Default` | The default data source will be pre-selected for new panels. |
| `URL` | The URL of the Grafana Pyroscope instance, for example, `http://localhost:4100`. |
| `Basic Auth` | Enable basic authentication to the data source. |
| `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. |
| `Minimal step` | Used for queries returning timeseries data. The Pyroscope backend, similar to Prometheus, scrapes profiles at certain intervals. To prevent querying at smaller interval, use Minimal step same or higher than your Pyroscope scrape interval. This prevents returning too many data points to the frontend. |
You can configure several options for the Pyroscope data source, including the name, HTTP, authentication, querying, and private data source connect.
If you make any changes, select **Save & test** to preserve those changes.
![Configuration options for the Pyroscope data source](/media/docs/grafana/data-sources/screenshot-pyroscope-data-source-config.png)
### Name and default
**Name**
: Enter a name to specify the data source in panels, queries, and Explore.
**Default**
: The default data source is pre-selected for new panels.
### HTTP
The HTTP section is shown in number 1 in the screenshot.
**URL**
: The URL of the Grafana Pyroscope instance, for example, `https://localhost:4100`.
**Allowed cookies**
: The Grafana Proxy deletes forwarded cookies. Use this field to specify cookies by name that should be forwarded to the data source.
**Timeout**
: HTTP request timeout in seconds.
### Auth
The Auth section is shown in number 2 in the screenshot.
**Basic auth**
: Enable basic authentication to the data source. When activated, it provides **User** and **Password** fields.
**With Credentials**
: Whether credentials, such as cookies or auth headers, should be sent with cross-site requests.
**TLS Client Auth**
: Toggle on to use client authentication. When enabled, it adds the **Server name**, **Client cert**, and **Client key** fields. The client provides a certificate that is validated by the server to establish the client's trusted identity. The client key encrypts the data between client and server. These details are encrypted and stored in the Grafana database.
**With CA Cert**
: Activate this option to verify self-signed TLS certificates.
**Skip TLS Verify**
: When activated, it bypasses TLS certificate verification.
**Forward OAuth Identity**
: When activated, the user’s upstream OAuth 2.0 identity is forwarded to the data source along with their access token.
**Custom HTTP Headers**
: Select Add header to add Header and Value fields.
**Header**
: Add a custom header. This allows custom headers to be passed based on the needs of your Pyroscope instance.
**Value**
: The value of the header.
### Querying
The **Querying** section is shown in number 3 in the screenshot.
**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
The **Private data source connect** section is shown in number 4 in the screenshot.
This feature is only available in Grafana Cloud.
This option lets you query data that lives within a secured network without opening the network to inbound traffic from Grafana Cloud.
Use the drop-down box to select a configured private data sources.
Select **Manage private data source connect** to configure and manage any private data sources you have configured.
For more information, refer to [Private data source connect](https://grafana.com/docs/grafana-cloud/connect-externally-hosted/private-data-source-connect/).