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 39 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!

@Jayclifford345
Copy link
Author

@knylander-grafana just wondering if you had a chance to take a look? No rush :)

Jayclifford345 and others added 5 commits October 11, 2024 09:55
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
@Jayclifford345
Copy link
Author

Jayclifford345 commented Oct 23, 2024

Hi @knylander-grafana sorry for the late turn around let me know if there are any other areas that need changed. Many thanks again for the review!

@knylander-grafana
Copy link
Contributor

Hi @knylander-grafana sorry for the late turn around let me know if there are any other areas that need changed. Many thanks again for the review!

You're welcome! I'll do another review today.

@Jayclifford345
Copy link
Author

Hi @knylander-grafana

Update

I had time to update the tutorial to only use the Grafana Profiles Explorer. Let me know what you think. Also, the explorer app has been fixed so I have removed the notice from the killercoda tutorial: https://killercoda.com/grafana-dev-testing/course/pyroscope/ride-share-tutorial

@knylander-grafana
Copy link
Contributor

Hi @knylander-grafana

Update

I had time to update the tutorial to only use the Grafana Profiles Explorer. Let me know what you think. Also, the explorer app has been fixed so I have removed the notice from the killercoda tutorial: killercoda.com/grafana-dev-testing/course/pyroscope/ride-share-tutorial

Awesome news! I'll take a look at it today.

@knylander-grafana
Copy link
Contributor

Working on this today.

It should look something like this:
{{< figure max-width="100%" src="/media/docs/pyroscope/ride-share-bottle-neck-3.png" caption="Bottleneck" alt="Bottleneck" >}}
Copy link
Contributor

@knylander-grafana knylander-grafana Nov 1, 2024

Choose a reason for hiding this comment

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

Steps now match the screenshot :)

Copy link
Contributor

@knylander-grafana knylander-grafana 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 for updating the steps to the Explore Profiles app. The steps match what's in the Killercoda environment. Preview looks okay on the page and on Killercoda.

Most of my suggestions are cleanup from the Pyroscope UI to the Explore Profiles app.

Copy link
Contributor

@knylander-grafana knylander-grafana left a comment

Choose a reason for hiding this comment

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

Not sure why this appeared twice.

@knylander-grafana knylander-grafana added the backport release/v1.9 This label will backport a merged PR to the release/v1.9 branch label Nov 1, 2024
Copy link
Contributor

github-actions bot commented Nov 1, 2024

This PR must be merged before a backport PR will be created.

@knylander-grafana
Copy link
Contributor

knylander-grafana commented Nov 1, 2024

@Jayclifford345 I wanted to thank you for writing this tutorial. This is a great contribution.

You signed the CLA, right? Weird that there is one message that says the CLA is needs to be signed and another one has been signed.

Once we work through my comments, then we can get this merged. I'm so excited for this! I wonder if we could include it in the Explore Profiles docs too.

What would you think about sharing the content between both locations?

Jayclifford345 and others added 3 commits November 6, 2024 09:29
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
@Jayclifford345
Copy link
Author

Yeah weird on the CLA I tried to sign again but it says I already signed. That should be all of your changes in thanks again for taking the time to go through it all and the corrections. Ready for your review once again. More than happy for it to go into the Explore Profiles section aswell. Let me know where you think its best place :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release/v1.9 This label will backport a merged PR to the release/v1.9 branch 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