forked from grafana/pyroscope
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC] Add traces to profile content (grafana#2980)
* Add traces to profile content * Rename folder to view and analyze * Fix links * Update docs/sources/view-and-analyze-profile-data/_index.md * Apply suggestions from code review * Fix links * Apply suggestions from code review * Update docs/sources/view-and-analyze-profile-data/_index.md * Add link to PR 2982 content * Apply suggestions from code review
- Loading branch information
1 parent
f8e6d8b
commit 2988c43
Showing
12 changed files
with
118 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: View and analyze profile data | ||
menuTitle: View and analyze profile data | ||
description: How to use Pyroscope to view and analyze profile data. | ||
aliases: | ||
- ../ingest-and-analyze-profile-data/ | ||
weight: 50 | ||
keywords: | ||
- pyroscope | ||
- UI | ||
- performance analysis | ||
- flamegraphs | ||
- CLI | ||
--- | ||
|
||
# View and analyze profile data | ||
|
||
Profiling data can be presented in a variety of formats presents such as: | ||
- **Flamegraphs**: Visualize call relationships and identify hotspots. | ||
- **Tables**: View detailed statistics for specific functions or time periods. | ||
- **Charts and graphs**: Analyze trends and compare performance across different metrics. | ||
|
||
## Viewing profiles | ||
|
||
Pyroscope offers both a Command Line Interface (CLI) and an Application Programming Interface (API) to interact with and retrieve profiling data. These tools provide flexibility in how you access and manage your profiling information. | ||
|
||
You can export profiling data from Pyroscope in various formats: | ||
- **pprof**: Support for pprof, gzip compressed pprof, for example, `foo.pprof.gz` | ||
- **JSON**: JSON object easy to integrate with other tools and scripts | ||
|
||
Integrating Pyroscope with Grafana is a common and recommended approach for visualizing profiling data. Grafana, being a powerful tool for data visualization, can effectively display profiling data in an accessible and insightful manner. | ||
|
||
Options for Visualizing Data in Grafana: | ||
- **Pyroscope App Plugin**: This plugin is specifically designed for Pyroscope data. It allows for easy browsing, analysis, and comparison of multiple profiles across different labels or time periods. This is particularly useful for a comprehensive overview of your application's performance. | ||
- **Explore Tab**: In Grafana, the Explore tab is suited for making targeted queries on your profiling data. This is useful for in-depth analysis of specific aspects of your application's performance. | ||
- **Dashboard**: Grafana dashboards are excellent for integrating profiling data with other metrics. You can display Pyroscope data alongside other dashboard items, creating a unified view of your application’s overall health and performance. | ||
|
||
For more information on using profiles in Grafana, refer to [Pyroscope and profiles in Grafana]({{< relref "../introduction/pyroscope-in-grafana#pyroscope-and-profiling-in-grafana" >}}). | ||
|
||
The Pyroscope app plugin works for Grafana Cloud. | ||
|
||
For more information on configuring these data sources, refer to the Pyroscope data source documentation in [Grafana Cloud](/docs/grafana-cloud/connect-externally-hosted/data-sources/grafana-pyroscope/) and [Grafana](/docs/grafana/latest/datasources/grafana-pyroscope/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
docs/sources/view-and-analyze-profile-data/profile-tracing/traces-to-profiles.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: Traces to profiles | ||
menuTitle: Traces to profiles | ||
description: Learning about traces to profiles integration in Grafana and Grafana Cloud. | ||
weight: 150 | ||
keywords: | ||
- pyroscope | ||
- continuous profiling | ||
- tracing | ||
--- | ||
|
||
# Traces to profiles | ||
|
||
{{< admonition type="note" >}} | ||
|
||
Your application must be instrumented for profiles and traces. For more information, refer to [Span profiles for Traces to profiles]({{< relref "../../configure-client/go-span-profiles" >}}). | ||
|
||
{{< /admonition >}} | ||
|
||
[//]: # 'Shared content for Trace to profiles in the Tempo data source' | ||
|
||
{{< docs/shared source="grafana" lookup="datasources/tempo-traces-to-profiles.md" version="<GRAFANA VERSION>" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters