google-cloud-trace-v2 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7ad9562c999185921aa9e0c1ad80ca6e7450a6830a77840108a03220d8e7e4
-  data.tar.gz: f563a78ddeadeb474d7b2b544ed1d50cfd43e25f3ed4f2410e3e01c7378b42bb
+  metadata.gz: 301a2c0272350f4499cc6cbdd479f3f0c5e75671ceb29795dddab5606021188e
+  data.tar.gz: b920d6892f84d7dbed237a4d5c0d20f73882e75556febace1d4aeef32922b5cf
 SHA512:
-  metadata.gz: 28bd6138924f535aecfdccad163cbc2aa12db42ff2950f3740893b683b2d10380f429a8cfdb3b02a22c20ea533aad1c24a898702b0c465f632d9d692a075d200
-  data.tar.gz: a422e89e1d5d54b1d3262073afdf03a24dea0e4bcd4748a88ffda6daa1110d8f31a1ccb8b414a63e58692638e1c5e97783bb8840781d2be5724682f35fd8dbbd
+  metadata.gz: 87f06c9a3ecce4246547ff74e8026e08f692c713e96f39b016559845b563e448d5d2dbaf389cf8fb7fb44702825c0d152d6a3a956ae0f7d7e98daba6dbdd7d49
+  data.tar.gz: 1b7b847a95f498049dbc516ce945c568688e6ad9ee18d89405b12b8a1bae55bc45690fdd8e37f2cc5fcde6b03315b29bf85814df8ee58dcc9ebf9c996d823af0

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -1,8 +1,8 @@
 # Ruby Client for the Cloud Trace V2 API
 
-API Client library for the Cloud Trace V2 API
+Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenTelemetry.
 
-The Cloud Trace API lets you send and retrieve latency data to and from Cloud Trace. This API provides low-level interfaces for interacting directly with the feature. For some languages, you can use OpenCensus, a set of open source tracing and stats instrumentation libraries that work with multiple backends.
+The Cloud Trace API lets you send and retrieve latency data to and from Cloud Trace. This API provides low-level interfaces for interacting directly with the feature. For some languages, you can use OpenTelemetry, a set of open source tracing and stats instrumentation libraries that work with multiple backends.
 
 https://github.com/googleapis/google-cloud-ruby
 
@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 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)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

data/lib/google/cloud/trace/v2/rest.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/trace/v2/trace_service/rest"
+require "google/cloud/trace/v2/version"
+
+module Google
+  module Cloud
+    module Trace
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/trace/v2/rest"
+      #     client = ::Google::Cloud::Trace::V2::TraceService::Rest::Client.new
+      #
+      module V2
+      end
+    end
+  end
+end

data/lib/google/cloud/trace/v2/trace_service/client.rb

@@ -27,11 +27,13 @@ module Google
           ##
           # Client for the TraceService service.
           #
-          # This file describes an API for collecting and viewing traces and spans
-          # within a trace.  A Trace is a collection of spans corresponding to a single
-          # operation or set of operations for an application. A span is an individual
-          # timed event which forms a node of the trace tree. A single trace may
-          # contain span(s) from multiple services.
+          # Service for collecting and viewing traces and spans within a trace.
+          #
+          # A trace is a collection of spans corresponding to a single
+          # operation or a set of operations in an application.
+          #
+          # A span is an individual timed event which forms a node of the trace tree.
+          # A single trace can contain spans from multiple services.
           #
           class Client
             include Paths
@@ -69,6 +71,9 @@ module Google
                 default_config = Client::Configuration.new parent_config
 
                 default_config.rpcs.batch_write_spans.timeout = 120.0
