forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "Fix "broken" docs build. (googleapis#3422)"
This reverts commit a849060.
- Loading branch information
Showing
4 changed files
with
38 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,12 +25,14 @@ Authentication and Configuration | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_create_default] | ||
:end-before: [END client_create_default] | ||
:dedent: 4 | ||
|
||
or pass in ``credentials`` and ``project`` explicitly | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_create_explicit] | ||
:end-before: [END client_create_explicit] | ||
:dedent: 4 | ||
|
||
|
||
Writing log entries | ||
|
@@ -43,18 +45,21 @@ which to associate the entries: | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START logger_create] | ||
:end-before: [END logger_create] | ||
:dedent: 4 | ||
|
||
Write a simple text entry to the logger. | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START logger_log_text] | ||
:end-before: [END logger_log_text] | ||
:dedent: 4 | ||
|
||
Write a dictionary entry to the logger. | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START logger_log_struct] | ||
:end-before: [END logger_log_struct] | ||
:dedent: 4 | ||
|
||
|
||
Retrieving log entries | ||
|
@@ -65,12 +70,14 @@ Fetch entries for the default project. | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_list_entries_default] | ||
:end-before: [END client_list_entries_default] | ||
:dedent: 4 | ||
|
||
Fetch entries across multiple projects. | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_list_entries_multi_project] | ||
:end-before: [END client_list_entries_multi_project] | ||
:dedent: 4 | ||
|
||
Filter entries retrieved using the `Advanced Logs Filters`_ syntax | ||
|
||
|
@@ -81,24 +88,28 @@ Fetch entries for the default project. | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_list_entries_filter] | ||
:end-before: [END client_list_entries_filter] | ||
:dedent: 4 | ||
|
||
Sort entries in descending timestamp order. | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_list_entries_order_by] | ||
:end-before: [END client_list_entries_order_by] | ||
:dedent: 4 | ||
|
||
Retrieve entries in batches of 10, iterating until done. | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_list_entries_paged] | ||
:end-before: [END client_list_entries_paged] | ||
:dedent: 4 | ||
|
||
Retrieve entries for a single logger, sorting in descending timestamp order: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START logger_list_entries] | ||
:end-before: [END logger_list_entries] | ||
:dedent: 4 | ||
|
||
|
||
Delete all entries for a logger | ||
|
@@ -107,6 +118,7 @@ Delete all entries for a logger | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START logger_delete] | ||
:end-before: [END logger_delete] | ||
:dedent: 8 | ||
|
||
|
||
Manage log metrics | ||
|
@@ -120,30 +132,35 @@ List all metrics for a project: | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_list_metrics] | ||
:end-before: [END client_list_metrics] | ||
:dedent: 4 | ||
|
||
Create a metric: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START metric_create] | ||
:end-before: [END metric_create] | ||
:dedent: 4 | ||
|
||
Refresh local information about a metric: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START metric_reload] | ||
:end-before: [END metric_reload] | ||
:dedent: 4 | ||
|
||
Update a metric: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START metric_update] | ||
:end-before: [END metric_update] | ||
:dedent: 4 | ||
|
||
Delete a metric: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START metric_delete] | ||
:end-before: [END metric_delete] | ||
:dedent: 4 | ||
|
||
Export log entries using sinks | ||
------------------------------ | ||
|
@@ -165,12 +182,14 @@ Add ``[email protected]`` as the owner of the bucket: | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_bucket_permissions] | ||
:end-before: [END sink_bucket_permissions] | ||
:dedent: 4 | ||
|
||
Create a Cloud Storage sink: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_storage_create] | ||
:end-before: [END sink_storage_create] | ||
:dedent: 4 | ||
|
||
|
||
Export to BigQuery | ||
|
@@ -186,12 +205,14 @@ See: `Setting permissions for BigQuery`_ | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_dataset_permissions] | ||
:end-before: [END sink_dataset_permissions] | ||
:dedent: 4 | ||
|
||
Create a BigQuery sink: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_bigquery_create] | ||
:end-before: [END sink_bigquery_create] | ||
:dedent: 4 | ||
|
||
|
||
Export to Pub/Sub | ||
|
@@ -207,12 +228,14 @@ See: `Setting permissions for Pub/Sub`_ | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_topic_permissions] | ||
:end-before: [END sink_topic_permissions] | ||
:dedent: 4 | ||
|
||
Create a Cloud Pub/Sub sink: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_pubsub_create] | ||
:end-before: [END sink_pubsub_create] | ||
:dedent: 4 | ||
|
||
Manage Sinks | ||
~~~~~~~~~~~~ | ||
|
@@ -222,24 +245,28 @@ List all sinks for a project: | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START client_list_sinks] | ||
:end-before: [END client_list_sinks] | ||
:dedent: 4 | ||
|
||
Refresh local information about a sink: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_reload] | ||
:end-before: [END sink_reload] | ||
:dedent: 4 | ||
|
||
Update a sink: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_update] | ||
:end-before: [END sink_update] | ||
:dedent: 4 | ||
|
||
Delete a sink: | ||
|
||
.. literalinclude:: logging_snippets.py | ||
:start-after: [START sink_delete] | ||
:end-before: [END sink_delete] | ||
:dedent: 4 | ||
|
||
Integration with Python logging module | ||
-------------------------------------- | ||
|
@@ -252,6 +279,7 @@ To automatically pick the default for your current environment, use | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START create_default_handler] | ||
:end-before: [END create_default_handler] | ||
:dedent: 4 | ||
|
||
It is also possible to attach the handler to the root Python logger, so that | ||
for example a plain ``logging.warn`` call would be sent to Stackdriver Logging, | ||
|
@@ -262,6 +290,7 @@ to configure this automatically. | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START setup_logging] | ||
:end-before: [END setup_logging] | ||
:dedent: 4 | ||
|
||
.. note:: | ||
|
||
|
@@ -273,6 +302,7 @@ You can also exclude certain loggers: | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START setup_logging_excludes] | ||
:end-before: [END setup_logging_excludes] | ||
:dedent: 4 | ||
|
||
Cloud Logging Handler | ||
===================== | ||
|
@@ -286,6 +316,7 @@ which will write directly to the API. | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START create_cloud_handler] | ||
:end-before: [END create_cloud_handler] | ||
:dedent: 4 | ||
|
||
.. note:: | ||
|
||
|
@@ -301,6 +332,7 @@ of the Python logger will be included in the structured log entry under the | |
.. literalinclude:: logging_snippets.py | ||
:start-after: [START create_named_handler] | ||
:end-before: [END create_named_handler] | ||
:dedent: 4 | ||
|
||
fluentd logging handlers | ||
======================== | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters