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

Replace "dynamically injects bytecode" in Python zero-code instrumentation #5130

Merged

Conversation

CFly17
Copy link
Contributor

@CFly17 CFly17 commented Aug 30, 2024

Update/clarify the automatic instrumentation method for Python zero-code instrumentation

  • replace "dynamically injects bytecode" in Introduction section with a brief description of monkey patching
  • add details to Setup section about how the opentelemetry-bootstrap -a install command uses monkey patching

@cartermp
Copy link
Contributor

/fix:refcache

@opentelemetrybot
Copy link
Collaborator

You triggered fix:refcache action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10638770943

@opentelemetrybot
Copy link
Collaborator

fix:refcache was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@cartermp cartermp added the sig-approval-missing Co-owning SIG didn't provide an approval label Aug 30, 2024
@cartermp
Copy link
Contributor

@open-telemetry/python-approvers PTAL!

content/en/docs/zero-code/python/_index.md Outdated Show resolved Hide resolved
@CFly17
Copy link
Contributor Author

CFly17 commented Sep 3, 2024

/fix:refcache

@opentelemetrybot
Copy link
Collaborator

You triggered fix:refcache action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10675267603

@opentelemetrybot
Copy link
Collaborator

fix:refcache failed or was cancelled. For details, see https://github.com/open-telemetry/opentelemetry.io/actions/runs/10675267603.

@theletterf theletterf requested a review from xrmx September 3, 2024 09:44
Copy link
Contributor

@xrmx xrmx left a comment

Choose a reason for hiding this comment

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

With the refcache fixed LGTM

@theletterf
Copy link
Member

/fix:refcache

@opentelemetrybot
Copy link
Collaborator

You triggered fix:refcache action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10681135620

@opentelemetrybot
Copy link
Collaborator

fix:refcache was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@theletterf theletterf added this pull request to the merge queue Sep 3, 2024
Merged via the queue into open-telemetry:main with commit f711eb1 Sep 3, 2024
17 checks passed
@@ -1711,6 +1711,10 @@
"StatusCode": 200,
"LastSeen": "2024-01-18T19:55:51.433612-05:00"
},
"https://docs.pytest.org/en/stable/how-to/monkeypatch.html#monkeypatching-functions": {
Copy link
Contributor

@xrmx xrmx Sep 3, 2024

Choose a reason for hiding this comment

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

I think this chunk is not needed, looks like fix:refcache only adds entries

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review @xrmx. It means a lot; this is my first contribution to open source.

I was unfamiliar with comment-triggered actions like /fix:refcache. Should only maintainers do this?

I am also reading the contributing process and wonder if there a 'checklist' to clean up my local before committing, e.g. npx prettier --write?

Copy link
Member

Choose a reason for hiding this comment

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

Hey @CFly17! Thanks for your contribution, happy to read that you choose otel for being your first!

The /fix:* commands are just automations we use run the npm fix:* commands without pulling your PR, running it locally and pusing it back. You may want to run npm fix:all before pushing your PR, but since we sometimes do inline changes, etc. we have no issues with a PR that has failing CI checks. The thing that counts is that those checks are green shortly before merging the PR, and this can either be done by you or by a maintainer.

Note, that this is how we (OTel Docs Maintainer) are doing it, other OSS projects might choose a different approach

michael2893 pushed a commit to michael2893/opentelemetry.io that referenced this pull request Sep 8, 2024
…ation (open-telemetry#5130)

Co-authored-by: opentelemetrybot <[email protected]>
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sig:python sig-approval-missing Co-owning SIG didn't provide an approval
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

7 participants