+                default_config.rpcs.batch_write_spans.retry_policy = {
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 2, retry_codes: [14, 4]
+                }
 
                 default_config.rpcs.create_span.timeout = 120.0
                 default_config.rpcs.create_span.retry_policy = {
@@ -156,7 +161,7 @@ module Google
             # Service calls
 
             ##
-            # Sends new spans to new or existing traces. You cannot update
+            # Batch writes new spans to new or existing traces. You cannot update
             # existing spans.
             #
             # @overload batch_write_spans(request, options = nil)
@@ -179,7 +184,7 @@ module Google
             #     `projects/[PROJECT_ID]`.
             #   @param spans [::Array<::Google::Cloud::Trace::V2::Span, ::Hash>]
             #     Required. A list of new spans. The span names must not match existing
-            #     spans, or the results are undefined.
+            #     spans, otherwise the results are undefined.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -266,34 +271,38 @@ module Google
             #   @param name [::String]
             #     Required. The resource name of the span in the following format:
             #
-            #         projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
+            #      * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]`
             #
-            #     [TRACE_ID] is a unique identifier for a trace within a project;
-            #     it is a 32-character hexadecimal encoding of a 16-byte array.
+            #     `[TRACE_ID]` is a unique identifier for a trace within a project;
+            #     it is a 32-character hexadecimal encoding of a 16-byte array. It should
+            #     not be zero.
             #
-            #     [SPAN_ID] is a unique identifier for a span within a trace; it
-            #     is a 16-character hexadecimal encoding of an 8-byte array.
+            #     `[SPAN_ID]` is a unique identifier for a span within a trace; it
+            #     is a 16-character hexadecimal encoding of an 8-byte array. It should not
+            #     be zero.
+            #     .
             #   @param span_id [::String]
-            #     Required. The [SPAN_ID] portion of the span's resource name.
+            #     Required. The `[SPAN_ID]` portion of the span's resource name.
             #   @param parent_span_id [::String]
-            #     The [SPAN_ID] of this span's parent span. If this is a root span,
+            #     The `[SPAN_ID]` of this span's parent span. If this is a root span,
             #     then this field must be empty.
             #   @param display_name [::Google::Cloud::Trace::V2::TruncatableString, ::Hash]
             #     Required. A description of the span's operation (up to 128 bytes).
-            #     Stackdriver Trace displays the description in the
-            #     Google Cloud Platform Console.
+            #     Cloud Trace displays the description in the
+            #     Cloud console.
             #     For example, the display name can be a qualified method name or a file name
             #     and a line number where the operation is called. A best practice is to use
             #     the same display name within an application and at the same call point.
             #     This makes it easier to correlate spans in different traces.
             #   @param start_time [::Google::Protobuf::Timestamp, ::Hash]
-            #     Required. The start time of the span. On the client side, this is the time kept by
-            #     the local machine where the span execution starts. On the server side, this
-            #     is the time when the server's application handler starts running.
+            #     Required. The start time of the span. On the client side, this is the time
+            #     kept by the local machine where the span execution starts. On the server
+            #     side, this is the time when the server's application handler starts
+            #     running.
             #   @param end_time [::Google::Protobuf::Timestamp, ::Hash]
-            #     Required. The end time of the span. On the client side, this is the time kept by
-            #     the local machine where the span execution ends. On the server side, this
-            #     is the time when the server application handler stops running.
+            #     Required. The end time of the span. On the client side, this is the time
+            #     kept by the local machine where the span execution ends. On the server
+            #     side, this is the time when the server application handler stops running.
             #   @param attributes [::Google::Cloud::Trace::V2::Span::Attributes, ::Hash]
             #     A set of attributes on the span. You can have up to 32 attributes per
             #     span.
@@ -309,15 +318,14 @@ module Google
             #   @param same_process_as_parent_span [::Google::Protobuf::BoolValue, ::Hash]
             #     Optional. Set this parameter to indicate whether this span is in
             #     the same process as its parent. If you do not set this parameter,
-            #     Stackdriver Trace is unable to take advantage of this helpful
-            #     information.
+            #     Trace is unable to take advantage of this helpful information.
             #   @param child_span_count [::Google::Protobuf::Int32Value, ::Hash]
             #     Optional. The number of child spans that were generated while this span
             #     was active. If set, allows implementation to detect missing child spans.
             #   @param span_kind [::Google::Cloud::Trace::V2::Span::SpanKind]
-            #     Optional. Distinguishes between spans generated in a particular context. For example,
-            #     two spans with the same name may be distinguished using `CLIENT` (caller)
-            #     and `SERVER` (callee) to identify an RPC call.
+            #     Optional. Distinguishes between spans generated in a particular context.
+            #     For example, two spans with the same name may be distinguished using
+            #     `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Trace::V2::Span]