google-cloud-trace 0.29.0 → 0.30.0

data/lib/google/cloud/trace/v2/doc/google/protobuf/timestamp.rb

@@ -0,0 +1,106 @@
+# Copyright 2017 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.
+
+module Google
+  module Protobuf
+    # A Timestamp represents a point in time independent of any time zone
+    # or calendar, represented as seconds and fractions of seconds at
+    # nanosecond resolution in UTC Epoch time. It is encoded using the
+    # Proleptic Gregorian Calendar which extends the Gregorian calendar
+    # backwards to year one. It is encoded assuming all minutes are 60
+    # seconds long, i.e. leap seconds are "smeared" so that no leap second
+    # table is needed for interpretation. Range is from
+    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
+    # By restricting to that range, we ensure that we can convert to
+    # and from  RFC 3339 date strings.
+    # See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
+    #
+    # = Examples
+    #
+    # Example 1: Compute Timestamp from POSIX +time()+.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    #
+    # Example 5: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+    # where {year} is always expressed using four digits while {month}, {day},
+    # {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required, though only UTC (as indicated by "Z") is presently supported.
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
+    # method. In Python, a standard +datetime.datetime+ object can be converted
+    # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
+    # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
+    # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
+    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime())
+    # to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp; end
+  end
+end

data/lib/google/cloud/trace/v2/doc/google/protobuf/wrappers.rb

@@ -0,0 +1,89 @@
+# Copyright 2017 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.
+
+module Google
+  module Protobuf
+    # Wrapper message for +double+.
+    #
+    # The JSON representation for +DoubleValue+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Float]
+    #     The double value.
+    class DoubleValue; end
+
+    # Wrapper message for +float+.
+    #
+    # The JSON representation for +FloatValue+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Float]
+    #     The float value.
+    class FloatValue; end
+
+    # Wrapper message for +int64+.
+    #
+    # The JSON representation for +Int64Value+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The int64 value.
+    class Int64Value; end
+
+    # Wrapper message for +uint64+.
+    #
+    # The JSON representation for +UInt64Value+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The uint64 value.
+    class UInt64Value; end
+
+    # Wrapper message for +int32+.
+    #
+    # The JSON representation for +Int32Value+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The int32 value.
+    class Int32Value; end
+
+    # Wrapper message for +uint32+.
+    #
+    # The JSON representation for +UInt32Value+ is JSON number.
+    # @!attribute [rw] value
+    #   @return [Integer]
+    #     The uint32 value.
+    class UInt32Value; end
+
+    # Wrapper message for +bool+.
+    #
+    # The JSON representation for +BoolValue+ is JSON +true+ and +false+.
+    # @!attribute [rw] value
+    #   @return [true, false]
+    #     The bool value.
+    class BoolValue; end
+
+    # Wrapper message for +string+.
+    #
+    # The JSON representation for +StringValue+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     The string value.
+    class StringValue; end
+
+    # Wrapper message for +bytes+.
+    #
+    # The JSON representation for +BytesValue+ is JSON string.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     The bytes value.
+    class BytesValue; end
+  end
+end

data/lib/google/cloud/trace/v2/doc/google/rpc/status.rb

