google-cloud-trace-v2 0.4.0 → 0.4.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0c7ad9562c999185921aa9e0c1ad80ca6e7450a6830a77840108a03220d8e7e4
4
- data.tar.gz: f563a78ddeadeb474d7b2b544ed1d50cfd43e25f3ed4f2410e3e01c7378b42bb
3
+ metadata.gz: 0f7b21588bc980f40eeac0338aec2754fc4c05a89a610d43f2e6133627e430b7
4
+ data.tar.gz: 2198a940655d88d2ba7eca3e8b6e47bf1865e30821dcec6cbdf078bf4645b238
5
5
  SHA512:
6
- metadata.gz: 28bd6138924f535aecfdccad163cbc2aa12db42ff2950f3740893b683b2d10380f429a8cfdb3b02a22c20ea533aad1c24a898702b0c465f632d9d692a075d200
7
- data.tar.gz: a422e89e1d5d54b1d3262073afdf03a24dea0e4bcd4748a88ffda6daa1110d8f31a1ccb8b414a63e58692638e1c5e97783bb8840781d2be5724682f35fd8dbbd
6
+ metadata.gz: 34db83437a6795c99993809bcf474b2b6c502175be9cc5b51089404077b62bb4b2196631ad5e265e2892ee38c724423eb9840b1a2747a14b88b0f06b6a5f3990
7
+ data.tar.gz: 287ed6bf2b8c00fecc4c58c11c7ab1408c6b2582fc57000b5240ead2781a6175a23c7ba109a29aedea86757cd69bdbf5de6e4a95a9996e0965348a8d9dfdf2ac
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
data/README.md CHANGED
@@ -46,7 +46,7 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
50
  or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
@@ -27,11 +27,13 @@ module Google
27
27
  ##
28
28
  # Client for the TraceService service.
29
29
  #
30
- # This file describes an API for collecting and viewing traces and spans
31
- # within a trace. A Trace is a collection of spans corresponding to a single
32
- # operation or set of operations for an application. A span is an individual
33
- # timed event which forms a node of the trace tree. A single trace may
34
- # contain span(s) from multiple services.
30
+ # Service for collecting and viewing traces and spans within a trace.
31
+ #
32
+ # A trace is a collection of spans corresponding to a single
33
+ # operation or a set of operations in an application.
34
+ #
35
+ # A span is an individual timed event which forms a node of the trace tree.
36
+ # A single trace can contain spans from multiple services.
35
37
  #
36
38
  class Client
37
39
  include Paths
@@ -69,6 +71,9 @@ module Google
69
71
  default_config = Client::Configuration.new parent_config
70
72
 
71
73
  default_config.rpcs.batch_write_spans.timeout = 120.0
74
+ default_config.rpcs.batch_write_spans.retry_policy = {
75
+ initial_delay: 0.1, max_delay: 30.0, multiplier: 2, retry_codes: [14, 4]
76
+ }
72
77
 
73
78
  default_config.rpcs.create_span.timeout = 120.0
74
79
  default_config.rpcs.create_span.retry_policy = {
@@ -156,7 +161,7 @@ module Google
156
161
  # Service calls
157
162
 
158
163
  ##
159
- # Sends new spans to new or existing traces. You cannot update
164
+ # Batch writes new spans to new or existing traces. You cannot update
160
165
  # existing spans.
161
166
  #
162
167
  # @overload batch_write_spans(request, options = nil)
@@ -179,7 +184,7 @@ module Google
179
184
  # `projects/[PROJECT_ID]`.
180
185
  # @param spans [::Array<::Google::Cloud::Trace::V2::Span, ::Hash>]
181
186
  # Required. A list of new spans. The span names must not match existing
182
- # spans, or the results are undefined.
187
+ # spans, otherwise the results are undefined.
183
188
  #
184
189
  # @yield [response, operation] Access the result along with the RPC operation
185
190
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -266,34 +271,38 @@ module Google
266
271
  # @param name [::String]
267
272
  # Required. The resource name of the span in the following format:
268
273
  #
269
- # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
274
+ # * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]`
270
275
  #
271
- # [TRACE_ID] is a unique identifier for a trace within a project;
272
- # it is a 32-character hexadecimal encoding of a 16-byte array.
276
+ # `[TRACE_ID]` is a unique identifier for a trace within a project;
277
+ # it is a 32-character hexadecimal encoding of a 16-byte array. It should
278
+ # not be zero.
273
279
  #
274
- # [SPAN_ID] is a unique identifier for a span within a trace; it
275
- # is a 16-character hexadecimal encoding of an 8-byte array.
280
+ # `[SPAN_ID]` is a unique identifier for a span within a trace; it
281
+ # is a 16-character hexadecimal encoding of an 8-byte array. It should not
282
+ # be zero.
283
+ # .
276
284
  # @param span_id [::String]
277
- # Required. The [SPAN_ID] portion of the span's resource name.
285
+ # Required. The `[SPAN_ID]` portion of the span's resource name.
278
286
  # @param parent_span_id [::String]
279
- # The [SPAN_ID] of this span's parent span. If this is a root span,
287
+ # The `[SPAN_ID]` of this span's parent span. If this is a root span,
280
288
  # then this field must be empty.
281
289
  # @param display_name [::Google::Cloud::Trace::V2::TruncatableString, ::Hash]
282
290
  # Required. A description of the span's operation (up to 128 bytes).
283
- # Stackdriver Trace displays the description in the
284
- # Google Cloud Platform Console.
291
+ # Cloud Trace displays the description in the
292
+ # Cloud console.
285
293
  # For example, the display name can be a qualified method name or a file name
286
294
  # and a line number where the operation is called. A best practice is to use
287
295
  # the same display name within an application and at the same call point.
288
296
  # This makes it easier to correlate spans in different traces.
289
297
  # @param start_time [::Google::Protobuf::Timestamp, ::Hash]
290
- # Required. The start time of the span. On the client side, this is the time kept by
291
- # the local machine where the span execution starts. On the server side, this
292
- # is the time when the server's application handler starts running.
298
+ # Required. The start time of the span. On the client side, this is the time
299
+ # kept by the local machine where the span execution starts. On the server
300
+ # side, this is the time when the server's application handler starts
301
+ # running.
293
302
  # @param end_time [::Google::Protobuf::Timestamp, ::Hash]
294
- # Required. The end time of the span. On the client side, this is the time kept by
295
- # the local machine where the span execution ends. On the server side, this
296
- # is the time when the server application handler stops running.
303
+ # Required. The end time of the span. On the client side, this is the time
304
+ # kept by the local machine where the span execution ends. On the server
305
+ # side, this is the time when the server application handler stops running.
297
306
  # @param attributes [::Google::Cloud::Trace::V2::Span::Attributes, ::Hash]
298
307
  # A set of attributes on the span. You can have up to 32 attributes per
299
308
  # span.
@@ -309,15 +318,14 @@ module Google
309
318
  # @param same_process_as_parent_span [::Google::Protobuf::BoolValue, ::Hash]
310
319
  # Optional. Set this parameter to indicate whether this span is in
311
320
  # the same process as its parent. If you do not set this parameter,
312
- # Stackdriver Trace is unable to take advantage of this helpful
313
- # information.
321
+ # Trace is unable to take advantage of this helpful information.
314
322
  # @param child_span_count [::Google::Protobuf::Int32Value, ::Hash]
315
323
  # Optional. The number of child spans that were generated while this span
316
324
  # was active. If set, allows implementation to detect missing child spans.
317
325
  # @param span_kind [::Google::Cloud::Trace::V2::Span::SpanKind]
318
- # Optional. Distinguishes between spans generated in a particular context. For example,
319
- # two spans with the same name may be distinguished using `CLIENT` (caller)
320
- # and `SERVER` (callee) to identify an RPC call.
326
+ # Optional. Distinguishes between spans generated in a particular context.
327
+ # For example, two spans with the same name may be distinguished using
328
+ # `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
321
329
  #
322
330
  # @yield [response, operation] Access the result along with the RPC operation
323
331
  # @yieldparam response [::Google::Cloud::Trace::V2::Span]
@@ -31,13 +31,15 @@ module Google
31
31
  module Trace
32
32
  module V2
33
33
  ##
34
- # This file describes an API for collecting and viewing traces and spans
35
- # within a trace. A Trace is a collection of spans corresponding to a single
36
- # operation or set of operations for an application. A span is an individual
37
- # timed event which forms a node of the trace tree. A single trace may
38
- # contain span(s) from multiple services.
34
+ # Service for collecting and viewing traces and spans within a trace.
39
35
  #
40
- # To load this service and instantiate a client:
36
+ # A trace is a collection of spans corresponding to a single
37
+ # operation or a set of operations in an application.
38
+ #
39
+ # A span is an individual timed event which forms a node of the trace tree.
40
+ # A single trace can contain spans from multiple services.
41
+ #
42
+ # @example Load this service and instantiate a gRPC client
41
43
  #
42
44
  # require "google/cloud/trace/v2/trace_service"
43
45
  # client = ::Google::Cloud::Trace::V2::TraceService::Client.new
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Trace
23
23
  module V2
24
- VERSION = "0.4.0"
24
+ VERSION = "0.4.1"
25
25
  end
26
26
  end
27
27
  end
@@ -23,9 +23,9 @@ module Google
23
23
  module Cloud
24
24
  module Trace
25
25
  ##
26
- # To load this package, including all its services, and instantiate a client:
26
+ # API client module.
27
27
  #
28
- # @example
28
+ # @example Load this package, including all its services, and instantiate a gRPC client
29
29
  #
30
30
  # require "google/cloud/trace/v2"
31
31
  # client = ::Google::Cloud::Trace::V2::TraceService::Client.new
@@ -24,11 +24,13 @@ module Google
24
24
  module Trace
25
25
  module V2
26
26
  module TraceService
27
- # This file describes an API for collecting and viewing traces and spans
28
- # within a trace. A Trace is a collection of spans corresponding to a single
29
- # operation or set of operations for an application. A span is an individual
30
- # timed event which forms a node of the trace tree. A single trace may
31
- # contain span(s) from multiple services.
27
+ # Service for collecting and viewing traces and spans within a trace.
28
+ #
29
+ # A trace is a collection of spans corresponding to a single
30
+ # operation or a set of operations in an application.
31
+ #
32
+ # A span is an individual timed event which forms a node of the trace tree.
33
+ # A single trace can contain spans from multiple services.
32
34
  class Service
33
35
 
34
36
  include ::GRPC::GenericService
@@ -37,7 +39,7 @@ module Google
37
39
  self.unmarshal_class_method = :decode
38
40
  self.service_name = 'google.devtools.cloudtrace.v2.TraceService'
39
41
 
40
- # Sends new spans to new or existing traces. You cannot update
42
+ # Batch writes new spans to new or existing traces. You cannot update
41
43
  # existing spans.
42
44
  rpc :BatchWriteSpans, ::Google::Cloud::Trace::V2::BatchWriteSpansRequest, ::Google::Protobuf::Empty
43
45
  # Creates a new span.
@@ -0,0 +1,318 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # Required information for every language.
23
+ # @!attribute [rw] reference_docs_uri
24
+ # @return [::String]
25
+ # Link to automatically generated reference documentation. Example:
26
+ # https://cloud.google.com/nodejs/docs/reference/asset/latest
27
+ # @!attribute [rw] destinations
28
+ # @return [::Array<::Google::Api::ClientLibraryDestination>]
29
+ # The destination where API teams want this client library to be published.
30
+ class CommonLanguageSettings
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Details about how and where to publish client libraries.
36
+ # @!attribute [rw] version
37
+ # @return [::String]
38
+ # Version of the API to apply these settings to.
39
+ # @!attribute [rw] launch_stage
40
+ # @return [::Google::Api::LaunchStage]
41
+ # Launch stage of this version of the API.
42
+ # @!attribute [rw] rest_numeric_enums
43
+ # @return [::Boolean]
44
+ # When using transport=rest, the client request will encode enums as
45
+ # numbers rather than strings.
46
+ # @!attribute [rw] java_settings
47
+ # @return [::Google::Api::JavaSettings]
48
+ # Settings for legacy Java features, supported in the Service YAML.
49
+ # @!attribute [rw] cpp_settings
50
+ # @return [::Google::Api::CppSettings]
51
+ # Settings for C++ client libraries.
52
+ # @!attribute [rw] php_settings
53
+ # @return [::Google::Api::PhpSettings]
54
+ # Settings for PHP client libraries.
55
+ # @!attribute [rw] python_settings
56
+ # @return [::Google::Api::PythonSettings]
57
+ # Settings for Python client libraries.
58
+ # @!attribute [rw] node_settings
59
+ # @return [::Google::Api::NodeSettings]
60
+ # Settings for Node client libraries.
61
+ # @!attribute [rw] dotnet_settings
62
+ # @return [::Google::Api::DotnetSettings]
63
+ # Settings for .NET client libraries.
64
+ # @!attribute [rw] ruby_settings
65
+ # @return [::Google::Api::RubySettings]
66
+ # Settings for Ruby client libraries.
67
+ # @!attribute [rw] go_settings
68
+ # @return [::Google::Api::GoSettings]
69
+ # Settings for Go client libraries.
70
+ class ClientLibrarySettings
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # This message configures the settings for publishing [Google Cloud Client
76
+ # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
77
+ # generated from the service config.
78
+ # @!attribute [rw] method_settings
79
+ # @return [::Array<::Google::Api::MethodSettings>]
80
+ # A list of API method settings, e.g. the behavior for methods that use the
81
+ # long-running operation pattern.
82
+ # @!attribute [rw] new_issue_uri
83
+ # @return [::String]
84
+ # Link to a place that API users can report issues. Example:
85
+ # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
+ # @!attribute [rw] documentation_uri
87
+ # @return [::String]
88
+ # Link to product home page. Example:
89
+ # https://cloud.google.com/asset-inventory/docs/overview
90
+ # @!attribute [rw] api_short_name
91
+ # @return [::String]
92
+ # Used as a tracking tag when collecting data about the APIs developer
93
+ # relations artifacts like docs, packages delivered to package managers,
94
+ # etc. Example: "speech".
95
+ # @!attribute [rw] github_label
96
+ # @return [::String]
97
+ # GitHub label to apply to issues and pull requests opened for this API.
98
+ # @!attribute [rw] codeowner_github_teams
99
+ # @return [::Array<::String>]
100
+ # GitHub teams to be added to CODEOWNERS in the directory in GitHub
101
+ # containing source code for the client libraries for this API.
102
+ # @!attribute [rw] doc_tag_prefix
103
+ # @return [::String]
104
+ # A prefix used in sample code when demarking regions to be included in
105
+ # documentation.
106
+ # @!attribute [rw] organization
107
+ # @return [::Google::Api::ClientLibraryOrganization]
108
+ # For whom the client library is being published.
109
+ # @!attribute [rw] library_settings
110
+ # @return [::Array<::Google::Api::ClientLibrarySettings>]
111
+ # Client library settings. If the same version string appears multiple
112
+ # times in this list, then the last one wins. Settings from earlier
113
+ # settings with the same version string are discarded.
114
+ class Publishing
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Settings for Java client libraries.
120
+ # @!attribute [rw] library_package
121
+ # @return [::String]
122
+ # The package name to use in Java. Clobbers the java_package option
123
+ # set in the protobuf. This should be used **only** by APIs
124
+ # who have already set the language_settings.java.package_name" field
125
+ # in gapic.yaml. API teams should use the protobuf java_package option
126
+ # where possible.
127
+ #
128
+ # Example of a YAML configuration::
129
+ #
130
+ # publishing:
131
+ # java_settings:
132
+ # library_package: com.google.cloud.pubsub.v1
133
+ # @!attribute [rw] service_class_names
134
+ # @return [::Google::Protobuf::Map{::String => ::String}]
135
+ # Configure the Java class name to use instead of the service's for its
136
+ # corresponding generated GAPIC client. Keys are fully-qualified
137
+ # service names as they appear in the protobuf (including the full
138
+ # the language_settings.java.interface_names" field in gapic.yaml. API
139
+ # teams should otherwise use the service name as it appears in the
140
+ # protobuf.
141
+ #
142
+ # Example of a YAML configuration::
143
+ #
144
+ # publishing:
145
+ # java_settings:
146
+ # service_class_names:
147
+ # - google.pubsub.v1.Publisher: TopicAdmin
148
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
149
+ # @!attribute [rw] common
150
+ # @return [::Google::Api::CommonLanguageSettings]
151
+ # Some settings.
152
+ class JavaSettings
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+
156
+ # @!attribute [rw] key
157
+ # @return [::String]
158
+ # @!attribute [rw] value
159
+ # @return [::String]
160
+ class ServiceClassNamesEntry
161
+ include ::Google::Protobuf::MessageExts
162
+ extend ::Google::Protobuf::MessageExts::ClassMethods
163
+ end
164
+ end
165
+
166
+ # Settings for C++ client libraries.
167
+ # @!attribute [rw] common
168
+ # @return [::Google::Api::CommonLanguageSettings]
169
+ # Some settings.
170
+ class CppSettings
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+
175
+ # Settings for Php client libraries.
176
+ # @!attribute [rw] common
177
+ # @return [::Google::Api::CommonLanguageSettings]
178
+ # Some settings.
179
+ class PhpSettings
180
+ include ::Google::Protobuf::MessageExts
181
+ extend ::Google::Protobuf::MessageExts::ClassMethods
182
+ end
183
+
184
+ # Settings for Python client libraries.
185
+ # @!attribute [rw] common
186
+ # @return [::Google::Api::CommonLanguageSettings]
187
+ # Some settings.
188
+ class PythonSettings
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+
193
+ # Settings for Node client libraries.
194
+ # @!attribute [rw] common
195
+ # @return [::Google::Api::CommonLanguageSettings]
196
+ # Some settings.
197
+ class NodeSettings
198
+ include ::Google::Protobuf::MessageExts
199
+ extend ::Google::Protobuf::MessageExts::ClassMethods
200
+ end
201
+
202
+ # Settings for Dotnet client libraries.
203
+ # @!attribute [rw] common
204
+ # @return [::Google::Api::CommonLanguageSettings]
205
+ # Some settings.
206
+ class DotnetSettings
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # Settings for Ruby client libraries.
212
+ # @!attribute [rw] common
213
+ # @return [::Google::Api::CommonLanguageSettings]
214
+ # Some settings.
215
+ class RubySettings
216
+ include ::Google::Protobuf::MessageExts
217
+ extend ::Google::Protobuf::MessageExts::ClassMethods
218
+ end
219
+
220
+ # Settings for Go client libraries.
221
+ # @!attribute [rw] common
222
+ # @return [::Google::Api::CommonLanguageSettings]
223
+ # Some settings.
224
+ class GoSettings
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Describes the generator configuration for a method.
230
+ # @!attribute [rw] selector
231
+ # @return [::String]
232
+ # The fully qualified name of the method, for which the options below apply.
233
+ # This is used to find the method to apply the options.
234
+ # @!attribute [rw] long_running
235
+ # @return [::Google::Api::MethodSettings::LongRunning]
236
+ # Describes settings to use for long-running operations when generating
237
+ # API methods for RPCs. Complements RPCs that use the annotations in
238
+ # google/longrunning/operations.proto.
239
+ #
240
+ # Example of a YAML configuration::
241
+ #
242
+ # publishing:
243
+ # method_behavior:
244
+ # - selector: CreateAdDomain
245
+ # long_running:
246
+ # initial_poll_delay:
247
+ # seconds: 60 # 1 minute
248
+ # poll_delay_multiplier: 1.5
249
+ # max_poll_delay:
250
+ # seconds: 360 # 6 minutes
251
+ # total_poll_timeout:
252
+ # seconds: 54000 # 90 minutes
253
+ class MethodSettings
254
+ include ::Google::Protobuf::MessageExts
255
+ extend ::Google::Protobuf::MessageExts::ClassMethods
256
+
257
+ # Describes settings to use when generating API methods that use the
258
+ # long-running operation pattern.
259
+ # All default values below are from those used in the client library
260
+ # generators (e.g.
261
+ # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
262
+ # @!attribute [rw] initial_poll_delay
263
+ # @return [::Google::Protobuf::Duration]
264
+ # Initial delay after which the first poll request will be made.
265
+ # Default value: 5 seconds.
266
+ # @!attribute [rw] poll_delay_multiplier
267
+ # @return [::Float]
268
+ # Multiplier to gradually increase delay between subsequent polls until it
269
+ # reaches max_poll_delay.
270
+ # Default value: 1.5.
271
+ # @!attribute [rw] max_poll_delay
272
+ # @return [::Google::Protobuf::Duration]
273
+ # Maximum time between two subsequent poll requests.
274
+ # Default value: 45 seconds.
275
+ # @!attribute [rw] total_poll_timeout
276
+ # @return [::Google::Protobuf::Duration]
277
+ # Total polling timeout.
278
+ # Default value: 5 minutes.
279
+ class LongRunning
280
+ include ::Google::Protobuf::MessageExts
281
+ extend ::Google::Protobuf::MessageExts::ClassMethods
282
+ end
283
+ end
284
+
285
+ # The organization for which the client libraries are being published.
286
+ # Affects the url where generated docs are published, etc.
287
+ module ClientLibraryOrganization
288
+ # Not useful.
289
+ CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
290
+
291
+ # Google Cloud Platform Org.
292
+ CLOUD = 1
293
+
294
+ # Ads (Advertising) Org.
295
+ ADS = 2
296
+
297
+ # Photos Org.
298
+ PHOTOS = 3
299
+
300
+ # Street View Org.
301
+ STREET_VIEW = 4
302
+ end
303
+
304
+ # To where should client libraries be published?
305
+ module ClientLibraryDestination
306
+ # Client libraries will neither be generated nor published to package
307
+ # managers.
308
+ CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
309
+
310
+ # Generate the client library in a repo under github.com/googleapis,
311
+ # but don't publish it to package managers.
312
+ GITHUB = 10
313
+
314
+ # Publish the library to package managers like nuget.org and npmjs.com.
315
+ PACKAGE_MANAGER = 20
316
+ end
317
+ end
318
+ end
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # The launch stage as defined by [Google Cloud Platform
23
+ # Launch Stages](https://cloud.google.com/terms/launch-stages).
24
+ module LaunchStage
25
+ # Do not use this default value.
26
+ LAUNCH_STAGE_UNSPECIFIED = 0
27
+
28
+ # The feature is not yet implemented. Users can not use it.
29
+ UNIMPLEMENTED = 6
30
+
31
+ # Prelaunch features are hidden from users and are only visible internally.
32
+ PRELAUNCH = 7
33
+
34
+ # Early Access features are limited to a closed group of testers. To use
35
+ # these features, you must sign up in advance and sign a Trusted Tester
36
+ # agreement (which includes confidentiality provisions). These features may
37
+ # be unstable, changed in backward-incompatible ways, and are not
38
+ # guaranteed to be released.
39
+ EARLY_ACCESS = 1
40
+
41
+ # Alpha is a limited availability test for releases before they are cleared
42
+ # for widespread use. By Alpha, all significant design issues are resolved
43
+ # and we are in the process of verifying functionality. Alpha customers
44
+ # need to apply for access, agree to applicable terms, and have their
45
+ # projects allowlisted. Alpha releases don't have to be feature complete,
46
+ # no SLAs are provided, and there are no technical support obligations, but
47
+ # they will be far enough along that customers can actually use them in
48
+ # test environments or for limited-use tests -- just like they would in
49
+ # normal production cases.
50
+ ALPHA = 2
51
+
52
+ # Beta is the point at which we are ready to open a release for any
53
+ # customer to use. There are no SLA or technical support obligations in a
54
+ # Beta release. Products will be complete from a feature perspective, but
55
+ # may have some open outstanding issues. Beta releases are suitable for
56
+ # limited production use cases.
57
+ BETA = 3
58
+
59
+ # GA features are open to all developers and are considered stable and
60
+ # fully qualified for production use.
61
+ GA = 4
62
+
63
+ # Deprecated features are scheduled to be shut down and removed. For more
64
+ # information, see the "Deprecation Policy" section of our [Terms of
65
+ # Service](https://cloud.google.com/terms/)
66
+ # and the [Google Cloud Platform Subject to the Deprecation
67
+ # Policy](https://cloud.google.com/terms/deprecation) documentation.
68
+ DEPRECATED = 5
69
+ end
70
+ end
71
+ end
@@ -24,46 +24,52 @@ module Google
24
24
  # A span represents a single operation within a trace. Spans can be
25
25
  # nested to form a trace tree. Often, a trace contains a root span
26
26
  # that describes the end-to-end latency, and one or more subspans for
27
- # its sub-operations. A trace can also contain multiple root spans,
28
- # or none at all. Spans do not need to be contiguous&mdash;there may be
27
+ # its sub-operations.
28
+ #
29
+ # A trace can also contain multiple root spans, or none at all.
30
+ # Spans do not need to be contiguous. There might be
29
31
  # gaps or overlaps between spans in a trace.
30
32
  # @!attribute [rw] name
31
33
  # @return [::String]
32
34
  # Required. The resource name of the span in the following format:
33
35
  #
34
- # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
36
+ # * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]`
35
37
  #
36
- # [TRACE_ID] is a unique identifier for a trace within a project;
37
- # it is a 32-character hexadecimal encoding of a 16-byte array.
38
+ # `[TRACE_ID]` is a unique identifier for a trace within a project;
39
+ # it is a 32-character hexadecimal encoding of a 16-byte array. It should
40
+ # not be zero.
38
41
  #
39
- # [SPAN_ID] is a unique identifier for a span within a trace; it
40
- # is a 16-character hexadecimal encoding of an 8-byte array.
42
+ # `[SPAN_ID]` is a unique identifier for a span within a trace; it
43
+ # is a 16-character hexadecimal encoding of an 8-byte array. It should not
44
+ # be zero.
45
+ # .
41
46
  # @!attribute [rw] span_id
42
47
  # @return [::String]
43
- # Required. The [SPAN_ID] portion of the span's resource name.
48
+ # Required. The `[SPAN_ID]` portion of the span's resource name.
44
49
  # @!attribute [rw] parent_span_id
45
50
  # @return [::String]
46
- # The [SPAN_ID] of this span's parent span. If this is a root span,
51
+ # The `[SPAN_ID]` of this span's parent span. If this is a root span,
47
52
  # then this field must be empty.
48
53
  # @!attribute [rw] display_name
49
54
  # @return [::Google::Cloud::Trace::V2::TruncatableString]
50
55
  # Required. A description of the span's operation (up to 128 bytes).
51
- # Stackdriver Trace displays the description in the
52
- # Google Cloud Platform Console.
56
+ # Cloud Trace displays the description in the
57
+ # Cloud console.
53
58
  # For example, the display name can be a qualified method name or a file name
54
59
  # and a line number where the operation is called. A best practice is to use
55
60
  # the same display name within an application and at the same call point.
56
61
  # This makes it easier to correlate spans in different traces.
57
62
  # @!attribute [rw] start_time
58
63
  # @return [::Google::Protobuf::Timestamp]
59
- # Required. The start time of the span. On the client side, this is the time kept by
60
- # the local machine where the span execution starts. On the server side, this
61
- # is the time when the server's application handler starts running.
64
+ # Required. The start time of the span. On the client side, this is the time
65
+ # kept by the local machine where the span execution starts. On the server
66
+ # side, this is the time when the server's application handler starts
67
+ # running.
62
68
  # @!attribute [rw] end_time
63
69
  # @return [::Google::Protobuf::Timestamp]
64
- # Required. The end time of the span. On the client side, this is the time kept by
65
- # the local machine where the span execution ends. On the server side, this
66
- # is the time when the server application handler stops running.
70
+ # Required. The end time of the span. On the client side, this is the time
71
+ # kept by the local machine where the span execution ends. On the server
72
+ # side, this is the time when the server application handler stops running.
67
73
  # @!attribute [rw] attributes
68
74
  # @return [::Google::Cloud::Trace::V2::Span::Attributes]
69
75
  # A set of attributes on the span. You can have up to 32 attributes per
@@ -85,27 +91,26 @@ module Google
85
91
  # @return [::Google::Protobuf::BoolValue]
86
92
  # Optional. Set this parameter to indicate whether this span is in
87
93
  # the same process as its parent. If you do not set this parameter,
88
- # Stackdriver Trace is unable to take advantage of this helpful
89
- # information.
94
+ # Trace is unable to take advantage of this helpful information.
90
95
  # @!attribute [rw] child_span_count
91
96
  # @return [::Google::Protobuf::Int32Value]
92
97
  # Optional. The number of child spans that were generated while this span
93
98
  # was active. If set, allows implementation to detect missing child spans.
94
99
  # @!attribute [rw] span_kind
95
100
  # @return [::Google::Cloud::Trace::V2::Span::SpanKind]
96
- # Optional. Distinguishes between spans generated in a particular context. For example,
97
- # two spans with the same name may be distinguished using `CLIENT` (caller)
98
- # and `SERVER` (callee) to identify an RPC call.
101
+ # Optional. Distinguishes between spans generated in a particular context.
102
+ # For example, two spans with the same name may be distinguished using
103
+ # `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
99
104
  class Span
100
105
  include ::Google::Protobuf::MessageExts
101
106
  extend ::Google::Protobuf::MessageExts::ClassMethods
102
107
 
103
- # A set of attributes, each in the format `[KEY]:[VALUE]`.
108
+ # A set of attributes as key-value pairs.
104
109
  # @!attribute [rw] attribute_map
105
110
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Trace::V2::AttributeValue}]
106
- # The set of attributes. Each attribute's key can be up to 128 bytes
111
+ # A set of attributes. Each attribute's key can be up to 128 bytes
107
112
  # long. The value can be a string up to 256 bytes, a signed 64-bit integer,
108
- # or the Boolean values `true` and `false`. For example:
113
+ # or the boolean values `true` or `false`. For example:
109
114
  #
110
115
  # "/instance_id": { "string_value": { "value": "my-instance" } }
111
116
  # "/http/request_bytes": { "int_value": 300 }
@@ -165,15 +170,15 @@ module Google
165
170
  # @!attribute [rw] id
166
171
  # @return [::Integer]
167
172
  # An identifier for the MessageEvent's message that can be used to match
168
- # SENT and RECEIVED MessageEvents. It is recommended to be unique within
169
- # a Span.
173
+ # `SENT` and `RECEIVED` MessageEvents.
170
174
  # @!attribute [rw] uncompressed_size_bytes
171
175
  # @return [::Integer]
172
176
  # The number of uncompressed bytes sent or received.
173
177
  # @!attribute [rw] compressed_size_bytes
174
178
  # @return [::Integer]
175
- # The number of compressed bytes sent or received. If missing assumed to
176
- # be the same size as uncompressed.
179
+ # The number of compressed bytes sent or received. If missing, the
180
+ # compressed size is assumed to be the same size as the uncompressed
181
+ # size.
177
182
  class MessageEvent
178
183
  include ::Google::Protobuf::MessageExts
179
184
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -217,17 +222,17 @@ module Google
217
222
  # traces or when the handler receives a request from a different project.
218
223
  # @!attribute [rw] trace_id
219
224
  # @return [::String]
220
- # The [TRACE_ID] for a trace within a project.
225
+ # The `[TRACE_ID]` for a trace within a project.
221
226
  # @!attribute [rw] span_id
222
227
  # @return [::String]
223
- # The [SPAN_ID] for a span within a trace.
228
+ # The `[SPAN_ID]` for a span within a trace.
224
229
  # @!attribute [rw] type
225
230
  # @return [::Google::Cloud::Trace::V2::Span::Link::Type]
226
231
  # The relationship of the current span relative to the linked span.
227
232
  # @!attribute [rw] attributes
228
233
  # @return [::Google::Cloud::Trace::V2::Span::Attributes]
229
- # A set of attributes on the link. You have have up to 32 attributes per
230
- # link.
234
+ # A set of attributes on the link. Up to 32 attributes can be
235
+ # specified per link.
231
236
  class Link
232
237
  include ::Google::Protobuf::MessageExts
233
238
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -292,7 +297,7 @@ module Google
292
297
  end
293
298
  end
294
299
 
295
- # The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.
300
+ # The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.
296
301
  # @!attribute [rw] string_value
297
302
  # @return [::Google::Cloud::Trace::V2::TruncatableString]
298
303
  # A string up to 256 bytes long.
@@ -333,9 +338,10 @@ module Google
333
338
  # method that is active in this frame (up to 1024 bytes).
334
339
  # @!attribute [rw] original_function_name
335
340
  # @return [::Google::Cloud::Trace::V2::TruncatableString]
336
- # An un-mangled function name, if `function_name` is
337
- # [mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can
338
- # be fully-qualified (up to 1024 bytes).
341
+ # An un-mangled function name, if `function_name` is mangled.
342
+ # To get information about name mangling, run
343
+ # [this search](https://www.google.com/search?q=cxx+name+mangling).
344
+ # The name can be fully-qualified (up to 1024 bytes).
339
345
  # @!attribute [rw] file_name
340
346
  # @return [::Google::Cloud::Trace::V2::TruncatableString]
341
347
  # The name of the source file where the function call appears (up to 256
@@ -29,7 +29,7 @@ module Google
29
29
  # @!attribute [rw] spans
30
30
  # @return [::Array<::Google::Cloud::Trace::V2::Span>]
31
31
  # Required. A list of new spans. The span names must not match existing
32
- # spans, or the results are undefined.
32
+ # spans, otherwise the results are undefined.
33
33
  class BatchWriteSpansRequest
34
34
  include ::Google::Protobuf::MessageExts
35
35
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Protobuf
22
+ # A Duration represents a signed, fixed-length span of time represented
23
+ # as a count of seconds and fractions of seconds at nanosecond
24
+ # resolution. It is independent of any calendar and concepts like "day"
25
+ # or "month". It is related to Timestamp in that the difference between
26
+ # two Timestamp values is a Duration and it can be added or subtracted
27
+ # from a Timestamp. Range is approximately +-10,000 years.
28
+ #
29
+ # # Examples
30
+ #
31
+ # Example 1: Compute Duration from two Timestamps in pseudo code.
32
+ #
33
+ # Timestamp start = ...;
34
+ # Timestamp end = ...;
35
+ # Duration duration = ...;
36
+ #
37
+ # duration.seconds = end.seconds - start.seconds;
38
+ # duration.nanos = end.nanos - start.nanos;
39
+ #
40
+ # if (duration.seconds < 0 && duration.nanos > 0) {
41
+ # duration.seconds += 1;
42
+ # duration.nanos -= 1000000000;
43
+ # } else if (duration.seconds > 0 && duration.nanos < 0) {
44
+ # duration.seconds -= 1;
45
+ # duration.nanos += 1000000000;
46
+ # }
47
+ #
48
+ # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
49
+ #
50
+ # Timestamp start = ...;
51
+ # Duration duration = ...;
52
+ # Timestamp end = ...;
53
+ #
54
+ # end.seconds = start.seconds + duration.seconds;
55
+ # end.nanos = start.nanos + duration.nanos;
56
+ #
57
+ # if (end.nanos < 0) {
58
+ # end.seconds -= 1;
59
+ # end.nanos += 1000000000;
60
+ # } else if (end.nanos >= 1000000000) {
61
+ # end.seconds += 1;
62
+ # end.nanos -= 1000000000;
63
+ # }
64
+ #
65
+ # Example 3: Compute Duration from datetime.timedelta in Python.
66
+ #
67
+ # td = datetime.timedelta(days=3, minutes=10)
68
+ # duration = Duration()
69
+ # duration.FromTimedelta(td)
70
+ #
71
+ # # JSON Mapping
72
+ #
73
+ # In JSON format, the Duration type is encoded as a string rather than an
74
+ # object, where the string ends in the suffix "s" (indicating seconds) and
75
+ # is preceded by the number of seconds, with nanoseconds expressed as
76
+ # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
77
+ # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
78
+ # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
79
+ # microsecond should be expressed in JSON format as "3.000001s".
80
+ # @!attribute [rw] seconds
81
+ # @return [::Integer]
82
+ # Signed seconds of the span of time. Must be from -315,576,000,000
83
+ # to +315,576,000,000 inclusive. Note: these bounds are computed from:
84
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
85
+ # @!attribute [rw] nanos
86
+ # @return [::Integer]
87
+ # Signed fractions of a second at nanosecond resolution of the span
88
+ # of time. Durations less than one second are represented with a 0
89
+ # `seconds` field and a positive or negative `nanos` field. For durations
90
+ # of one second or more, a non-zero value for the `nanos` field must be
91
+ # of the same sign as the `seconds` field. Must be from -999,999,999
92
+ # to +999,999,999 inclusive.
93
+ class Duration
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+ end
98
+ end
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-trace-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.4.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-07-08 00:00:00.000000000 Z
11
+ date: 2023-01-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.10'
19
+ version: 0.16.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.10'
29
+ version: 0.16.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -183,11 +183,14 @@ files:
183
183
  - lib/google/devtools/cloudtrace/v2/tracing_pb.rb
184
184
  - lib/google/devtools/cloudtrace/v2/tracing_services_pb.rb
185
185
  - proto_docs/README.md
186
+ - proto_docs/google/api/client.rb
186
187
  - proto_docs/google/api/field_behavior.rb
188
+ - proto_docs/google/api/launch_stage.rb
187
189
  - proto_docs/google/api/resource.rb
188
190
  - proto_docs/google/devtools/cloudtrace/v2/trace.rb
189
191
  - proto_docs/google/devtools/cloudtrace/v2/tracing.rb
190
192
  - proto_docs/google/protobuf/any.rb
193
+ - proto_docs/google/protobuf/duration.rb
191
194
  - proto_docs/google/protobuf/empty.rb
192
195
  - proto_docs/google/protobuf/timestamp.rb
193
196
  - proto_docs/google/protobuf/wrappers.rb
@@ -211,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
211
214
  - !ruby/object:Gem::Version
212
215
  version: '0'
213
216
  requirements: []
214
- rubygems_version: 3.3.14
217
+ rubygems_version: 3.4.2
215
218
  signing_key:
216
219
  specification_version: 4
217
220
  summary: API Client library for the Cloud Trace V2 API