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

Example and docs for Python span profiles #3252

Merged
merged 4 commits into from
Apr 26, 2024
Merged

Conversation

aleks-p
Copy link
Contributor

@aleks-p aleks-p commented Apr 25, 2024

  • enables OpenTelemetry based tracing in the Python ride share Flask example
  • adds the Python ride share Flask app to examples/tracing/tempo, to demonstrate span profiles in Python
  • adds docs for Python span profiles

@aleks-p aleks-p requested review from a team as code owners April 25, 2024 13:40
@@ -36,7 +36,7 @@ To use Span Profiles, you need to:
Your applications must be instrumented for profiling and tracing before you can use span profiles.

* Profiling: Your application must be instrumented with Pyroscope's .NET instrumentation library. Refer to the [.NET]({{< relref "../language-sdks/dotnet" >}}) guide for instructions.
* Tracing: Your application must be instrumented with OpenTelemetry traces. Refer to the [OpenTelemetry](https://opentelemetry.io/docs/net/getting-started/) guide for isntructions.
* Tracing: Your application must be instrumented with OpenTelemetry traces. Refer to the [OpenTelemetry](https://opentelemetry.io/docs/languages/net/getting-started/) guide for isntructions.
Copy link
Contributor

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

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 docs! The updates look good. I'm leaving a comment only, since I can't approve the other code changes.

@knylander-grafana knylander-grafana added the type/docs Improvements for doc docs. Used by Docs team for project management label Apr 25, 2024
@knylander-grafana
Copy link
Contributor

Do you want to backport this PR to 1.5 so it will be published before the next release?

@aleks-p aleks-p added the backport release/v1.5 This label will backport a merged PR to the release/v1.5 branch label Apr 25, 2024
Copy link
Contributor

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

aleks-p and others added 4 commits April 26, 2024 08:19
Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Anton Kolesnikov <anton.e.kolesnikov@gmail.com>
@aleks-p aleks-p force-pushed the example/python-span-profiles branch from 7779324 to 9034445 Compare April 26, 2024 11:20
@aleks-p aleks-p merged commit 960fc32 into main Apr 26, 2024
16 checks passed
@aleks-p aleks-p deleted the example/python-span-profiles branch April 26, 2024 11:27
Copy link
Contributor

The backport to release/v1.5 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-3252-to-release/v1.5 origin/release/v1.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 960fc3221b738f4cf374ffa29ae3528588435313

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-3252-to-release/v1.5
# Create the PR body template
PR_BODY=$(gh pr view 3252 --json body --template 'Backport 960fc3221b738f4cf374ffa29ae3528588435313 from #3252{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "[release/v1.5] Example and docs for Python span profiles" --body-file - --label "type/docs" --label "backport" --base release/v1.5 --milestone release/v1.5 --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-3252-to-release/v1.5

# Create a pull request where the `base` branch is `release/v1.5` and the `compare`/`head` branch is `backport-3252-to-release/v1.5`.

# Remove the local backport branch
git switch main
git branch -D backport-3252-to-release/v1.5

aleks-p added a commit that referenced this pull request Apr 26, 2024
* Add example for Python span profiles

* Add docs for Python span profiles

* Apply suggestions from code review

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/configure-client/trace-span-profiles/_index.md

Co-authored-by: Anton Kolesnikov <anton.e.kolesnikov@gmail.com>

---------

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Anton Kolesnikov <anton.e.kolesnikov@gmail.com>
(cherry picked from commit 960fc32)
aleks-p added a commit that referenced this pull request Apr 29, 2024
* Add example for Python span profiles

* Add docs for Python span profiles

* Apply suggestions from code review

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>

* Update docs/sources/configure-client/trace-span-profiles/_index.md

Co-authored-by: Anton Kolesnikov <anton.e.kolesnikov@gmail.com>

---------

Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
Co-authored-by: Anton Kolesnikov <anton.e.kolesnikov@gmail.com>
(cherry picked from commit 960fc32)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release/v1.5 This label will backport a merged PR to the release/v1.5 branch backport-failed 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.

None yet

3 participants