google-cloud-logging-v2 0.5.6 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +6 -6
- data/README.md +14 -9
- data/lib/google/cloud/logging/v2/config_service/client.rb +507 -104
- data/lib/google/cloud/logging/v2/config_service/operations.rb +770 -0
- data/lib/google/cloud/logging/v2/config_service/paths.rb +53 -0
- data/lib/google/cloud/logging/v2/config_service.rb +1 -0
- data/lib/google/cloud/logging/v2/logging_service/client.rb +45 -41
- data/lib/google/cloud/logging/v2/version.rb +1 -1
- data/lib/google/cloud/logging/v2.rb +4 -2
- data/lib/google/logging/v2/log_entry_pb.rb +9 -3
- data/lib/google/logging/v2/logging_config_pb.rb +54 -3
- data/lib/google/logging/v2/logging_config_services_pb.rb +78 -39
- data/lib/google/logging/v2/logging_metrics_pb.rb +4 -4
- data/lib/google/logging/v2/logging_pb.rb +3 -5
- data/lib/google/logging/v2/logging_services_pb.rb +4 -4
- data/proto_docs/google/logging/v2/log_entry.rb +42 -4
- data/proto_docs/google/logging/v2/logging.rb +50 -45
- data/proto_docs/google/logging/v2/logging_config.rb +456 -152
- data/proto_docs/google/logging/v2/logging_metrics.rb +9 -5
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/protobuf/struct.rb +2 -2
- metadata +14 -12
|
@@ -37,12 +37,13 @@ module Google
|
|
|
37
37
|
#
|
|
38
38
|
# `[LOG_ID]` must be URL-encoded within `log_name`. Example:
|
|
39
39
|
# `"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
|
|
40
|
+
#
|
|
40
41
|
# `[LOG_ID]` must be less than 512 characters long and can only include the
|
|
41
42
|
# following characters: upper and lower case alphanumeric characters,
|
|
42
43
|
# forward-slash, underscore, hyphen, and period.
|
|
43
44
|
#
|
|
44
45
|
# For backward compatibility, if `log_name` begins with a forward-slash, such
|
|
45
|
-
# as `/projects/...`, then the log entry is ingested as usual but the
|
|
46
|
+
# as `/projects/...`, then the log entry is ingested as usual, but the
|
|
46
47
|
# forward-slash is removed. Listing the log entry will not show the leading
|
|
47
48
|
# slash and filtering for a log name with a leading slash will never return
|
|
48
49
|
# any results.
|
|
@@ -98,7 +99,7 @@ module Google
|
|
|
98
99
|
# de-duplication in the export of logs.
|
|
99
100
|
#
|
|
100
101
|
# If the `insert_id` is omitted when writing a log entry, the Logging API
|
|
101
|
-
#
|
|
102
|
+
# assigns its own unique identifier in this field.
|
|
102
103
|
#
|
|
103
104
|
# In queries, the `insert_id` is also used to order log entries that have
|
|
104
105
|
# the same `log_name` and `timestamp` values.
|
|
@@ -108,8 +109,20 @@ module Google
|
|
|
108
109
|
# applicable.
|
|
109
110
|
# @!attribute [rw] labels
|
|
110
111
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
111
|
-
# Optional. A
|
|
112
|
-
#
|
|
112
|
+
# Optional. A map of key, value pairs that provides additional information about the
|
|
113
|
+
# log entry. The labels can be user-defined or system-defined.
|
|
114
|
+
#
|
|
115
|
+
# User-defined labels are arbitrary key, value pairs that you can use to
|
|
116
|
+
# classify logs.
|
|
117
|
+
#
|
|
118
|
+
# System-defined labels are defined by GCP services for platform logs.
|
|
119
|
+
# They have two components - a service namespace component and the
|
|
120
|
+
# attribute name. For example: `compute.googleapis.com/resource_name`.
|
|
121
|
+
#
|
|
122
|
+
# Cloud Logging truncates label keys that exceed 512 B and label
|
|
123
|
+
# values that exceed 64 KB upon their associated log entry being
|
|
124
|
+
# written. The truncation is indicated by an ellipsis at the
|
|
125
|
+
# end of the character string.
|
|
113
126
|
# @!attribute [rw] operation
|
|
114
127
|
# @return [::Google::Cloud::Logging::V2::LogEntryOperation]
|
|
115
128
|
# Optional. Information about an operation associated with the log entry, if
|
|
@@ -139,6 +152,10 @@ module Google
|
|
|
139
152
|
# @!attribute [rw] source_location
|
|
140
153
|
# @return [::Google::Cloud::Logging::V2::LogEntrySourceLocation]
|
|
141
154
|
# Optional. Source code location information associated with the log entry, if any.
|
|
155
|
+
# @!attribute [rw] split
|
|
156
|
+
# @return [::Google::Cloud::Logging::V2::LogSplit]
|
|
157
|
+
# Optional. Information indicating this LogEntry is part of a sequence of multiple log
|
|
158
|
+
# entries split from a single LogEntry.
|
|
142
159
|
class LogEntry
|
|
143
160
|
include ::Google::Protobuf::MessageExts
|
|
144
161
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -197,6 +214,27 @@ module Google
|
|
|
197
214
|
include ::Google::Protobuf::MessageExts
|
|
198
215
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
199
216
|
end
|
|
217
|
+
|
|
218
|
+
# Additional information used to correlate multiple log entries. Used when a
|
|
219
|
+
# single LogEntry would exceed the Google Cloud Logging size limit and is
|
|
220
|
+
# split across multiple log entries.
|
|
221
|
+
# @!attribute [rw] uid
|
|
222
|
+
# @return [::String]
|
|
223
|
+
# A globally unique identifier for all log entries in a sequence of split log
|
|
224
|
+
# entries. All log entries with the same |LogSplit.uid| are assumed to be
|
|
225
|
+
# part of the same sequence of split log entries.
|
|
226
|
+
# @!attribute [rw] index
|
|
227
|
+
# @return [::Integer]
|
|
228
|
+
# The index of this LogEntry in the sequence of split log entries. Log
|
|
229
|
+
# entries are given |index| values 0, 1, ..., n-1 for a sequence of n log
|
|
230
|
+
# entries.
|
|
231
|
+
# @!attribute [rw] total_splits
|
|
232
|
+
# @return [::Integer]
|
|
233
|
+
# The total number of log entries that the original LogEntry was split into.
|
|
234
|
+
class LogSplit
|
|
235
|
+
include ::Google::Protobuf::MessageExts
|
|
236
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
237
|
+
end
|
|
200
238
|
end
|
|
201
239
|
end
|
|
202
240
|
end
|
|
@@ -26,14 +26,15 @@ module Google
|
|
|
26
26
|
# @return [::String]
|
|
27
27
|
# Required. The resource name of the log to delete:
|
|
28
28
|
#
|
|
29
|
-
#
|
|
30
|
-
#
|
|
31
|
-
#
|
|
32
|
-
#
|
|
29
|
+
# * `projects/[PROJECT_ID]/logs/[LOG_ID]`
|
|
30
|
+
# * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
|
|
31
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
|
|
32
|
+
# * `folders/[FOLDER_ID]/logs/[LOG_ID]`
|
|
33
33
|
#
|
|
34
34
|
# `[LOG_ID]` must be URL-encoded. For example,
|
|
35
35
|
# `"projects/my-project-id/logs/syslog"`,
|
|
36
|
-
# `"organizations/
|
|
36
|
+
# `"organizations/123/logs/cloudaudit.googleapis.com%2Factivity"`.
|
|
37
|
+
#
|
|
37
38
|
# For more information about log names, see
|
|
38
39
|
# {::Google::Cloud::Logging::V2::LogEntry LogEntry}.
|
|
39
40
|
class DeleteLogRequest
|
|
@@ -47,15 +48,15 @@ module Google
|
|
|
47
48
|
# Optional. A default log resource name that is assigned to all log entries
|
|
48
49
|
# in `entries` that do not specify a value for `log_name`:
|
|
49
50
|
#
|
|
50
|
-
#
|
|
51
|
-
#
|
|
52
|
-
#
|
|
53
|
-
#
|
|
51
|
+
# * `projects/[PROJECT_ID]/logs/[LOG_ID]`
|
|
52
|
+
# * `organizations/[ORGANIZATION_ID]/logs/[LOG_ID]`
|
|
53
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]`
|
|
54
|
+
# * `folders/[FOLDER_ID]/logs/[LOG_ID]`
|
|
54
55
|
#
|
|
55
56
|
# `[LOG_ID]` must be URL-encoded. For example:
|
|
56
57
|
#
|
|
57
58
|
# "projects/my-project-id/logs/syslog"
|
|
58
|
-
# "organizations/
|
|
59
|
+
# "organizations/123/logs/cloudaudit.googleapis.com%2Factivity"
|
|
59
60
|
#
|
|
60
61
|
# The permission `logging.logEntries.create` is needed on each project,
|
|
61
62
|
# organization, billing account, or folder that is receiving new log
|
|
@@ -93,14 +94,14 @@ module Google
|
|
|
93
94
|
# the entries later in the list. See the `entries.list` method.
|
|
94
95
|
#
|
|
95
96
|
# Log entries with timestamps that are more than the
|
|
96
|
-
# [logs retention period](https://cloud.google.com/logging/
|
|
97
|
+
# [logs retention period](https://cloud.google.com/logging/quotas) in
|
|
97
98
|
# the past or more than 24 hours in the future will not be available when
|
|
98
99
|
# calling `entries.list`. However, those log entries can still be [exported
|
|
99
100
|
# with
|
|
100
101
|
# LogSinks](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
|
|
101
102
|
#
|
|
102
103
|
# To improve throughput and to avoid exceeding the
|
|
103
|
-
# [quota limit](https://cloud.google.com/logging/
|
|
104
|
+
# [quota limit](https://cloud.google.com/logging/quotas) for calls to
|
|
104
105
|
# `entries.write`, you should try to include several log entries in this
|
|
105
106
|
# list, rather than calling this method for each individual log entry.
|
|
106
107
|
# @!attribute [rw] partial_success
|
|
@@ -164,16 +165,17 @@ module Google
|
|
|
164
165
|
# Required. Names of one or more parent resources from which to
|
|
165
166
|
# retrieve log entries:
|
|
166
167
|
#
|
|
167
|
-
#
|
|
168
|
-
#
|
|
169
|
-
#
|
|
170
|
-
#
|
|
168
|
+
# * `projects/[PROJECT_ID]`
|
|
169
|
+
# * `organizations/[ORGANIZATION_ID]`
|
|
170
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]`
|
|
171
|
+
# * `folders/[FOLDER_ID]`
|
|
172
|
+
#
|
|
173
|
+
# May alternatively be one or more views:
|
|
171
174
|
#
|
|
172
|
-
#
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
# folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
|
|
175
|
+
# * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
176
|
+
# * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
177
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
178
|
+
# * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
177
179
|
#
|
|
178
180
|
# Projects listed in the `project_ids` field are added to this list.
|
|
179
181
|
# @!attribute [rw] filter
|
|
@@ -195,10 +197,10 @@ module Google
|
|
|
195
197
|
# timestamps are returned in order of their `insert_id` values.
|
|
196
198
|
# @!attribute [rw] page_size
|
|
197
199
|
# @return [::Integer]
|
|
198
|
-
# Optional. The maximum number of results to return from this request.
|
|
199
|
-
#
|
|
200
|
-
#
|
|
201
|
-
#
|
|
200
|
+
# Optional. The maximum number of results to return from this request. Default is 50.
|
|
201
|
+
# If the value is negative or exceeds 1000, the request is rejected. The
|
|
202
|
+
# presence of `next_page_token` in the response indicates that more results
|
|
203
|
+
# might be available.
|
|
202
204
|
# @!attribute [rw] page_token
|
|
203
205
|
# @return [::String]
|
|
204
206
|
# Optional. If present, then retrieve the next batch of results from the
|
|
@@ -269,10 +271,10 @@ module Google
|
|
|
269
271
|
# @return [::String]
|
|
270
272
|
# Required. The resource name that owns the logs:
|
|
271
273
|
#
|
|
272
|
-
#
|
|
273
|
-
#
|
|
274
|
-
#
|
|
275
|
-
#
|
|
274
|
+
# * `projects/[PROJECT_ID]`
|
|
275
|
+
# * `organizations/[ORGANIZATION_ID]`
|
|
276
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]`
|
|
277
|
+
# * `folders/[FOLDER_ID]`
|
|
276
278
|
# @!attribute [rw] page_size
|
|
277
279
|
# @return [::Integer]
|
|
278
280
|
# Optional. The maximum number of results to return from this request.
|
|
@@ -287,16 +289,18 @@ module Google
|
|
|
287
289
|
# @!attribute [rw] resource_names
|
|
288
290
|
# @return [::Array<::String>]
|
|
289
291
|
# Optional. The resource name that owns the logs:
|
|
290
|
-
#
|
|
291
|
-
#
|
|
292
|
-
#
|
|
293
|
-
#
|
|
292
|
+
#
|
|
293
|
+
# * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
294
|
+
# * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
295
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
296
|
+
# * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
294
297
|
#
|
|
295
298
|
# To support legacy queries, it could also be:
|
|
296
|
-
#
|
|
297
|
-
#
|
|
298
|
-
#
|
|
299
|
-
#
|
|
299
|
+
#
|
|
300
|
+
# * `projects/[PROJECT_ID]`
|
|
301
|
+
# * `organizations/[ORGANIZATION_ID]`
|
|
302
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]`
|
|
303
|
+
# * `folders/[FOLDER_ID]`
|
|
300
304
|
class ListLogsRequest
|
|
301
305
|
include ::Google::Protobuf::MessageExts
|
|
302
306
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -323,16 +327,17 @@ module Google
|
|
|
323
327
|
# @return [::Array<::String>]
|
|
324
328
|
# Required. Name of a parent resource from which to retrieve log entries:
|
|
325
329
|
#
|
|
326
|
-
#
|
|
327
|
-
#
|
|
328
|
-
#
|
|
329
|
-
#
|
|
330
|
+
# * `projects/[PROJECT_ID]`
|
|
331
|
+
# * `organizations/[ORGANIZATION_ID]`
|
|
332
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]`
|
|
333
|
+
# * `folders/[FOLDER_ID]`
|
|
330
334
|
#
|
|
331
335
|
# May alternatively be one or more views:
|
|
332
|
-
#
|
|
333
|
-
#
|
|
334
|
-
#
|
|
335
|
-
#
|
|
336
|
+
#
|
|
337
|
+
# * `projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
338
|
+
# * `organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
339
|
+
# * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
340
|
+
# * `folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]`
|
|
336
341
|
# @!attribute [rw] filter
|
|
337
342
|
# @return [::String]
|
|
338
343
|
# Optional. A filter that chooses which log entries to return. See [Advanced
|