[DOC] Update Pyroscope data source (#82130)

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-12 08:34:36 +00:00
parent fcf2543fe3
commit 815e61258c
4 changed files with 174 additions and 95 deletions
@@ -0,0 +1,80 @@
+---
+aliases:
+  - ../features/datasources/phlare/ # /docs/grafana/<GRAFANA_VERSION>/features/datasources/phlare/
+  - ../features/datasources/grafana-pyroscope/ # /docs/grafana/<GRAFANA_VERSION>/features/datasources/grafana-pyroscope/
+  - ../datasources/grafana-pyroscope/ # /docs/grafana/<GRAFANA_VERSION>/datasources/grafana-pyroscope/
+description: Horizontally-scalable, highly-available, multi-tenant continuous profiling
+  aggregation system. OSS profiling solution from Grafana Labs.
+keywords:
+  - grafana
+  - phlare
+  - guide
+  - profiling
+  - pyroscope
+labels:
+  products:
+    - cloud
+    - enterprise
+    - oss
+title: Grafana Pyroscope
+weight: 1150
+---
+
+# Grafana Pyroscope data source
+
+Grafana Pyroscope is a horizontally scalable, highly available, multi-tenant, OSS, continuous profiling aggregation system. Add it as a data source, and you are ready to query your profiles in [Explore][explore].
+
+To learn more about profiling and Pyroscope, refer to the [Introduction to Pyroscope](/docs/pyroscope/introduction/).
+
+For information on configuring the Pyroscope data source, refer to [Configure the Grafana Pyroscope data source](./configure-pyroscope-data-source).
+
+## Integrate profiles into dashboards
+
+Using the Pyroscope data source, you can integrate profiles into your dashboards.
+In this case, the screenshot shows memory profiles alongside panels for logs and metrics to be able to debug out of memory (OOM) errors alongside the associated logs and metrics.
+
+![dashboard](https://grafana.com/static/img/pyroscope/grafana-pyroscope-dashboard-2023-11-30.png)
+
+## Visualize traces and profiles data using Traces to profiles
+
+You can link profile and tracing data using your Pyroscope data source with the Tempo data source.
+
+Combined traces and profiles let you see granular line-level detail when available for a trace span. This allows you pinpoint the exact function that's causing a bottleneck in your application as well as a specific request.
+
+![trace-profiler-view](https://grafana.com/static/img/pyroscope/pyroscope-trace-profiler-view-2023-11-30.png)
+
+For more information, refer to the [Traces to profile section][configure-tempo-data-source] of the Tempo data source documentation.
+
+{{< youtube id="AG8VzfFMLxo" >}}
+
+## Provision the Grafana Pyroscope data source
+
+You can modify the Grafana configuration files to provision the Grafana Pyroscope data source.
+To learn more, and to view the available provisioning settings, refer to [provisioning documentation][provisioning-data-sources].
+
+Here is an example configuration:
+
+```yaml
+apiVersion: 1
+
+datasources:
+  - name: Grafana Pyroscope
+    type: grafana-pyroscope-datasource
+    url: http://localhost:4040
+    jsonData:
+      minStep: '15s'
+```
+
+{{% docs/reference %}}
+[explore]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/explore"
+[explore]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/explore"
+
+[flame-graph]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/visualizations/flame-graph"
+[flame-graph]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/visualizations/flame-graph"
+
+[provisioning-data-sources]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/administration/provisioning#datasources"
+[provisioning-data-sources]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/provisioning#datasources"
+
+[configure-tempo-data-source]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/datasources/tempo/configure-tempo-data-source"
+[configure-tempo-data-source]: "/docs/grafana-cloud/ -> docs/grafana-cloud/connect-externally-hosted/data-sources/tempo/configure-tempo-data-source"
+{{% /docs/reference %}}