@@ -8,21 +8,21 @@ To write log entries, first create a
8
8
:class: `~google.cloud.logging.logger.Logger `, passing the "log name" with
9
9
which to associate the entries:
10
10
11
- .. literalinclude :: snippets.py
11
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
12
12
:start-after: [START logger_create]
13
13
:end-before: [END logger_create]
14
14
:dedent: 4
15
15
16
16
Write a simple text entry to the logger.
17
17
18
- .. literalinclude :: snippets.py
18
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
19
19
:start-after: [START logger_log_text]
20
20
:end-before: [END logger_log_text]
21
21
:dedent: 4
22
22
23
23
Write a dictionary entry to the logger.
24
24
25
- .. literalinclude :: snippets.py
25
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
26
26
:start-after: [START logger_log_struct]
27
27
:end-before: [END logger_log_struct]
28
28
:dedent: 4
@@ -34,7 +34,7 @@ Supported Resource values are listed at `Monitored Resource Types`_
34
34
.. _Monitored Resource Types : https://cloud.google.com/logging/docs/api/v2/resource-list
35
35
36
36
37
- .. literalinclude :: snippets.py
37
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
38
38
:start-after: [START logger_log_resource_text]
39
39
:end-before: [END logger_log_resource_text]
40
40
:dedent: 4
@@ -44,7 +44,7 @@ Retrieving log entries
44
44
45
45
Fetch entries for the default project.
46
46
47
- .. literalinclude :: snippets.py
47
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
48
48
:start-after: [START client_list_entries_default]
49
49
:end-before: [END client_list_entries_default]
50
50
:dedent: 4
@@ -59,41 +59,27 @@ will be instances of one of the following classes:
59
59
- :class: `~google.cloud.logging.entries.StructEntry `
60
60
- :class: `~google.cloud.logging.entries.ProtobufEntry `
61
61
62
- Fetch entries across multiple projects.
63
-
64
- .. literalinclude :: snippets.py
65
- :start-after: [START client_list_entries_multi_project]
66
- :end-before: [END client_list_entries_multi_project]
67
- :dedent: 4
68
-
69
62
Filter entries retrieved using the `Advanced Logs Filters `_ syntax
70
63
71
64
.. _Advanced Logs Filters : https://cloud.google.com/logging/docs/view/advanced_filters
72
65
73
66
Fetch entries for the default project.
74
67
75
- .. literalinclude :: snippets.py
68
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
76
69
:start-after: [START client_list_entries_filter]
77
70
:end-before: [END client_list_entries_filter]
78
71
:dedent: 4
79
72
80
73
Sort entries in descending timestamp order.
81
74
82
- .. literalinclude :: snippets.py
75
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
83
76
:start-after: [START client_list_entries_order_by]
84
77
:end-before: [END client_list_entries_order_by]
85
78
:dedent: 4
86
79
87
- Retrieve entries in batches of 10, iterating until done.
88
-
89
- .. literalinclude :: snippets.py
90
- :start-after: [START client_list_entries_paged]
91
- :end-before: [END client_list_entries_paged]
92
- :dedent: 4
93
-
94
80
Retrieve entries for a single logger, sorting in descending timestamp order:
95
81
96
- .. literalinclude :: snippets.py
82
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
97
83
:start-after: [START logger_list_entries]
98
84
:end-before: [END logger_list_entries]
99
85
:dedent: 4
@@ -102,7 +88,7 @@ Retrieve entries for a single logger, sorting in descending timestamp order:
102
88
Delete all entries for a logger
103
89
-------------------------------
104
90
105
- .. literalinclude :: snippets.py
91
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
106
92
:start-after: [START logger_delete]
107
93
:end-before: [END logger_delete]
108
94
:dedent: 8
@@ -116,35 +102,35 @@ used within Cloud Monitoring to create charts and alerts.
116
102
117
103
List all metrics for a project:
118
104
119
- .. literalinclude :: snippets.py
105
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
120
106
:start-after: [START client_list_metrics]
121
107
:end-before: [END client_list_metrics]
122
108
:dedent: 4
123
109
124
110
Create a metric:
125
111
126
- .. literalinclude :: snippets.py
112
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
127
113
:start-after: [START metric_create]
128
114
:end-before: [END metric_create]
129
115
:dedent: 4
130
116
131
117
Refresh local information about a metric:
132
118
133
- .. literalinclude :: snippets.py
119
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
134
120
:start-after: [START metric_reload]
135
121
:end-before: [END metric_reload]
136
122
:dedent: 4
137
123
138
124
Update a metric:
139
125
140
- .. literalinclude :: snippets.py
126
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
141
127
:start-after: [START metric_update]
142
128
:end-before: [END metric_update]
143
129
:dedent: 4
144
130
145
131
Delete a metric:
146
132
147
- .. literalinclude :: snippets.py
133
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
148
134
:start-after: [START metric_delete]
149
135
:end-before: [END metric_delete]
150
136
:dedent: 4
@@ -166,14 +152,14 @@ Make sure that the storage bucket you want to export logs too has
166
152
167
153
Add ``
[email protected] `` as the owner of the bucket:
168
154
169
- .. literalinclude :: snippets.py
155
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
170
156
:start-after: [START sink_bucket_permissions]
171
157
:end-before: [END sink_bucket_permissions]
172
158
:dedent: 4
173
159
174
160
Create a Cloud Storage sink:
175
161
176
- .. literalinclude :: snippets.py
162
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
177
163
:start-after: [START sink_storage_create]
178
164
:end-before: [END sink_storage_create]
179
165
:dedent: 4
@@ -189,14 +175,14 @@ See: `Setting permissions for BigQuery`_
189
175
190
176
.. _Setting permissions for BigQuery : https://cloud.google.com/logging/docs/export/configure_export_v2#errors_exporting_to_bigquery
191
177
192
- .. literalinclude :: snippets.py
178
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
193
179
:start-after: [START sink_dataset_permissions]
194
180
:end-before: [END sink_dataset_permissions]
195
181
:dedent: 4
196
182
197
183
Create a BigQuery sink:
198
184
199
- .. literalinclude :: snippets.py
185
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
200
186
:start-after: [START sink_bigquery_create]
201
187
:end-before: [END sink_bigquery_create]
202
188
:dedent: 4
@@ -212,14 +198,14 @@ See: `Setting permissions for Pub/Sub`_
212
198
213
199
.. _Setting permissions for Pub/Sub : https://cloud.google.com/logging/docs/export/configure_export_v2#errors_exporting_logs_to_cloud_pubsub
214
200
215
- .. literalinclude :: snippets.py
201
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
216
202
:start-after: [START sink_topic_permissions]
217
203
:end-before: [END sink_topic_permissions]
218
204
:dedent: 4
219
205
220
206
Create a Cloud Pub/Sub sink:
221
207
222
- .. literalinclude :: snippets.py
208
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
223
209
:start-after: [START sink_pubsub_create]
224
210
:end-before: [END sink_pubsub_create]
225
211
:dedent: 4
@@ -229,28 +215,28 @@ Manage Sinks
229
215
230
216
List all sinks for a project:
231
217
232
- .. literalinclude :: snippets.py
218
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
233
219
:start-after: [START client_list_sinks]
234
220
:end-before: [END client_list_sinks]
235
221
:dedent: 4
236
222
237
223
Refresh local information about a sink:
238
224
239
- .. literalinclude :: snippets.py
225
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
240
226
:start-after: [START sink_reload]
241
227
:end-before: [END sink_reload]
242
228
:dedent: 4
243
229
244
230
Update a sink:
245
231
246
- .. literalinclude :: snippets.py
232
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
247
233
:start-after: [START sink_update]
248
234
:end-before: [END sink_update]
249
235
:dedent: 4
250
236
251
237
Delete a sink:
252
238
253
- .. literalinclude :: snippets.py
239
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
254
240
:start-after: [START sink_delete]
255
241
:end-before: [END sink_delete]
256
242
:dedent: 4
@@ -263,7 +249,7 @@ Cloud Logging. There are different handler options to accomplish this.
263
249
To automatically pick the default for your current environment, use
264
250
:meth: `~google.cloud.logging.client.Client.get_default_handler `.
265
251
266
- .. literalinclude :: snippets.py
252
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
267
253
:start-after: [START create_default_handler]
268
254
:end-before: [END create_default_handler]
269
255
:dedent: 4
@@ -274,7 +260,7 @@ as well as any other loggers created. A helper method
274
260
:meth: `~google.cloud.logging.client.Client.setup_logging ` is provided
275
261
to configure this automatically.
276
262
277
- .. literalinclude :: snippets.py
263
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
278
264
:start-after: [START setup_logging]
279
265
:end-before: [END setup_logging]
280
266
:dedent: 4
@@ -286,7 +272,7 @@ to configure this automatically.
286
272
287
273
You can also exclude certain loggers:
288
274
289
- .. literalinclude :: snippets.py
275
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
290
276
:start-after: [START setup_logging_excludes]
291
277
:end-before: [END setup_logging_excludes]
292
278
:dedent: 4
@@ -300,7 +286,7 @@ directly create a
300
286
:class: `~google.cloud.logging.handlers.handlers.CloudLoggingHandler ` instance
301
287
which will write directly to the API.
302
288
303
- .. literalinclude :: snippets.py
289
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
304
290
:start-after: [START create_cloud_handler]
305
291
:end-before: [END create_cloud_handler]
306
292
:dedent: 4
@@ -316,7 +302,7 @@ All logs will go to a single custom log, which defaults to "python". The name
316
302
of the Python logger will be included in the structured log entry under the
317
303
"python_logger" field. You can change it by providing a name to the handler:
318
304
319
- .. literalinclude :: snippets.py
305
+ .. literalinclude :: ../samples/ snippets/usage_guide .py
320
306
:start-after: [START create_named_handler]
321
307
:end-before: [END create_named_handler]
322
308
:dedent: 4
0 commit comments