Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add intro content from Pyroscope #326

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

knylander-grafana
Copy link
Contributor

✨ Description

Adds intro content and flame graph AI information to the documentation. The intro content is shared from Pyroscope.

Related issue(s): https://github.com/grafana/pyroscope-squad/issues/223

Blocked by grafana/pyroscope#3798 for shared content.

📖 Summary of the changes

🧪 How to test?

Use make docs to create a local build. To view the included files, you'll have to have the pyroscope PR checked out: grafana/pyroscope#3798

@knylander-grafana knylander-grafana added the type/docs Used by Docs team for project management label Dec 20, 2024
@knylander-grafana knylander-grafana self-assigned this Dec 20, 2024
@knylander-grafana knylander-grafana changed the title .docs: Add intro content from Pyroscope docs: Add intro content from Pyroscope Dec 20, 2024
| --------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Collapsed flame graph** | Default: Off | When this feature is active, you can collapse flame graphs to minimize their screen space. |
| **Maximum number of nodes** | Default: 16384 | This number controls the maximum number of nodes, which controls the depth of the flame graph. The higher the number, the more nodes are used in the flame graph. The flame graphs appear longer. |
| **Enable flamegraph.com** | Default: On | Adds a `flamegraph.com` export option to the **Export flame graph** menu. Flame graphs uploaded to `flamegraph.com` have a publicly accessible URL. Deactivate this option if data privacy is a concern. |
Copy link
Contributor

@grafakus grafakus Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As done below, let's also comment out the "flamegraph.com" settings here.


## Before you begin

You need to have administrator privileges in your Grafana instance to be view and modify the Explore Profiles settings.
Copy link
Contributor

@grafakus grafakus Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explore Profiles has a custom Settings page that's been implemented in the app, which is different from the Grafana Plugin page under the "Administration" menu. Thus, the administrator privileges do not apply to modify the app settings.

Copy link
Contributor

@grafakus grafakus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Kim! Just a couple of suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs type/docs Used by Docs team for project management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants