Skip to content

Commit 1ca3981

Browse files
docs: fix usage guide (#140)
1 parent ba94afb commit 1ca3981

File tree

4 files changed

+192
-152
lines changed

4 files changed

+192
-152
lines changed

docs/usage.rst

Lines changed: 29 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@ To write log entries, first create a
88
:class:`~google.cloud.logging.logger.Logger`, passing the "log name" with
99
which to associate the entries:
1010

11-
.. literalinclude:: snippets.py
11+
.. literalinclude:: ../samples/snippets/usage_guide.py
1212
:start-after: [START logger_create]
1313
:end-before: [END logger_create]
1414
:dedent: 4
1515

1616
Write a simple text entry to the logger.
1717

18-
.. literalinclude:: snippets.py
18+
.. literalinclude:: ../samples/snippets/usage_guide.py
1919
:start-after: [START logger_log_text]
2020
:end-before: [END logger_log_text]
2121
:dedent: 4
2222

2323
Write a dictionary entry to the logger.
2424

25-
.. literalinclude:: snippets.py
25+
.. literalinclude:: ../samples/snippets/usage_guide.py
2626
:start-after: [START logger_log_struct]
2727
:end-before: [END logger_log_struct]
2828
:dedent: 4
@@ -34,7 +34,7 @@ Supported Resource values are listed at `Monitored Resource Types`_
3434
.. _Monitored Resource Types: https://cloud.google.com/logging/docs/api/v2/resource-list
3535

3636

37-
.. literalinclude:: snippets.py
37+
.. literalinclude:: ../samples/snippets/usage_guide.py
3838
:start-after: [START logger_log_resource_text]
3939
:end-before: [END logger_log_resource_text]
4040
:dedent: 4
@@ -44,7 +44,7 @@ Retrieving log entries
4444

4545
Fetch entries for the default project.
4646

47-
.. literalinclude:: snippets.py
47+
.. literalinclude:: ../samples/snippets/usage_guide.py
4848
:start-after: [START client_list_entries_default]
4949
:end-before: [END client_list_entries_default]
5050
:dedent: 4
@@ -59,41 +59,27 @@ will be instances of one of the following classes:
5959
- :class:`~google.cloud.logging.entries.StructEntry`
6060
- :class:`~google.cloud.logging.entries.ProtobufEntry`
6161

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-
6962
Filter entries retrieved using the `Advanced Logs Filters`_ syntax
7063

7164
.. _Advanced Logs Filters: https://cloud.google.com/logging/docs/view/advanced_filters
7265

7366
Fetch entries for the default project.
7467

75-
.. literalinclude:: snippets.py
68+
.. literalinclude:: ../samples/snippets/usage_guide.py
7669
:start-after: [START client_list_entries_filter]
7770
:end-before: [END client_list_entries_filter]
7871
:dedent: 4
7972

8073
Sort entries in descending timestamp order.
8174

82-
.. literalinclude:: snippets.py
75+
.. literalinclude:: ../samples/snippets/usage_guide.py
8376
:start-after: [START client_list_entries_order_by]
8477
:end-before: [END client_list_entries_order_by]
8578
:dedent: 4
8679

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-
9480
Retrieve entries for a single logger, sorting in descending timestamp order:
9581

96-
.. literalinclude:: snippets.py
82+
.. literalinclude:: ../samples/snippets/usage_guide.py
9783
:start-after: [START logger_list_entries]
9884
:end-before: [END logger_list_entries]
9985
:dedent: 4
@@ -102,7 +88,7 @@ Retrieve entries for a single logger, sorting in descending timestamp order:
10288
Delete all entries for a logger
10389
-------------------------------
10490

105-
.. literalinclude:: snippets.py
91+
.. literalinclude:: ../samples/snippets/usage_guide.py
10692
:start-after: [START logger_delete]
10793
:end-before: [END logger_delete]
10894
:dedent: 8
@@ -116,35 +102,35 @@ used within Cloud Monitoring to create charts and alerts.
116102

117103
List all metrics for a project:
118104

119-
.. literalinclude:: snippets.py
105+
.. literalinclude:: ../samples/snippets/usage_guide.py
120106
:start-after: [START client_list_metrics]
121107
:end-before: [END client_list_metrics]
122108
:dedent: 4
123109

124110
Create a metric:
125111

126-
.. literalinclude:: snippets.py
112+
.. literalinclude:: ../samples/snippets/usage_guide.py
127113
:start-after: [START metric_create]
128114
:end-before: [END metric_create]
129115
:dedent: 4
130116

131117
Refresh local information about a metric:
132118

133-
.. literalinclude:: snippets.py
119+
.. literalinclude:: ../samples/snippets/usage_guide.py
134120
:start-after: [START metric_reload]
135121
:end-before: [END metric_reload]
136122
:dedent: 4
137123

138124
Update a metric:
139125

140-
.. literalinclude:: snippets.py
126+
.. literalinclude:: ../samples/snippets/usage_guide.py
141127
:start-after: [START metric_update]
142128
:end-before: [END metric_update]
143129
:dedent: 4
144130

145131
Delete a metric:
146132

147-
.. literalinclude:: snippets.py
133+
.. literalinclude:: ../samples/snippets/usage_guide.py
148134
:start-after: [START metric_delete]
149135
:end-before: [END metric_delete]
150136
:dedent: 4
@@ -166,14 +152,14 @@ Make sure that the storage bucket you want to export logs too has
166152

167153
Add ``[email protected]`` as the owner of the bucket:
168154

169-
.. literalinclude:: snippets.py
155+
.. literalinclude:: ../samples/snippets/usage_guide.py
170156
:start-after: [START sink_bucket_permissions]
171157
:end-before: [END sink_bucket_permissions]
172158
:dedent: 4
173159

174160
Create a Cloud Storage sink:
175161

176-
.. literalinclude:: snippets.py
162+
.. literalinclude:: ../samples/snippets/usage_guide.py
177163
:start-after: [START sink_storage_create]
178164
:end-before: [END sink_storage_create]
179165
:dedent: 4
@@ -189,14 +175,14 @@ See: `Setting permissions for BigQuery`_
189175

190176
.. _Setting permissions for BigQuery: https://cloud.google.com/logging/docs/export/configure_export_v2#errors_exporting_to_bigquery
191177

192-
.. literalinclude:: snippets.py
178+
.. literalinclude:: ../samples/snippets/usage_guide.py
193179
:start-after: [START sink_dataset_permissions]
194180
:end-before: [END sink_dataset_permissions]
195181
:dedent: 4
196182

197183
Create a BigQuery sink:
198184

199-
.. literalinclude:: snippets.py
185+
.. literalinclude:: ../samples/snippets/usage_guide.py
200186
:start-after: [START sink_bigquery_create]
201187
:end-before: [END sink_bigquery_create]
202188
:dedent: 4
@@ -212,14 +198,14 @@ See: `Setting permissions for Pub/Sub`_
212198

213199
.. _Setting permissions for Pub/Sub: https://cloud.google.com/logging/docs/export/configure_export_v2#errors_exporting_logs_to_cloud_pubsub
214200

215-
.. literalinclude:: snippets.py
201+
.. literalinclude:: ../samples/snippets/usage_guide.py
216202
:start-after: [START sink_topic_permissions]
217203
:end-before: [END sink_topic_permissions]
218204
:dedent: 4
219205

220206
Create a Cloud Pub/Sub sink:
221207

222-
.. literalinclude:: snippets.py
208+
.. literalinclude:: ../samples/snippets/usage_guide.py
223209
:start-after: [START sink_pubsub_create]
224210
:end-before: [END sink_pubsub_create]
225211
:dedent: 4
@@ -229,28 +215,28 @@ Manage Sinks
229215

230216
List all sinks for a project:
231217

232-
.. literalinclude:: snippets.py
218+
.. literalinclude:: ../samples/snippets/usage_guide.py
233219
:start-after: [START client_list_sinks]
234220
:end-before: [END client_list_sinks]
235221
:dedent: 4
236222

237223
Refresh local information about a sink:
238224

239-
.. literalinclude:: snippets.py
225+
.. literalinclude:: ../samples/snippets/usage_guide.py
240226
:start-after: [START sink_reload]
241227
:end-before: [END sink_reload]
242228
:dedent: 4
243229

244230
Update a sink:
245231

246-
.. literalinclude:: snippets.py
232+
.. literalinclude:: ../samples/snippets/usage_guide.py
247233
:start-after: [START sink_update]
248234
:end-before: [END sink_update]
249235
:dedent: 4
250236

251237
Delete a sink:
252238

253-
.. literalinclude:: snippets.py
239+
.. literalinclude:: ../samples/snippets/usage_guide.py
254240
:start-after: [START sink_delete]
255241
:end-before: [END sink_delete]
256242
:dedent: 4
@@ -263,7 +249,7 @@ Cloud Logging. There are different handler options to accomplish this.
263249
To automatically pick the default for your current environment, use
264250
:meth:`~google.cloud.logging.client.Client.get_default_handler`.
265251

266-
.. literalinclude:: snippets.py
252+
.. literalinclude:: ../samples/snippets/usage_guide.py
267253
:start-after: [START create_default_handler]
268254
:end-before: [END create_default_handler]
269255
:dedent: 4
@@ -274,7 +260,7 @@ as well as any other loggers created. A helper method
274260
:meth:`~google.cloud.logging.client.Client.setup_logging` is provided
275261
to configure this automatically.
276262

277-
.. literalinclude:: snippets.py
263+
.. literalinclude:: ../samples/snippets/usage_guide.py
278264
:start-after: [START setup_logging]
279265
:end-before: [END setup_logging]
280266
:dedent: 4
@@ -286,7 +272,7 @@ to configure this automatically.
286272

287273
You can also exclude certain loggers:
288274

289-
.. literalinclude:: snippets.py
275+
.. literalinclude:: ../samples/snippets/usage_guide.py
290276
:start-after: [START setup_logging_excludes]
291277
:end-before: [END setup_logging_excludes]
292278
:dedent: 4
@@ -300,7 +286,7 @@ directly create a
300286
:class:`~google.cloud.logging.handlers.handlers.CloudLoggingHandler` instance
301287
which will write directly to the API.
302288

303-
.. literalinclude:: snippets.py
289+
.. literalinclude:: ../samples/snippets/usage_guide.py
304290
:start-after: [START create_cloud_handler]
305291
:end-before: [END create_cloud_handler]
306292
:dedent: 4
@@ -316,7 +302,7 @@ All logs will go to a single custom log, which defaults to "python". The name
316302
of the Python logger will be included in the structured log entry under the
317303
"python_logger" field. You can change it by providing a name to the handler:
318304

319-
.. literalinclude:: snippets.py
305+
.. literalinclude:: ../samples/snippets/usage_guide.py
320306
:start-after: [START create_named_handler]
321307
:end-before: [END create_named_handler]
322308
:dedent: 4

samples/snippets/requirements.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
google-cloud-logging==2.0.1
1+
google-cloud-logging==2.0.2
2+
google-cloud-storage==1.35.0
3+
google-cloud-pubsub==2.2.0
4+
google-cloud-bigquery==2.6.1

0 commit comments

Comments
 (0)