google-cloud-logging-v2 0.5.5 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (24) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/AUTHENTICATION.md +13 -31
  4. data/README.md +4 -4
  5. data/lib/google/cloud/logging/v2/config_service/client.rb +507 -104
  6. data/lib/google/cloud/logging/v2/config_service/operations.rb +767 -0
  7. data/lib/google/cloud/logging/v2/config_service/paths.rb +53 -0
  8. data/lib/google/cloud/logging/v2/config_service.rb +1 -0
  9. data/lib/google/cloud/logging/v2/logging_service/client.rb +45 -41
  10. data/lib/google/cloud/logging/v2/version.rb +1 -1
  11. data/lib/google/cloud/logging/v2.rb +4 -2
  12. data/lib/google/logging/v2/log_entry_pb.rb +7 -2
  13. data/lib/google/logging/v2/logging_config_pb.rb +52 -2
  14. data/lib/google/logging/v2/logging_config_services_pb.rb +78 -39
  15. data/lib/google/logging/v2/logging_metrics_pb.rb +2 -3
  16. data/lib/google/logging/v2/logging_pb.rb +1 -4
  17. data/lib/google/logging/v2/logging_services_pb.rb +4 -4
  18. data/proto_docs/google/api/resource.rb +10 -71
  19. data/proto_docs/google/logging/v2/log_entry.rb +42 -4
  20. data/proto_docs/google/logging/v2/logging.rb +50 -45
  21. data/proto_docs/google/logging/v2/logging_config.rb +456 -152
  22. data/proto_docs/google/logging/v2/logging_metrics.rb +9 -5
  23. data/proto_docs/google/longrunning/operations.rb +164 -0
  24. metadata +5 -3
data/proto_docs/google/api/resource.rb CHANGED
@@ -33,11 +33,7 @@ module Google
33
33
  # // For Kubernetes resources, the format is {api group}/{kind}.
34
34
  # option (google.api.resource) = {
35
35
  # type: "pubsub.googleapis.com/Topic"
36
- # name_descriptor: {
37
- # pattern: "projects/{project}/topics/{topic}"
38
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
- # parent_name_extractor: "projects/{project}"
40
- # }
36
+ # pattern: "projects/{project}/topics/{topic}"
41
37
  # };
42
38
  # }
43
39
  #
@@ -45,10 +41,7 @@ module Google
45
41
  #
46
42
  # resources:
47
43
  # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/{project}/topics/{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/{project}"
44
+ # pattern: "projects/{project}/topics/{topic}"
52
45
  #
53
46
  # Sometimes, resources have multiple patterns, typically because they can
54
47
  # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
58
51
  # message LogEntry {
59
52
  # option (google.api.resource) = {
60
53
  # type: "logging.googleapis.com/LogEntry"
61
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
65
- # }
66
- # name_descriptor: {
67
- # pattern: "folders/{folder}/logs/{log}"
68
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
- # parent_name_extractor: "folders/{folder}"
70
- # }
71
- # name_descriptor: {
72
- # pattern: "organizations/{organization}/logs/{log}"
73
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
- # parent_name_extractor: "organizations/{organization}"
75
- # }
76
- # name_descriptor: {
77
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
- # parent_type: "billing.googleapis.com/BillingAccount"
79
- # parent_name_extractor: "billingAccounts/{billing_account}"
80
- # }
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
81
58
  # };
82
59
  # }
83
60
  #
@@ -85,48 +62,10 @@ module Google
85
62
  #
86
63
  # resources:
87
64
  # - type: 'logging.googleapis.com/LogEntry'
88
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
92
- # - pattern: "folders/{folder}/logs/{log}"
93
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
- # parent_name_extractor: "folders/{folder}"
95
- # - pattern: "organizations/{organization}/logs/{log}"
96
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
- # parent_name_extractor: "organizations/{organization}"
98
- # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
- # parent_type: "billing.googleapis.com/BillingAccount"
100
- # parent_name_extractor: "billingAccounts/{billing_account}"
101
- #
102
- # For flexible resources, the resource name doesn't contain parent names, but
103
- # the resource itself has parents for policy evaluation.
104
- #
105
- # Example:
106
- #
107
- # message Shelf {
108
- # option (google.api.resource) = {
109
- # type: "library.googleapis.com/Shelf"
110
- # name_descriptor: {
111
- # pattern: "shelves/{shelf}"
112
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
- # }
114
- # name_descriptor: {
115
- # pattern: "shelves/{shelf}"
116
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
- # }
118
- # };
119
- # }
120
- #
121
- # The ResourceDescriptor Yaml config will look like:
122
- #
123
- # resources:
124
- # - type: 'library.googleapis.com/Shelf'
125
- # name_descriptor:
126
- # - pattern: "shelves/{shelf}"
127
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
- # - pattern: "shelves/{shelf}"
129
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
130
69
  # @!attribute [rw] type
131
70
  # @return [::String]
132
71
  # The resource type. It must be in the format of
data/proto_docs/google/logging/v2/log_entry.rb CHANGED
@@ -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
- # assigns its own unique identifier in this field.
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 set of user-defined (key, value) data that provides additional
112
- # information about the log entry.
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
data/proto_docs/google/logging/v2/logging.rb CHANGED
@@ -26,14 +26,15 @@ module Google
26
26
  # @return [::String]
27
27
  # Required. The resource name of the log to delete:
28
28
  #
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]"
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/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"`.
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
- # "projects/[PROJECT_ID]/logs/[LOG_ID]"
51
- # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
52
- # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
53
- # "folders/[FOLDER_ID]/logs/[LOG_ID]"
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/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
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/quota-policy) in
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/quota-policy) for calls to
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
- # "projects/[PROJECT_ID]"
168
- # "organizations/[ORGANIZATION_ID]"
169
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
170
- # "folders/[FOLDER_ID]"
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
- # May alternatively be one or more views
173
- # projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
174
- # organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
175
- # billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
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
- # Default is 50. If the value is negative or exceeds 1000,
200
- # the request is rejected. The presence of `next_page_token` in the
201
- # response indicates that more results might be available.
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
- # "projects/[PROJECT_ID]"
273
- # "organizations/[ORGANIZATION_ID]"
274
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
275
- # "folders/[FOLDER_ID]"
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
- # projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
291
- # organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
292
- # billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
293
- # folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]
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
- # "projects/[PROJECT_ID]"
297
- # "organizations/[ORGANIZATION_ID]"
298
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
299
- # "folders/[FOLDER_ID]"
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
- # "projects/[PROJECT_ID]"
327
- # "organizations/[ORGANIZATION_ID]"
328
- # "billingAccounts/[BILLING_ACCOUNT_ID]"
329
- # "folders/[FOLDER_ID]"
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
- # "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
333
- # "organization/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
334
- # "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
335
- # "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]"
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