@@ -0,0 +1,83 @@
+# Copyright 2017 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.
+
+module Google
+  module Rpc
+    # The +Status+ type defines a logical error model that is suitable for different
+    # programming environments, including REST APIs and RPC APIs. It is used by
+    # [gRPC](https://github.com/grpc). The error model is designed to be:
+    #
+    # * Simple to use and understand for most users
+    # * Flexible enough to meet unexpected needs
+    #
+    # = Overview
+    #
+    # The +Status+ message contains three pieces of data: error code, error message,
+    # and error details. The error code should be an enum value of
+    # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
+    # error message should be a developer-facing English message that helps
+    # developers *understand* and *resolve* the error. If a localized user-facing
+    # error message is needed, put the localized message in the error details or
+    # localize it in the client. The optional error details may contain arbitrary
+    # information about the error. There is a predefined set of error detail types
+    # in the package +google.rpc+ that can be used for common error conditions.
+    #
+    # = Language mapping
+    #
+    # The +Status+ message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the +Status+ message is
+    # exposed in different client libraries and different wire protocols, it can be
+    # mapped differently. For example, it will likely be mapped to some exceptions
+    # in Java, but more likely mapped to some error codes in C.
+    #
+    # = Other uses
+    #
+    # The error model and the +Status+ message can be used in a variety of
+    # environments, either with or without APIs, to provide a
+    # consistent developer experience across different environments.
+    #
+    # Example uses of this error model include:
+    #
+    # * Partial errors. If a service needs to return partial errors to the client,
+    #   it may embed the +Status+ in the normal response to indicate the partial
+    #   errors.
+    #
+    # * Workflow errors. A typical workflow has multiple steps. Each step may
+    #   have a +Status+ message for error reporting.
+    #
+    # * Batch operations. If a client uses batch request and batch response, the
+    #   +Status+ message should be used directly inside batch response, one for
+    #   each error sub-response.
+    #
+    # * Asynchronous operations. If an API call embeds asynchronous operation
+    #   results in its response, the status of those operations should be
+    #   represented directly using the +Status+ message.
+    #
+    # * Logging. If some API errors are stored in logs, the message +Status+ could
+    #   be used directly after any stripping needed for security/privacy reasons.
+    # @!attribute [rw] code
+    #   @return [Integer]
+    #     The status code, which should be an enum value of {Google::Rpc::Code}.
+    # @!attribute [rw] message
+    #   @return [String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     {Google::Rpc::Status#details} field, or localized by the client.
+    # @!attribute [rw] details
+    #   @return [Array<Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
+    class Status; end
+  end
+end

data/lib/google/cloud/trace/v2/doc/overview.rb

@@ -0,0 +1,67 @@
+# Copyright 2017 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.
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Stackdriver Trace API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Stackdriver Trace API][Product Documentation]:
+    # 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.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+    # 3. [Enable the Stackdriver Trace API.](https://console.cloud.google.com/apis/api/trace)
+    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-trace
+    # ```
+    #
+    # ### Preview
+    # #### TraceServiceClient
+    # ```rb
+    # require "google/cloud/trace"
+    #
+    # trace_service_client = Google::Cloud::Trace.new
+    # formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.project_path(project_id)
+    # spans = []
+    # trace_service_client.batch_write_spans(formatted_name, spans)
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Stackdriver Trace API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/trace
+    #
+    #
+    module Trace
+      module V2
+      end
+    end
+  end
+end

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

