grafana / pyroscope

Continuous Profiling Platform. Debug performance issues down to a single line of code
https://grafana.com/oss/pyroscope/
GNU Affero General Public License v3.0
10.14k stars 614 forks source link

docs: Getting started demo + sandbox #3584

Closed Jayclifford345 closed 2 weeks ago

Jayclifford345 commented 2 months ago

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!

CLAassistant commented 2 months ago

CLA assistant check
All committers have signed the CLA.

CLAassistant commented 2 months ago

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 commented 2 months ago

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

Jayclifford345 commented 1 month ago

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

Jayclifford345 commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

Aaah this is great to know. Okay, I will have time this week to move the example to the Explore Profiles app fully. It shouldn't be too much work. Mostly redoing screenshots and checking to see if the original issue with the Profiles app has been cleared up.

All other review changes accepted just need to add indentations as well. Thanks again :)

Jayclifford345 commented 1 month ago

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 commented 1 month ago

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 commented 4 weeks ago

Working on this today.

github-actions[bot] commented 4 weeks ago

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

knylander-grafana commented 4 weeks ago

@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 commented 3 weeks ago

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 :)

knylander-grafana commented 2 weeks ago

Okay! I'll review this today. :) let's have it in Pyroscope and look at whether we want to include in Explore Profiles too. I'll ask about sharing.

knylander-grafana commented 2 weeks ago

If this looks good to you, would you like me to merge?

Jayclifford345 commented 2 weeks ago

Hi @knylander-grafana, I sadly don't have permission to merge :(. If you wouldn't mind doing the honours!