Skip to content

Add documentation for enabling gRPC logging#2094

Merged
quartzmo merged 6 commits into
googleapis:masterfrom
quartzmo:docs-grpc-logger
May 25, 2018
Merged

Add documentation for enabling gRPC logging#2094
quartzmo merged 6 commits into
googleapis:masterfrom
quartzmo:docs-grpc-logger

Conversation

@quartzmo
Copy link
Copy Markdown
Member

[closes #1907]

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label May 17, 2018
@quartzmo quartzmo requested review from apolcyn, blowmage and dazuma May 17, 2018 17:43
@quartzmo quartzmo self-assigned this May 17, 2018
@quartzmo quartzmo added documentation do not merge Indicates a pull request not ready for merge, due to either quality or timing. grpc labels May 17, 2018
@quartzmo
Copy link
Copy Markdown
Member Author

@blowmage I tried setting the logger as you suggested in #1907, but I got this warning:

irb(main):006:0> GRPC::DefaultLogger::LOGGER = my_logger
(irb):6: warning: already initialized constant GRPC::DefaultLogger::LOGGER

So instead I adapted the suggested example in the gRPC spec_helper.rb. It works, but can anyone suggest a simplification?

Copy link
Copy Markdown
Contributor

@blowmage blowmage left a comment

Choose a reason for hiding this comment

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

This works for me.

The only change I’d offer is to link to the Logger docs for the current Ruby version, which is 2.5.

@blowmage
Copy link
Copy Markdown
Contributor

I agree it should not be as difficult as it is to set a custom Logger. Ideally it should be simply:

GRPC.logger = my_logger

Comment thread google-cloud-datastore/README.md Outdated

This comment was marked as spam.

Comment thread google-cloud-datastore/README.md Outdated

This comment was marked as spam.

This comment was marked as spam.

@quartzmo quartzmo force-pushed the docs-grpc-logger branch from ddd0321 to 9d8a33b Compare May 17, 2018 22:37
@quartzmo
Copy link
Copy Markdown
Member Author

@dazuma Updated, PTAL.

@quartzmo
Copy link
Copy Markdown
Member Author

Thanks for approving, I will copy this change to the READMEs (and "guide" docs where appropriate) for all gRPC packages, then ping for a second look.

@quartzmo quartzmo force-pushed the docs-grpc-logger branch 2 times, most recently from 29c75a8 to 7f25c70 Compare May 23, 2018 22:20
@quartzmo
Copy link
Copy Markdown
Member Author

@jbolinger PTAL at the commit for generated packages. Does this addition look ok? If so, can it also be added in the generator? Should I open an issue in googleapis/gapic-generator?

@quartzmo
Copy link
Copy Markdown
Member Author

@blowmage @dazuma Updated for all gRPC packages, both READMEs and guides, if you want to take a quick look. Text is unchanged from what you approved.

@jbolinger
Copy link
Copy Markdown
Contributor

@quartzmo looks good! Feel free to open an issue there for this or any other changes you think might be useful. This one looks like it's just static text for each client. Adding it to the generator should be no problem.

@quartzmo
Copy link
Copy Markdown
Member Author

@jbolinger I opened googleapis/gapic-generator#2022, "Ruby: Add logging configuration instructions to README and guide docs".

@quartzmo
Copy link
Copy Markdown
Member Author

@jbolinger PTAL, I just added two commits, for changes we discussed in googleapis/gapic-generator#2022 :

  • Move logging docs below Next Steps in READMEs and guides.
  • Add Supported Ruby Versions above Next Steps in READMEs if missing.

@jbolinger
Copy link
Copy Markdown
Contributor

@quartzmo why did you move the version section above the next steps? I thought we said below and at ##, like this: https://gist.github.com/jbolinger/0bcc9b62d4ee84a59fd454c8cc347f6f

@quartzmo
Copy link
Copy Markdown
Member Author

Ah, sorry, I didn't understand. I did it because in a number of the generated READMEs, such as in dataproc for example it is above Next Steps. So, I thought it must be need to be there. However, I'm happy to move it down as in your gist. Will update.

quartzmo added 2 commits May 25, 2018 08:16
Add documentation for enabling gRPC logging.

[refs googleapis#1907]
Add documentation for enabling gRPC logging.

[refs googleapis#1907]
quartzmo added 3 commits May 25, 2018 08:16
Add documentation for enabling gRPC logging.

[closes googleapis#1907]
Move logging docs below Next Steps in READMEs and guides.

[refs googleapis#1907]
Add Supported Ruby Versions above Next Steps in READMEs if missing.

[refs googleapis#1907]
@quartzmo quartzmo force-pushed the docs-grpc-logger branch from fdbedb2 to 3371402 Compare May 25, 2018 16:22
@quartzmo quartzmo force-pushed the docs-grpc-logger branch from 3371402 to 846eb52 Compare May 25, 2018 16:26
@quartzmo
Copy link
Copy Markdown
Member Author

@jbolinger Updated, PTAL. I will squash commits before merging.

@jbolinger
Copy link
Copy Markdown
Contributor

@quartzmo looks good!

@quartzmo quartzmo merged commit 08421bd into googleapis:master May 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement. do not merge Indicates a pull request not ready for merge, due to either quality or timing. grpc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Logging of Google Cloud libraries.

5 participants