@@ -0,0 +1,364 @@
+# Copyright 2017 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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/devtools/cloudtrace/v2/tracing.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+#
+# The only allowed edits are to method and file documentation. A 3-way
+# merge preserves those additions if the generated source changes.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+
+require "google/devtools/cloudtrace/v2/tracing_pb"
+require "google/cloud/trace/credentials"
+
+module Google
+  module Cloud
+    module Trace
+      module V2
+        # 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.
+        #
+        # @!attribute [r] trace_service_stub
+        #   @return [Google::Devtools::Cloudtrace::V2::TraceService::Stub]
+        class TraceServiceClient
+          attr_reader :trace_service_stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "cloudtrace.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          DEFAULT_TIMEOUT = 30
+
+          # The scopes needed to make gRPC calls to all of the methods defined in
+          # this service.
+          ALL_SCOPES = [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/trace.append"
+          ].freeze
+
+
+          PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}"
+          )
+
+          private_constant :PROJECT_PATH_TEMPLATE
+
+          SPAN_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/traces/{trace}/spans/{span}"
+          )
+
+          private_constant :SPAN_PATH_TEMPLATE
+
+          # Returns a fully-qualified project resource name string.
+          # @param project [String]
+          # @return [String]
+          def self.project_path project
+            PROJECT_PATH_TEMPLATE.render(
+              :"project" => project
+            )
+          end
+
+          # Returns a fully-qualified span resource name string.
+          # @param project [String]
+          # @param trace [String]
+          # @param span [String]
+          # @return [String]
+          def self.span_path project, trace, span
+            SPAN_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"trace" => trace,
+              :"span" => span
+            )
+          end
+
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          def initialize \
+              credentials: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              lib_name: nil,
+              lib_version: ""
+            # These require statements are intentionally placed here to initialize
+            # the gRPC module only when it's required.
+            # See https://github.com/googleapis/toolkit/issues/446
+            require "google/gax/grpc"
+            require "google/devtools/cloudtrace/v2/tracing_services_pb"
+
+            credentials ||= Google::Cloud::Trace::Credentials.default
+
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::Trace::Credentials.new(credentials).updater_proc
+            end
+            if credentials.is_a?(GRPC::Core::Channel)
+              channel = credentials
+            end
+            if credentials.is_a?(GRPC::Core::ChannelCredentials)
+              chan_creds = credentials
+            end
+            if credentials.is_a?(Proc)
+              updater_proc = credentials
+            end
+            if credentials.is_a?(Google::Auth::Credentials)
+              updater_proc = credentials.updater_proc
+            end
+
+            package_version = Gem.loaded_specs['google-cloud-trace'].version.version
+
+            google_api_client = "gl-ruby/#{RUBY_VERSION}"
+            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+            google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
+            google_api_client << " grpc/#{GRPC::VERSION}"
+            google_api_client.freeze
+
+            headers = { :"x-goog-api-client" => google_api_client }
+            client_config_file = Pathname.new(__dir__).join(
+              "trace_service_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.devtools.cloudtrace.v2.TraceService",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                kwargs: headers
+              )
+            end
+
+            # Allow overriding the service path/port in subclasses.
+            service_path = self.class::SERVICE_ADDRESS
+            port = self.class::DEFAULT_SERVICE_PORT
+            @trace_service_stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              updater_proc: updater_proc,
+              scopes: scopes,
+              &Google::Devtools::Cloudtrace::V2::TraceService::Stub.method(:new)
+            )
+
+            @batch_write_spans = Google::Gax.create_api_call(
+              @trace_service_stub.method(:batch_write_spans),
+              defaults["batch_write_spans"]
+            )
+            @create_span = Google::Gax.create_api_call(
+              @trace_service_stub.method(:create_span),
+              defaults["create_span"]
+            )
+          end
+
+          # Service calls
+
+          # Sends new spans to new or existing traces. You cannot update
+          # existing spans.
+          #
+          # @param name [String]
+          #   Required. The name of the project where the spans belong. The format is
+          #   +projects/[PROJECT_ID]+.
+          # @param spans [Array<Google::Devtools::Cloudtrace::V2::Span | Hash>]
+          #   A list of new spans. The span names must not match existing
+          #   spans, or the results are undefined.
+          #   A hash of the same form as `Google::Devtools::Cloudtrace::V2::Span`
+          #   can also be provided.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/trace/v2"
+          #
+          #   trace_service_client = Google::Cloud::Trace::V2.new
+          #   formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.project_path("[PROJECT]")
+          #   spans = []
+          #   trace_service_client.batch_write_spans(formatted_name, spans)
+
+          def batch_write_spans \
+              name,
+              spans,
+              options: nil
+            req = {
+              name: name,
+              spans: spans
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Devtools::Cloudtrace::V2::BatchWriteSpansRequest)
+            @batch_write_spans.call(req, options)
+            nil
+          end
+
+          # Creates a new span.
+          #
+          # @param name [String]
+          #   The resource name of the span in the following format:
+          #
+          #       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.
+          #
+          #   [SPAN_ID] is a unique identifier for a span within a trace; it
+          #   is a 16-character hexadecimal encoding of an 8-byte array.
+          # @param span_id [String]
+          #   The [SPAN_ID] portion of the span's resource name.
+          # @param display_name [Google::Devtools::Cloudtrace::V2::TruncatableString | Hash]
+          #   A description of the span's operation (up to 128 bytes).
+          #   Stackdriver Trace displays the description in the
+          #   {% dynamic print site_values.console_name %}.
+          #   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.
+          #   A hash of the same form as `Google::Devtools::Cloudtrace::V2::TruncatableString`
+          #   can also be provided.
+          # @param start_time [Google::Protobuf::Timestamp | Hash]
+          #   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.
+          #   A hash of the same form as `Google::Protobuf::Timestamp`
+          #   can also be provided.
+          # @param end_time [Google::Protobuf::Timestamp | Hash]
+          #   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.
+          #   A hash of the same form as `Google::Protobuf::Timestamp`
+          #   can also be provided.
+          # @param parent_span_id [String]
+          #   The [SPAN_ID] of this span's parent span. If this is a root span,
+          #   then this field must be empty.
+          # @param attributes [Google::Devtools::Cloudtrace::V2::Span::Attributes | Hash]
+          #   A set of attributes on the span. You can have up to 32 attributes per
+          #   span.
+          #   A hash of the same form as `Google::Devtools::Cloudtrace::V2::Span::Attributes`
+          #   can also be provided.
+          # @param stack_trace [Google::Devtools::Cloudtrace::V2::StackTrace | Hash]
+          #   Stack trace captured at the start of the span.
+          #   A hash of the same form as `Google::Devtools::Cloudtrace::V2::StackTrace`
+          #   can also be provided.
+          # @param time_events [Google::Devtools::Cloudtrace::V2::Span::TimeEvents | Hash]
+          #   A set of time events. You can have up to 32 annotations and 128 message
+          #   events per span.
+          #   A hash of the same form as `Google::Devtools::Cloudtrace::V2::Span::TimeEvents`
+          #   can also be provided.
+          # @param links [Google::Devtools::Cloudtrace::V2::Span::Links | Hash]
+          #   Links associated with the span. You can have up to 128 links per Span.
+          #   A hash of the same form as `Google::Devtools::Cloudtrace::V2::Span::Links`
+          #   can also be provided.
+          # @param status [Google::Rpc::Status | Hash]
+          #   An optional final status for this span.
+          #   A hash of the same form as `Google::Rpc::Status`
+          #   can also be provided.
+          # @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.
+          #   A hash of the same form as `Google::Protobuf::BoolValue`
+          #   can also be provided.
+          # @param child_span_count [Google::Protobuf::Int32Value | Hash]
+          #   An optional number of child spans that were generated while this span
+          #   was active. If set, allows implementation to detect missing child spans.
+          #   A hash of the same form as `Google::Protobuf::Int32Value`
+          #   can also be provided.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Devtools::Cloudtrace::V2::Span]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/trace/v2"
+          #
+          #   trace_service_client = Google::Cloud::Trace::V2.new
+          #   formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.span_path("[PROJECT]", "[TRACE]", "[SPAN]")
+          #   span_id = ''
+          #   display_name = {}
+          #   start_time = {}
+          #   end_time = {}
+          #   response = trace_service_client.create_span(formatted_name, span_id, display_name, start_time, end_time)
+
+          def create_span \
+              name,
+              span_id,
+              display_name,
+              start_time,
+              end_time,
+              parent_span_id: nil,
+              attributes: nil,
+              stack_trace: nil,
+              time_events: nil,
+              links: nil,
+              status: nil,
+              same_process_as_parent_span: nil,
+              child_span_count: nil,
+              options: nil
+            req = {
+              name: name,
+              span_id: span_id,
+              display_name: display_name,
+              start_time: start_time,
+              end_time: end_time,
+              parent_span_id: parent_span_id,
+              attributes: attributes,
+              stack_trace: stack_trace,
+              time_events: time_events,
+              links: links,
+              status: status,
+              same_process_as_parent_span: same_process_as_parent_span,
+              child_span_count: child_span_count
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Devtools::Cloudtrace::V2::Span)
+            @create_span.call(req, options)
+          end
+        end
+      end
+    end
+  end
+end