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

Typos in gRPC instrumentation example codes #1239

Closed
ymotongpoo opened this issue Aug 24, 2022 · 0 comments · Fixed by #1240
Closed

Typos in gRPC instrumentation example codes #1239

ymotongpoo opened this issue Aug 24, 2022 · 0 comments · Fixed by #1240
Labels
bug Something isn't working

Comments

@ymotongpoo
Copy link
Contributor

Describe your environment

  • Platform: any
  • Python version: any
  • Library version: main HEAD as of Aug 24th

Steps to reproduce
See documents for gRPC instrumentation

What is the expected behavior?
For client instrumentation example, I would see either of the followings:

  1. GrpcInstrumentorClient().instrument() is called without return value assignment.
  2. Get the return value of GrpcInstrumentorClient() and call instrument() method of it.

What is the actual behavior?

I see the following example codes.

In the Usage Client section:

instrumentor = GrpcInstrumentorClient().instrument()

And in the GrpcInstrumentorClient class document:

grpc_client_instrumentor = GrpcInstrumentorClient()
grpc.client_instrumentor.instrument()

where 2nd line is calling non existing package. It should be typo of the variable defined in 1st line.

Additional context

I was trying implement the code to fix #373 and found this issue, so I created separate issue here. I'll create a PR for this shortly.

@ymotongpoo ymotongpoo added the bug Something isn't working label Aug 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant