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

docs: update usage guide for v3.0.0 #456

Merged
merged 28 commits into from
Jan 26, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
a5c36d7
added empty v3.0.0 section to UPGRADING.md
daniel-sanche Dec 7, 2021
0ff7048
reorganized table of contents
daniel-sanche Dec 7, 2021
68e7f9d
marked old handlers as deprecated
daniel-sanche Dec 7, 2021
ff046f5
removed duplicated stdlib doc
daniel-sanche Dec 8, 2021
2e5fd18
made some progress on standard library integration doc
daniel-sanche Dec 8, 2021
51d2a9a
added more stdlib documentation
daniel-sanche Dec 8, 2021
fcc239b
finished up stdlib docs
daniel-sanche Dec 9, 2021
5826ce3
added page for direct API usage
daniel-sanche Dec 9, 2021
205d915
copied old usage guide info
daniel-sanche Dec 9, 2021
98a0a8c
working on setup section
daniel-sanche Dec 10, 2021
117e619
added log writing docs
daniel-sanche Dec 10, 2021
913a08c
removed references to POST requests
daniel-sanche Dec 10, 2021
29ea7d4
added batching info
daniel-sanche Dec 10, 2021
e822bd0
added transport docs
daniel-sanche Dec 10, 2021
8bce609
added grpc vs http docs
daniel-sanche Dec 10, 2021
eac5e2d
added upgrading notes
daniel-sanche Dec 14, 2021
01a0e33
improved manual handler section
daniel-sanche Jan 14, 2022
0526955
fixed lint issues
daniel-sanche Jan 15, 2022
a91b5f4
fixed snippet issue
daniel-sanche Jan 24, 2022
0ad37c8
addressed Drew's comments
daniel-sanche Jan 24, 2022
fd314b9
incorporated Pamela's feedback to migration guide
daniel-sanche Jan 25, 2022
95e5890
updated formatting
daniel-sanche Jan 26, 2022
51a7cd5
updated wording
daniel-sanche Jan 26, 2022
69209b1
changed wording
daniel-sanche Jan 26, 2022
741dfac
addressed Pamela's comments on the direct library usage document
daniel-sanche Jan 26, 2022
49dc3c3
incorporated Pamela's feedback in std lib integration doc
daniel-sanche Jan 26, 2022
ef947d3
removed unneeded delete lines
daniel-sanche Jan 26, 2022
1ff01aa
switched client for tests
daniel-sanche Jan 26, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
removed duplicated stdlib doc
  • Loading branch information
daniel-sanche committed Dec 8, 2021
commit ff046f5ca6cafaa49972b9ac4e9a4754e85ecfc0
9 changes: 7 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
.. include:: README.rst

Usage Guide
-------------------
.. toctree::
:maxdepth: 2

usage

Documentation
-------------------
.. toctree::
:maxdepth: 3

usage
stdlib-usage
client
logger
entries
Expand Down
70 changes: 0 additions & 70 deletions docs/stdlib-usage.rst

This file was deleted.

12 changes: 6 additions & 6 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -250,8 +250,8 @@ Delete a sink:
:end-before: [END sink_delete]
:dedent: 4

Integration with Python logging module
--------------------------------------
Integration with `logging` Standard Library
===========================================

It's possible to tie the Python :mod:`logging` module directly into Google
Cloud Logging. There are different handler options to accomplish this.
Expand Down Expand Up @@ -286,8 +286,8 @@ You can also exclude certain loggers:
:end-before: [END setup_logging_excludes]
:dedent: 4

Cloud Logging Handler
~~~~~~~~~~~~~~~~~~~~~
Manual Handler
---------------------

If you prefer not to use
:meth:`~google.cloud.logging.client.Client.get_default_handler`, you can
Expand Down Expand Up @@ -317,7 +317,7 @@ of the Python logger will be included in the structured log entry under the
:dedent: 4

Cloud Logging Handler transports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------

The :class:`~google.cloud.logging.handlers.handlers.CloudLoggingHandler`
logging handler can use different transports. The default is
Expand All @@ -334,7 +334,7 @@ logging handler can use different transports. The default is
.. _Google Kubernetes Engine: https://cloud.google.com/kubernetes-engine

fluentd logging handlers
~~~~~~~~~~~~~~~~~~~~~~~~
------------------------

Besides :class:`~google.cloud.logging.handlers.handlers.CloudLoggingHandler`,
which writes directly to the API, two other handlers are provided.
Expand Down