Skip to content

Update .instrument() call response_hook argument name in the documentation for Botocore and Pymongo #1015

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

Merged

Conversation

rahulgupta92
Copy link
Contributor

@rahulgupta92 rahulgupta92 commented Mar 21, 2022

Description

The current documentation for Botocore and Pymongo instrumentation has incorrectly specified the argument response_hook as response_hooks for the .instrument() call. This PR fixes the argument name to use response_hook instead.

Correct Format:
BotocoreInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)

PymongoInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook, failed_hook=failed_hook)

Type of change

  • This change requires a documentation update

How Has This Been Tested?

All tests of the project have been run.

Does This PR Require a Core Repo Change?

  • No.

Checklist:

  • Documentation has been updated

@rahulgupta92 rahulgupta92 requested a review from a team March 21, 2022 12:04
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 21, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
Member

@srikanthccv srikanthccv 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 @rahulgupta92. Please sign the CLA.

@srikanthccv srikanthccv added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 21, 2022
@rahulgupta92
Copy link
Contributor Author

Thank you @rahulgupta92. Please sign the CLA.

Have signed the CLA @srikanthccv

@srikanthccv
Copy link
Member

/easycla

@srikanthccv
Copy link
Member

@rahulgupta92 Either you didn't sign the cla completely or EasyCLA is not working. Please check again.

@rahulgupta92
Copy link
Contributor Author

@rahulgupta92 Either you didn't sign the cla completely or EasyCLA is not working. Please check again.

@srikanthccv I have signed multiple times now as an Individual Contributor but it redirects me to this page after signing it successfully without any change in the PR status. Anything which i am missing? Does this need to be done via Corporate Contributor route only?

@rahulgupta92 rahulgupta92 force-pushed the update-response-hook-documentation branch from aeeb8ad to 4d0f3b5 Compare March 21, 2022 18:44
@ocelotl ocelotl merged commit f8b877e into open-telemetry:main Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants