Skip to content

GCP Cloud Logging Connector

GcpLogging

Instantiate Google Cloud Logging client.

Source code in honeydew/gcp_logging.py
Python
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
class GcpLogging:
    """Instantiate Google Cloud Logging client.
    """
    def __init__(self, credential_file=None, proxy=''):
        """Instantiate Google Cloud Logging client.

        Args:
            credential_file (str): Credential file path. Default: None
            proxy (str): Proxy URL. Default: ''
        """
        if credential_file is not None:
            os.environ['GOOGLE_APPLICATION_CREDENTIALS'] = credential_file
        if proxy != '':
            os.environ['HTTPS_PROXY'] = proxy
        self.client = logging.Client()

    def list_logs(self, project_id, filter_str=None):
        """
        List logs in a project.

        Args:
            project_id (str): Project ID
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

        Returns:
            result (list): List of logs
        """
        logs = self.client.list_logs(project_id=project_id, filter_=filter_str)
        return logs

    def list_entries(self, project_id, filter_str=None):
        """
        List log entries in a project.

        Args:
            project_id (str): Project ID
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

        Returns:
            result (list): List of log entries
        """
        entries = self.client.list_entries(project_id=project_id, filter_=filter_str)
        return entries

    def write_log(self, project_id, log_name, resource, labels, text_payload=None, json_payload=None):
        """
        Write a log entry.

        Args:
            project_id (str): Project ID
            log_name (str): Log name. Example: 'my-log'
            resource (dict): Resource. Example: {'type': 'global'}
            labels (dict): Labels. Example: {'env': 'dev', 'app': 'my-app'}
            text_payload (str): Text payload. Example: 'my log message'
            json_payload (dict): JSON payload. Example: {'message': 'my log message'}

        Returns:
            result (str): It returns 'OK' when successful
        """
        logger = self.client.logger(log_name)
        logger.log_text(text_payload, resource=resource, labels=labels)
        logger.log_struct(json_payload, resource=resource, labels=labels)
        results = 'OK'
        return results

    def delete_log(self, project_id, log_name):
        """
        Delete a log.

        Args:
            project_id (str): Project ID
            log_name (str): Log name. Example: 'my-log'

        Returns:
            result (str): It returns 'OK' when successful
        """
        logger = self.client.logger(log_name)
        logger.delete()
        results = 'OK'
        return results

    def delete_many_logs(self, project_id, filter_str=None):
        """
        Delete multiple logs.

        Args:
            project_id (str): Project ID
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

        Returns:
            result (str): It returns 'OK' when successful
        """
        logs = self.client.list_logs(project_id=project_id, filter_=filter_str)
        for log in logs:
            log.delete()
        results = 'OK'
        return results

    def delete_log_entries(self, project_id, filter_str=None):
        """
        Delete log entries.

        Args:
            project_id (str): Project ID
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

        Returns:
            result (str): It returns 'OK' when successful
        """
        entries = self.client.list_entries(project_id=project_id, filter_=filter_str)
        for entry in entries:
            entry.delete()
        results = 'OK'
        return results

    def delete_many_log_entries(self, project_id, filter_str=None):
        """
        Delete multiple log entries.

        Args:
            project_id (str): Project ID
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

        Returns:
            result (str): It returns 'OK' when successful
        """
        entries = self.client.list_entries(project_id=project_id, filter_=filter_str)
        for entry in entries:
            entry.delete()
        results = 'OK'
        return results

    def list_sinks(self, project_id):
        """
        List sinks in a project.

        Args:
            project_id (str): Project ID

        Returns:
            result (list): List of sinks
        """
        sinks = self.client.list_sinks(project_id=project_id)
        return sinks

    def create_sink(self, project_id, sink_name, filter_str, destination):
        """
        Create a sink.

        Args:
            project_id (str): Project ID
            sink_name (str): Sink name. Example: 'my-sink'
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'
            destination (dict): Destination. Example: {'writer_identity': 'serviceAccount:

        Returns:
            result (str): It returns 'OK' when successful
        """
        sink = self.client.sink(sink_name, filter_=filter_str, destination=destination)
        sink.create()
        results = 'OK'
        return results

    def delete_sink(self, project_id, sink_name):
        """
        Delete a sink.

        Args:
            project_id (str): Project ID
            sink_name (str): Sink name. Example: 'my-sink'

        Returns:
            result (str): It returns 'OK' when successful
        """
        sink = self.client.sink(sink_name)
        sink.delete()
        results = 'OK'
        return results

    def delete_many_sinks(self, project_id):
        """
        Delete multiple sinks.

        Args:
            project_id (str): Project ID

        Returns:
            result (str): It returns 'OK' when successful
        """
        sinks = self.client.list_sinks(project_id=project_id)
        for sink in sinks:
            sink.delete()
        results = 'OK'
        return results

    def get_sink(self, project_id, sink_name):
        """
        Get a sink.

        Args:
            project_id (str): Project ID
            sink_name (str): Sink name. Example: 'my-sink'

        Returns:
            result (dict): Sink
        """
        sink = self.client.sink(sink_name)
        return sink

    def update_sink(self, project_id, sink_name, filter_str, destination):
        """
        Update a sink.

        Args:
            project_id (str): Project ID
            sink_name (str): Sink name. Example: 'my-sink'
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'
            destination (dict): Destination. Example: {'writer_identity': 'serviceAccount:

        Returns:
            result (str): It returns 'OK' when successful
        """
        sink = self.client.sink(sink_name, filter_=filter_str, destination=destination)
        sink.update()
        results = 'OK'
        return results

    def list_exclusions(self, project_id):
        """
        List exclusions in a project.

        Args:
            project_id (str): Project ID

        Returns:
            result (list): List of exclusions
        """
        exclusions = self.client.list_exclusions(project_id=project_id)
        return exclusions

    def create_exclusion(self, project_id, exclusion_name, filter_str):
        """
        Create an exclusion.

        Args:
            project_id (str): Project ID
            exclusion_name (str): Exclusion name. Example: 'my-exclusion'
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

        Returns:
            result (str): It returns 'OK' when successful
        """
        exclusion = self.client.exclusion(exclusion_name, filter_=filter_str)
        exclusion.create()
        results = 'OK'
        return results

    def delete_exclusion(self, project_id, exclusion_name):
        """
        Delete an exclusion.

        Args:
            project_id (str): Project ID
            exclusion_name (str): Exclusion name. Example: 'my-exclusion'

        Returns:
            result (str): It returns 'OK' when successful
        """
        exclusion = self.client.exclusion(exclusion_name)
        exclusion.delete()
        results = 'OK'
        return results

    def delete_many_exclusions(self, project_id):
        """
        Delete multiple exclusions.

        Args:
            project_id (str): Project ID

        Returns:
            result (str): It returns 'OK' when successful
        """
        exclusions = self.client.list_exclusions(project_id=project_id)
        for exclusion in exclusions:
            exclusion.delete()
        results = 'OK'
        return results

    def get_exclusion(self, project_id, exclusion_name):
        """
        Get an exclusion.

        Args:
            project_id (str): Project ID
            exclusion_name (str): Exclusion name. Example: 'my-exclusion'

        Returns:
            result (dict): Exclusion
        """
        exclusion = self.client.exclusion(exclusion_name)
        return exclusion

    def update_exclusion(self, project_id, exclusion_name, filter_str):
        """
        Update an exclusion.

        Args:
            project_id (str): Project ID
            exclusion_name (str): Exclusion name. Example: 'my-exclusion'
            filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

        Returns:
            result (str): It returns 'OK' when successful
        """
        exclusion = self.client.exclusion(exclusion_name, filter_=filter_str)
        exclusion.update()
        results = 'OK'
        return results

    def list_monitored_resource_descriptors(self, project_id):
        """
        List monitored resource descriptors in a project.

        Args:
            project_id (str): Project ID

        Returns:
            result (list): List of monitored resource descriptors
        """
        descriptors = self.client.list_monitored_resource_descriptors(project_id=project_id)
        return descriptors

    def get_monitored_resource_descriptor(self, project_id, descriptor_name):
        """
        Get a monitored resource descriptor.

        Args:
            project_id (str): Project ID
            descriptor_name (str): Descriptor name. Example: 'my-descriptor'

        Returns:
            result (dict): Monitored resource descriptor
        """
        descriptor = self.client.monitored_resource_descriptor(descriptor_name)
        return descriptor

    def list_metric_descriptors(self, project_id):
        """
        List metric descriptors in a project.

        Args:
            project_id (str): Project ID

        Returns:
            result (list): List of metric descriptors
        """
        descriptors = self.client.list_metric_descriptors(project_id=project_id)
        return descriptors

    def get_metric_descriptor(self, project_id, descriptor_name):
        """
        Get a metric descriptor.

        Args:
            project_id (str): Project ID
            descriptor_name (str): Descriptor name. Example: 'my-descriptor'

        Returns:
            result (dict): Metric descriptor
        """
        descriptor = self.client.metric_descriptor(descriptor_name)
        return descriptor

    def list_logs_based_metrics(self, project_id):
        """
        List logs-based metrics in a project.

        Args:
            project_id (str): Project ID

        Returns:
            result (list): List of logs-based metrics
        """
        metrics = self.client.list_logs_based_metrics(project_id=project_id)
        return metrics

    def get_logs_based_metric(self, project_id, metric_name):
        """
        Get a logs-based metric.

        Args:
            project_id (str): Project ID
            metric_name (str): Metric name. Example: 'my-metric'

        Returns:
            result (dict): Logs-based metric
        """
        metric = self.client.logs_based_metric(metric_name)
        return metric

__init__(credential_file=None, proxy='')

Instantiate Google Cloud Logging client.

Parameters:

Name Type Description Default
credential_file str

Credential file path. Default: None

 None
proxy str

Proxy URL. Default: ''

 ''
Source code in honeydew/gcp_logging.py
Python
 8
 9
10
11
12
13
14
15
16
17
18
19
def __init__(self, credential_file=None, proxy=''):
    """Instantiate Google Cloud Logging client.

    Args:
        credential_file (str): Credential file path. Default: None
        proxy (str): Proxy URL. Default: ''
    """
    if credential_file is not None:
        os.environ['GOOGLE_APPLICATION_CREDENTIALS'] = credential_file
    if proxy != '':
        os.environ['HTTPS_PROXY'] = proxy
    self.client = logging.Client()

create_exclusion(project_id, exclusion_name, filter_str)

Create an exclusion.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
exclusion_name str

Exclusion name. Example: 'my-exclusion'

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def create_exclusion(self, project_id, exclusion_name, filter_str):
    """
    Create an exclusion.

    Args:
        project_id (str): Project ID
        exclusion_name (str): Exclusion name. Example: 'my-exclusion'
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

    Returns:
        result (str): It returns 'OK' when successful
    """
    exclusion = self.client.exclusion(exclusion_name, filter_=filter_str)
    exclusion.create()
    results = 'OK'
    return results

