Comments (3)
@simonswine Are you wanting more explanation in the docs or additional content in the UI? Or both? I have content in Cloud Profiles that I want to share back to our Pyroscope doc.
from pyroscope.
@knylander-grafana the ticket here was more created with the UI in mind, but yes ideally both.
from pyroscope.
Okay. This relates to some of the work that I'm doing in refactoring for the app (reference: https://github.com/grafana/pyroscope-squad/issues/125). It would be good to brainstorm and make sure what we have fills the level of detail you'd like to see.
I've listed the doc that we have across the various locations below. Note that we have very little in the Grafana docs. The only content we have there is the flame graph visualization panel and the data source content. I'd like to add a little more content to the Pyroscope data source docs, the same way that we have for the Tempo data source docs.
What do you think about this?
- Grafana docs for Pyroscope data source - Basic intro material, and refer people to the Pyroscope docs for technical details
- Grafana Cloud docs - Intro material with more details than what we have in the Grafana data source content
- Explore apps users - Careful focus on just enough information and use cases doc to enable people to use the app. Users are familiar with the telemetry signals but not experts. This content is mounted in Grafana and Grafana Cloud.
- Pyroscope OSS docs - This is where the meat goes. People come to the OSS docs to get the nitty gritty details.
For example, the Grafana Cloud docs might have content that gives an intro to flame graphs while the Pyroscope docs would talk about how the flame graphs are generated from the data.
Flame graphs
- Basics about flame graph visualization, https://grafana.com/docs/grafana/latest/panels-visualizations/visualizations/flame-graph/
- Flame graphs: Visualizing performance data,
- Flame graph AI (Cloud only, has some additional info about what flame graphs mean), https://grafana.com/docs/grafana-cloud/monitor-applications/profiles/flamegraph-ai/
Pyroscope UI
- Pyroscope UI for Pyroscope - https://grafana.com/docs/pyroscope/latest/view-and-analyze-profile-data/pyroscope-ui/
- Cloud Profiles UI - https://grafana.com/docs/grafana-cloud/monitor-applications/profiles/profiles-ui/
- Explore Profiles doc
- View and analyze profiling data
- Pyroscope in Grafana, Pyroscope docs, https://grafana.com/docs/pyroscope/latest/introduction/pyroscope-in-grafana/
Introduction to profiles
- Intro to Pyroscope, https://grafana.com/docs/pyroscope/latest/introduction/
- Profiling fundamentals, https://grafana.com/docs/grafana-cloud/monitor-applications/profiles/introduction/profiling-fundamentals/
- When to use continuous profiling
- Understand profiling types
- Understand
self
vstotal
metrics in profiling with Pyroscope, (Pyroscope docs only) https://grafana.com/docs/pyroscope/latest/view-and-analyze-profile-data/self-vs-total/
from pyroscope.
Related Issues (20)
- [DOC] Improve "Getting started" flow with Java docs HOT 3
- Store stack trace representation optimized for flame graph query
- [DOC] Fix 404s in Pyroscope doc
- The configuration for the replication factor is not effective
- ignore this
- inuse_space not working in dotnet? HOT 2
- Add BucketLookupType for s3 bucket HOT 1
- Merge 2 flamegraphs
- bug: pkg/test/integration TestPush is flaky
- Support for EKS Pod Identity HOT 1
- The tenant-setting has been re-added to the micro-service HOT 2
- Allow defining the config with the backend in a `Secret` instead of a `ConfigMap`
- Missing Shell in newer Docker images HOT 2
- [DOC] Update doc to reflect thread sampling logic required for tracing integration on
- Is there any plan to recovery graphviz and sandwitch button?
- Compilation failed on go 1.23 HOT 1
- Create cron job to update examples automatically regularly
- [DOC] Fix 404s in Pyroscope doc
- [DOC] Update and evaluate client and server install/config/requirements content
- [DOC] Document sourcemaps feature for node.js
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pyroscope.