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: Getting started demo + sandbox #3584

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

Conversation

Jayclifford345
Copy link

I have added a getting-started demo based on the ride-share app. This takes users through the basics of using Pyroscope to identify a bottleneck within the application code provided. This tutorial also provides a interactive sandbox for the user to try out this demo: https://killercoda.com/grafana-dev-testing/course/pyroscope/ride-share-tutorial

Unfortunately, there is an unusual bug within the Profile Explorer app (when using the sandbox) for which I am seeing help. For now, I have tagged this within the sandbox and once fixed will remove the notice. The rest of the sandbox which uses the Pyroscope UI works great! There is also a grafana play link so they can try this there

{{<docs/ignore>}}
{{< admonition type="tip" >}}
Unfortunately, due to a bug within the Sandbox environment, the profile explorer app is currently unavailable. We are working on a fix and will update this tutorial once resolved. If you would like to try out the profile explorer app, you can run the example locally on your machine. Or you can try out this example in [Grafana Play](https://play.grafana.org/a/grafana-pyroscope-app/profiles-explorer?searchText=&panelType=time-series&layout=grid&hideNoData=off&explorationType=labels&var-serviceName=pyroscope-rideshare-python&var-profileMetricId=process_cpu:cpu:nanoseconds:cpu:nanoseconds&var-dataSource=grafanacloud-profiles&var-groupBy=all&var-filters=)
{{< /admonition >}}
{{</docs/ignore>}}

I belive for now the rest of the demo is good enough to get out there. Many thanks in advance for the review!

@Jayclifford345 Jayclifford345 requested review from a team as code owners September 23, 2024 13:51
@CLAassistant
Copy link

CLAassistant commented Sep 23, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@knylander-grafana knylander-grafana self-assigned this Sep 24, 2024
@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label Sep 24, 2024
@knylander-grafana
Copy link
Contributor

I'll be looking at this today and tomorrow. Thank you!

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

Successfully merging this pull request may close these issues.

3 participants