create_sink(project_id, sink_name, filter_str, destination)

Create a sink.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
sink_name str

Sink name. Example: 'my-sink'

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 required
destination dict

Destination. Example: {'writer_identity': 'serviceAccount:

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def create_sink(self, project_id, sink_name, filter_str, destination):
    """
    Create a sink.

    Args:
        project_id (str): Project ID
        sink_name (str): Sink name. Example: 'my-sink'
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'
        destination (dict): Destination. Example: {'writer_identity': 'serviceAccount:

    Returns:
        result (str): It returns 'OK' when successful
    """
    sink = self.client.sink(sink_name, filter_=filter_str, destination=destination)
    sink.create()
    results = 'OK'
    return results

delete_exclusion(project_id, exclusion_name)

Delete an exclusion.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
exclusion_name str

Exclusion name. Example: 'my-exclusion'

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
def delete_exclusion(self, project_id, exclusion_name):
    """
    Delete an exclusion.

    Args:
        project_id (str): Project ID
        exclusion_name (str): Exclusion name. Example: 'my-exclusion'

    Returns:
        result (str): It returns 'OK' when successful
    """
    exclusion = self.client.exclusion(exclusion_name)
    exclusion.delete()
    results = 'OK'
    return results

delete_log(project_id, log_name)

Delete a log.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
log_name str

Log name. Example: 'my-log'

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def delete_log(self, project_id, log_name):
    """
    Delete a log.

    Args:
        project_id (str): Project ID
        log_name (str): Log name. Example: 'my-log'

    Returns:
        result (str): It returns 'OK' when successful
    """
    logger = self.client.logger(log_name)
    logger.delete()
    results = 'OK'
    return results

delete_log_entries(project_id, filter_str=None)

Delete log entries.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 None

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def delete_log_entries(self, project_id, filter_str=None):
    """
    Delete log entries.

    Args:
        project_id (str): Project ID
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

    Returns:
        result (str): It returns 'OK' when successful
    """
    entries = self.client.list_entries(project_id=project_id, filter_=filter_str)
    for entry in entries:
        entry.delete()
    results = 'OK'
    return results

delete_many_exclusions(project_id)

Delete multiple exclusions.

Parameters:

Name Type Description Default
project_id str

Project ID

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
def delete_many_exclusions(self, project_id):
    """
    Delete multiple exclusions.

    Args:
        project_id (str): Project ID

    Returns:
        result (str): It returns 'OK' when successful
    """
    exclusions = self.client.list_exclusions(project_id=project_id)
    for exclusion in exclusions:
        exclusion.delete()
    results = 'OK'
    return results

delete_many_log_entries(project_id, filter_str=None)

Delete multiple log entries.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 None

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def delete_many_log_entries(self, project_id, filter_str=None):
    """
    Delete multiple log entries.

    Args:
        project_id (str): Project ID
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

    Returns:
        result (str): It returns 'OK' when successful
    """
    entries = self.client.list_entries(project_id=project_id, filter_=filter_str)
    for entry in entries:
        entry.delete()
    results = 'OK'
    return results

delete_many_logs(project_id, filter_str=None)

Delete multiple logs.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 None

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def delete_many_logs(self, project_id, filter_str=None):
    """
    Delete multiple logs.

    Args:
        project_id (str): Project ID
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

    Returns:
        result (str): It returns 'OK' when successful
    """
    logs = self.client.list_logs(project_id=project_id, filter_=filter_str)
    for log in logs:
        log.delete()
    results = 'OK'
    return results

delete_many_sinks(project_id)

Delete multiple sinks.

Parameters:

Name Type Description Default
project_id str

Project ID

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def delete_many_sinks(self, project_id):
    """
    Delete multiple sinks.

    Args:
        project_id (str): Project ID

    Returns:
        result (str): It returns 'OK' when successful
    """
    sinks = self.client.list_sinks(project_id=project_id)
    for sink in sinks:
        sink.delete()
    results = 'OK'
    return results

delete_sink(project_id, sink_name)

Delete a sink.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
sink_name str

Sink name. Example: 'my-sink'

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def delete_sink(self, project_id, sink_name):
    """
    Delete a sink.

    Args:
        project_id (str): Project ID
        sink_name (str): Sink name. Example: 'my-sink'

    Returns:
        result (str): It returns 'OK' when successful
    """
    sink = self.client.sink(sink_name)
    sink.delete()
    results = 'OK'
    return results

get_exclusion(project_id, exclusion_name)

Get an exclusion.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
exclusion_name str

Exclusion name. Example: 'my-exclusion'

 required

Returns:

Name Type Description
result dict

Exclusion
Source code in honeydew/gcp_logging.py
Python
294
295
296
297
298
299
300
301
302
303
304
305
306
def get_exclusion(self, project_id, exclusion_name):
    """
    Get an exclusion.

    Args:
        project_id (str): Project ID
        exclusion_name (str): Exclusion name. Example: 'my-exclusion'

    Returns:
        result (dict): Exclusion
    """
    exclusion = self.client.exclusion(exclusion_name)
    return exclusion

get_logs_based_metric(project_id, metric_name)

Get a logs-based metric.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
metric_name str

Metric name. Example: 'my-metric'

 required

Returns:

Name Type Description
result dict

Logs-based metric
Source code in honeydew/gcp_logging.py
Python
392
393
394
395
396
397
398
399
400
401
402
403
404
def get_logs_based_metric(self, project_id, metric_name):
    """
    Get a logs-based metric.

    Args:
        project_id (str): Project ID
        metric_name (str): Metric name. Example: 'my-metric'

    Returns:
        result (dict): Logs-based metric
    """
    metric = self.client.logs_based_metric(metric_name)
    return metric

get_metric_descriptor(project_id, descriptor_name)

Get a metric descriptor.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
descriptor_name str

Descriptor name. Example: 'my-descriptor'

 required

Returns:

Name Type Description
result dict

Metric descriptor
Source code in honeydew/gcp_logging.py
Python
365
366
367
368
369
370
371
372
373
374
375
376
377
def get_metric_descriptor(self, project_id, descriptor_name):
    """
    Get a metric descriptor.

    Args:
        project_id (str): Project ID
        descriptor_name (str): Descriptor name. Example: 'my-descriptor'

    Returns:
        result (dict): Metric descriptor
    """
    descriptor = self.client.metric_descriptor(descriptor_name)
    return descriptor

get_monitored_resource_descriptor(project_id, descriptor_name)

Get a monitored resource descriptor.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
descriptor_name str

Descriptor name. Example: 'my-descriptor'

 required

Returns:

Name Type Description
result dict

Monitored resource descriptor
Source code in honeydew/gcp_logging.py
Python
338
339
340
341
342
343
344
345
346
347
348
349
350
def get_monitored_resource_descriptor(self, project_id, descriptor_name):
    """
    Get a monitored resource descriptor.

    Args:
        project_id (str): Project ID
        descriptor_name (str): Descriptor name. Example: 'my-descriptor'

    Returns:
        result (dict): Monitored resource descriptor
    """
    descriptor = self.client.monitored_resource_descriptor(descriptor_name)
    return descriptor

get_sink(project_id, sink_name)

Get a sink.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
sink_name str

Sink name. Example: 'my-sink'

 required

Returns:

Name Type Description
result dict

Sink
Source code in honeydew/gcp_logging.py
Python
200
201
202
203
204
205
206
207
208
209
210
211
212
def get_sink(self, project_id, sink_name):
    """
    Get a sink.

    Args:
        project_id (str): Project ID
        sink_name (str): Sink name. Example: 'my-sink'

    Returns:
        result (dict): Sink
    """
    sink = self.client.sink(sink_name)
    return sink

list_entries(project_id, filter_str=None)

List log entries in a project.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 None

Returns:

Name Type Description
result list

List of log entries
Source code in honeydew/gcp_logging.py
Python
35
36
37
38
39
40
41
42
43
44
45
46
47
def list_entries(self, project_id, filter_str=None):
    """
    List log entries in a project.

    Args:
        project_id (str): Project ID
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

    Returns:
        result (list): List of log entries
    """
    entries = self.client.list_entries(project_id=project_id, filter_=filter_str)
    return entries

list_exclusions(project_id)

List exclusions in a project.

Parameters:

Name Type Description Default
project_id str

Project ID

 required

Returns:

Name Type Description
result list

List of exclusions
Source code in honeydew/gcp_logging.py
Python
232
233
234
235
236
237
238
239
240
241
242
243
def list_exclusions(self, project_id):
    """
    List exclusions in a project.

    Args:
        project_id (str): Project ID

    Returns:
        result (list): List of exclusions
    """
    exclusions = self.client.list_exclusions(project_id=project_id)
    return exclusions

list_logs(project_id, filter_str=None)

List logs in a project.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 None

Returns:

Name Type Description
result list

List of logs
Source code in honeydew/gcp_logging.py
Python
21
22
23
24
25
26
27
28
29
30
31
32
33
def list_logs(self, project_id, filter_str=None):
    """
    List logs in a project.

    Args:
        project_id (str): Project ID
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

    Returns:
        result (list): List of logs
    """
    logs = self.client.list_logs(project_id=project_id, filter_=filter_str)
    return logs

list_logs_based_metrics(project_id)

List logs-based metrics in a project.

Parameters:

Name Type Description Default
project_id str

Project ID

 required

Returns:

Name Type Description
result list

List of logs-based metrics
Source code in honeydew/gcp_logging.py
Python
379
380
381
382
383
384
385
386
387
388
389
390
def list_logs_based_metrics(self, project_id):
    """
    List logs-based metrics in a project.

    Args:
        project_id (str): Project ID

    Returns:
        result (list): List of logs-based metrics
    """
    metrics = self.client.list_logs_based_metrics(project_id=project_id)
    return metrics

list_metric_descriptors(project_id)

List metric descriptors in a project.

Parameters:

Name Type Description Default
project_id str

Project ID

 required

Returns:

Name Type Description
result list

List of metric descriptors
Source code in honeydew/gcp_logging.py
Python
352
353
354
355
356
357
358
359
360
361
362
363
def list_metric_descriptors(self, project_id):
    """
    List metric descriptors in a project.

    Args:
        project_id (str): Project ID

    Returns:
        result (list): List of metric descriptors
    """
    descriptors = self.client.list_metric_descriptors(project_id=project_id)
    return descriptors

list_monitored_resource_descriptors(project_id)

List monitored resource descriptors in a project.

Parameters:

Name Type Description Default
project_id str

Project ID

 required

Returns:

Name Type Description
result list

List of monitored resource descriptors
Source code in honeydew/gcp_logging.py
Python
325
326
327
328
329
330
331
332
333
334
335
336
def list_monitored_resource_descriptors(self, project_id):
    """
    List monitored resource descriptors in a project.

    Args:
        project_id (str): Project ID

    Returns:
        result (list): List of monitored resource descriptors
    """
    descriptors = self.client.list_monitored_resource_descriptors(project_id=project_id)
    return descriptors

list_sinks(project_id)

List sinks in a project.

Parameters:

Name Type Description Default
project_id str

Project ID

 required

Returns:

Name Type Description
result list

List of sinks
Source code in honeydew/gcp_logging.py
Python
137
138
139
140
141
142
143
144
145
146
147
148
def list_sinks(self, project_id):
    """
    List sinks in a project.

    Args:
        project_id (str): Project ID

    Returns:
        result (list): List of sinks
    """
    sinks = self.client.list_sinks(project_id=project_id)
    return sinks

update_exclusion(project_id, exclusion_name, filter_str)

Update an exclusion.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
exclusion_name str

Exclusion name. Example: 'my-exclusion'

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
def update_exclusion(self, project_id, exclusion_name, filter_str):
    """
    Update an exclusion.

    Args:
        project_id (str): Project ID
        exclusion_name (str): Exclusion name. Example: 'my-exclusion'
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'

    Returns:
        result (str): It returns 'OK' when successful
    """
    exclusion = self.client.exclusion(exclusion_name, filter_=filter_str)
    exclusion.update()
    results = 'OK'
    return results

update_sink(project_id, sink_name, filter_str, destination)

Update a sink.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
sink_name str

Sink name. Example: 'my-sink'

 required
filter_str str

Filter string. Example: 'resource.type="bigquery_resource"'

 required
destination dict

Destination. Example: {'writer_identity': 'serviceAccount:

 required

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
def update_sink(self, project_id, sink_name, filter_str, destination):
    """
    Update a sink.

    Args:
        project_id (str): Project ID
        sink_name (str): Sink name. Example: 'my-sink'
        filter_str (str): Filter string. Example: 'resource.type="bigquery_resource"'
        destination (dict): Destination. Example: {'writer_identity': 'serviceAccount:

    Returns:
        result (str): It returns 'OK' when successful
    """
    sink = self.client.sink(sink_name, filter_=filter_str, destination=destination)
    sink.update()
    results = 'OK'
    return results

write_log(project_id, log_name, resource, labels, text_payload=None, json_payload=None)

Write a log entry.

Parameters:

Name Type Description Default
project_id str

Project ID

 required
log_name str

Log name. Example: 'my-log'

 required
resource dict

Resource. Example: {'type': 'global'}

 required
labels dict

Labels. Example: {'env': 'dev', 'app': 'my-app'}

 required
text_payload str

Text payload. Example: 'my log message'

 None
json_payload dict

JSON payload. Example: {'message': 'my log message'}

 None

Returns:

Name Type Description
result str

It returns 'OK' when successful
Source code in honeydew/gcp_logging.py
Python
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def write_log(self, project_id, log_name, resource, labels, text_payload=None, json_payload=None):
    """
    Write a log entry.

    Args:
        project_id (str): Project ID
        log_name (str): Log name. Example: 'my-log'
        resource (dict): Resource. Example: {'type': 'global'}
        labels (dict): Labels. Example: {'env': 'dev', 'app': 'my-app'}
        text_payload (str): Text payload. Example: 'my log message'
        json_payload (dict): JSON payload. Example: {'message': 'my log message'}

    Returns:
        result (str): It returns 'OK' when successful
    """
    logger = self.client.logger(log_name)
    logger.log_text(text_payload, resource=resource, labels=labels)
    logger.log_struct(json_payload, resource=resource, labels=labels)
    results = 'OK'
    return results