google-cloud-trace 0.21.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c1a9cb5d58e30bc4fba83ba6c1e5e3086b7334d
+  data.tar.gz: cfe2ae3c6deff51e73be893b811a24143e8ecc11
+SHA512:
+  metadata.gz: ef0e5a93830a6bca11771fda5d855ed0c3e1ed2c7e9b559fb8036ecff6c98396b86fccd868e9f02358278331e50b95b64fe62834abf95fed45389b8f3b184f4a
+  data.tar.gz: e40003165b0f933489545d65d98a9e29a976731be8f35d0cee300a8d0c686e0bb151119ed94e91fbc8fe6dcbc8772c52ad0317d16c094dc79a2d8ed8495aec92

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--title=Stackdriver Trace
+--markup markdown
+
+./lib/**/*.rb
+-
+README.md

data/LICENSE

@@ -0,0 +1,201 @@
+                            Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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.

data/README.md

@@ -0,0 +1,45 @@
+Stackdriver Trace API for Ruby
+=================================================
+
+google-cloud-trace uses [Google API extensions][google-gax] to provide an
+easy-to-use client library for the [Stackdriver Trace API][] (v1) defined in the [googleapis][] git repository
+
+
+[googleapis]: https://github.com/googleapis/googleapis/tree/master/google/google/devtools/cloudtrace/v1
+[google-gax]: https://github.com/googleapis/gax-ruby
+[Stackdriver Trace API]: https://developers.google.com/apis-explorer/#p/cloudtrace/v1/
+
+Getting started
+---------------
+
+google-cloud-trace will allow you to connect to the [Stackdriver Trace API][] and access all its methods.
+
+In order to achieve so you need to set up authentication as well as install the library locally.
+
+
+Setup Authentication
+--------------------
+
+To authenticate all your API calls, first install and setup the [Google Cloud SDK][].
+Once done, you can then run the following command in your terminal:
+
+    $ gcloud beta auth application-default login
+
+or
+
+    $ gcloud auth login
+
+Please see [gcloud beta auth application-default login][] document for the difference between these commands.
+
+[Google Cloud SDK]: https://cloud.google.com/sdk/
+[gcloud beta auth application-default login]: https://cloud.google.com/sdk/gcloud/reference/beta/auth/application-default/login
+
+
+Installation
+-------------------
+
+Install this library using gem:
+
+    $ [sudo] gem install google-cloud-trace
+
+At this point you are all set to continue.

data/lib/google-cloud-trace.rb

@@ -0,0 +1,97 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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
+#
+#     http://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.
+
+##
+# This file is here to be autorequired by bundler, so that the .trace and
+# #trace methods can be available, but the library and all dependencies won't
+# be loaded until required and used.
+
+
+gem "google-cloud-core"
+require "google/cloud"
+
+module Google
+  module Cloud
+    ##
+    # Creates a new object for connecting to the Stackdriver Trace service.
+    # Each call creates a new connection.
+    #
+    # For more information on connecting to Google Cloud see the [Authentication
+    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    #
+    # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
+    #   set of resources and operations that the connection can access. See
+    #   [Using OAuth 2.0 to Access Google
+    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+    #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    #
+    # @return [Google::Cloud::Trace::Project]
+    #
+    # @example
+    #   require "google/cloud"
+    #
+    #   gcloud = Google::Cloud.new
+    #   trace_client = gcloud.trace
+    #
+    #   traces = trace_client.list_traces Time.now - 3600, Time.now
+    #   traces.each do |trace|
+    #     puts "Retrieved trace ID: #{trace.trace_id}"
+    #   end
+    #
+    def trace scope: nil, timeout: nil, client_config: nil
+      Google::Cloud.trace @project, @keyfile, scope: scope,
+                                              timeout: (timeout || @timeout),
+                                              client_config: client_config
+    end
+
+    ##
+    # Creates a new object for connecting to the Stackdriver Trace service.
+    # Each call creates a new connection.
+    #
+    # For more information on connecting to Google Cloud see the [Authentication
+    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    #
+    # @param [String] project Project identifier for the Stackdriver Trace
+    #   service.
+    # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud:
+    #   either the JSON data or the path to a readable file.
+    # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
+    #   set of resources and operations that the connection can access. See
+    #   [Using OAuth 2.0 to Access Google
+    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+    #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    #
+    # @return [Google::Cloud::Trace::Project]
+    #
+    # @example
+    #   require "google/cloud"
+    #
+    #   trace_client = Google::Cloud.trace
+    #
+    #   traces = trace_client.list_traces Time.now - 3600, Time.now
+    #   traces.each do |trace|
+    #     puts "Retrieved trace ID: #{trace.trace_id}"
+    #   end
+    #
+    def self.trace project = nil, keyfile = nil, scope: nil, timeout: nil,
+                   client_config: nil
+      require "google/cloud/trace"
+      Google::Cloud::Trace.new project: project, keyfile: keyfile,
+                               scope: scope, timeout: timeout,
+                               client_config: client_config
+    end
+  end
+end

data/lib/google/cloud/trace.rb

@@ -0,0 +1,340 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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
+#
+#     http://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.
+
+
+require "stackdriver/core/trace_context"
+require "google-cloud-trace"
+require "google/cloud/trace/version"
+require "google/cloud/trace/credentials"
+require "google/cloud/trace/label_key"
+require "google/cloud/trace/middleware"
+require "google/cloud/trace/notifications"
+require "google/cloud/trace/project"
+require "google/cloud/trace/result_set"
+require "google/cloud/trace/service"
+require "google/cloud/trace/span"
+require "google/cloud/trace/span_kind"
+require "google/cloud/trace/time_sampler"
+require "google/cloud/trace/trace_record"
+require "google/cloud/trace/utils"
+
+module Google
+  module Cloud
+    ##
+    # # Stackdriver Trace
+    #
+    # The Stackdriver Trace service collects and stores latency data from your
+    # application and displays it in the Google Cloud Platform Console, giving
+    # you detailed near-real-time insight into application performance.
+    #
+    # The Stackdriver Trace Ruby library, `google-cloud-trace`, provides:
+    #
+    # *   Easy-to-use trace instrumentation that collects and collates latency
+    #     data for your Ruby application. If you just want latency trace data
+    #     for your application to appear on the Google Cloud Platform Console,
+    #     see the section on [instrumenting your app](#instrumenting-your-app).
+    # *   An idiomatic Ruby API for querying, analyzing, and manipulating trace
+    #     data in your Ruby application. For an introduction to the Trace API,
+    #     see the section on the [Trace API](#stackdriver-trace-api).
+    #
+    # ## Instrumenting Your App
+    #
+    # This library integrates with Rack-based web frameworks such as Ruby On
+    # Rails to provide latency trace reports for your application.
+    # Specifcally, it:
+    #
+    # *   Provides a Rack middleware that automatically reports latency traces
+    #     for http requests handled by your application, and measures the
+    #     latency of each request as a whole.
+    # *   Integrates with `ActiveSupport::Notifications` to add important
+    #     latency-affecting events such as ActiveRecord queries to the trace.
+    # *   Provides a simple API for your application code to define and
+    #     measure latency-affecting processes specific to your application.
+    #
+    # When this library is installed and configured in your running
+    # application, you can view your application's latency traces in real time
+    # by opening the Google Cloud Console in your web browser and navigating
+    # to the "Trace" section. It also integrates with Google App Engine
+    # Flexible and Google Container Engine to provide additional information
+    # for applications hosted in those environments.
+    #
+    # Note that not all requests will have traces. By default, the library will
+    # sample about one trace every ten seconds per Ruby process, to prevent
+    # heavily used applications from reporting too much data. It will also
+    # omit certain requests used by Google App Engine for health checking. See
+    # {Google::Cloud::Trace::TimeSampler} for more details.
+    #
+    # ### Using instrumentation with Ruby on Rails
+    #
+    # To install application instrumentation in your Ruby on Rails app, add
+    # this gem, `google-cloud-trace`, to your Gemfile and update your bundle.
+    # Then add the following line to your `config/application.rb` file:
+    #
+    # ```ruby
+    # require "google/cloud/trace/rails"
+    # ```
+    #
+    # This will install a Railtie that automatically integrates with the
+    # Rails framework, installing the middleware and the ActiveSupport
+    # integration for you. Your application traces, including basic request
+    # tracing, ActiveRecord query measurements, and view render measurements,
+    # should then start appearing in the Cloud Console.
+    #
+    # See the {Google::Cloud::Trace::Railtie} class for more information,
+    # including how to customize your application traces.
+    #
+    # ### Using instrumentation with Sinatra
+    #
+    # To install application instrumentation in your Sinatra app, add this gem,
+    # `google-cloud-trace`, to your Gemfile and update your bundle. Then add
+    # the following lines to your main application Ruby file:
+    #
+    # ```ruby
+    # require "google/cloud/trace"
+    # use Google::Cloud::Trace::Middleware
+    # ```
+    #
+    # This will install the trace middleware in your application, providing
+    # basic request tracing for your application. You may measure additional
+    # processes such as database queries or calls to external services using
+    # other classes in this library. See the {Google::Cloud::Trace::Middleware}
+    # documentation for more information.
+    #
+    # ### Using instrumentation with other Rack-based frameworks
+    #
+    # To install application instrumentation in an app using another Rack-based
+    # web framework, add this gem, `google-cloud-trace`, to your Gemfile and
+    # update your bundle. Then add install the trace middleware in your
+    # middleware stack. In most cases, this means adding these lines to your
+    # `config.ru` Rack configuration file:
+    #
+    # ```ruby
+    # require "google/cloud/trace"
+    # use Google::Cloud::Trace::Middleware
+    # ```
+    #
+    # Some web frameworks have an alternate mechanism for modifying the
+    # middleware stack. Consult your web framework's documentation for more
+    # information.
+    #
+    # ### The Stackdriver diagnostics suite
+    #
+    # The trace library is part of the Stackdriver diagnostics suite, which
+    # also includes error reporting and log analysis. If you include the
+    # `stackdriver` gem in your Gemfile, this trace library will be included
+    # automatically. In addition, if you include the `stackdriver` gem in an
+    # application using Ruby On Rails, the Railtie will be installed
+    # automatically; you will not need to write any code to view latency
+    # traces for your appl. See the documentation for the "stackdriver" gem
+    # for more details.
+    #
+    # ## Stackdriver Trace API
+    #
+    # This library also includes an easy to use Ruby client for the
+    # Stackdriver Trace API. This API provides calls to report and modify
+    # application traces, as well as to query and analyze existing traces.
+    #
+    # For further information on the trace API, see
+    # {Google::Cloud::Trace::Project}.
+    #
+    # ### Querying traces using the API
+    #
+    # Using the Stackdriver Trace API, your application can query and analyze
+    # its own traces and traces of other projects. Here is an example query
+    # for all traces in the past hour.
+    #
+    # ```ruby
+    # require "google/cloud/trace"
+    # trace_client = Google::Cloud::Trace.new
+    #
+    # traces = trace_client.list_traces Time.now - 3600, Time.now
+    # traces.each do |trace|
+    #   puts "Retrieved trace ID: #{trace.trace_id}"
+    # end
+    # ```
+    #
+    # Each trace is an object of type {Google::Cloud::Trace::TraceRecord},
+    # which provides methods for analyzing tasks that took place during the
+    # request trace. See https://cloud.google.com/trace for more information
+    # on the kind of data you can capture in a trace.
+    #
+    # ### Reporting traces using the API
+    #
+    # Usually it is easiest to use this library's trace instrumentation
+    # features to collect and record application trace information. However,
+    # you may also use the trace API to update this data. Here is an example:
+    #
+    # ```ruby
+    # require "google/cloud/trace"
+    #
+    # trace_client = Google::Cloud::Trace.new
+    #
+    # trace = Google::Cloud::Trace.new
+    # trace.in_span "root_span" do
+    #   # Do stuff...
+    # end
+    #
+    # trace_client.patch_traces trace
+    # ```
+    #
+    module Trace
+      THREAD_KEY = :__stackdriver_trace_span__
+
+      ##
+      # Creates a new object for connecting to the Stackdriver Trace service.
+      # Each call creates a new connection.
+      #
+      # For more information on connecting to Google Cloud see the
+      # [Authentication
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+      #
+      # @param [String] project Project identifier for the Stackdriver Trace
+      #   service.
+      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud:
+      #   either the JSON data or the path to a readable file.
+      # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
+      #   the set of resources and operations that the connection can access.
+      #   See [Using OAuth 2.0 to Access Google
+      #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+      #   The default scope is `https://www.googleapis.com/auth/cloud-platform`
+      # @param [Integer] timeout Default timeout to use in requests. Optional.
+      #
+      # @return [Google::Cloud::Trace::Project]
+      #
+      # @example
+      #   require "google/cloud/trace"
+      #
+      #   trace_client = Google::Cloud::Trace.new
+      #
+      #   traces = trace_client.list_traces Time.now - 3600, Time.now
+      #   traces.each do |trace|
+      #     puts "Retrieved trace ID: #{trace.trace_id}"
+      #   end
+      #
+      def self.new project: nil, keyfile: nil, scope: nil, timeout: nil,
+                   client_config: nil
+        project ||= Google::Cloud::Trace::Project.default_project
+        project = project.to_s # Always cast to a string
+        fail ArgumentError, "project is missing" if project.empty?
+
+        credentials =
+          Google::Cloud::Trace::Credentials.credentials_with_scope keyfile,
+                                                                   scope
+
+        Google::Cloud::Trace::Project.new(
+          Google::Cloud::Trace::Service.new(
+            project, credentials, timeout: timeout,
+                                  client_config: client_config))
+      end
+
+      ##
+      # Set the current trace span being measured for the current thread, or
+      # the current trace if no span is currently open. This may be used with
+      # web frameworks that assign a thread to each request, to track the
+      # trace instrumentation state for the request being handled. You may use
+      # {Google::Cloud::Trace.get} to retrieve the data.
+      #
+      # @param [Google::Cloud::Trace::TraceSpan,
+      #     Google::Cloud::Trace::TraceRecord, nil] trace The current span
+      #     being measured, the current trace object, or `nil` if none.
+      #
+      # @example
+      #   require "google/cloud/trace"
+      #
+      #   trace_client = Google::Cloud::Trace.new
+      #   trace = trace_client.new_trace
+      #   Google::Cloud::Trace.set trace
+      #
+      #   # Later...
+      #   Google::Cloud::Trace.get.create_span "my_span"
+      #
+      def self.set trace
+        trace_context = trace ? trace.trace_context : nil
+        Stackdriver::Core::TraceContext.set trace_context
+        Thread.current[THREAD_KEY] = trace
+      end
+
+      ##
+      # Retrieve the current trace span or trace object for the current thread.
+      # This data should previously have been set using
+      # {Google::Cloud::Trace.set}.
+      #
+      # @return [Google::Cloud::Trace::TraceSpan,
+      #     Google::Cloud::Trace::TraceRecord, nil] The span or trace object,
+      #     or `nil`.
+      #
+      # @example
+      #   require "google/cloud/trace"
+      #
+      #   trace_client = Google::Cloud::Trace.new
+      #   trace = trace_client.new_trace
+      #   Google::Cloud::Trace.set trace
+      #
+      #   # Later...
+      #   Google::Cloud::Trace.get.create_span "my_span"
+      #
+      def self.get
+        Thread.current[THREAD_KEY]
+      end
+
+      ##
+      # Open a new span for the current thread, instrumenting the given block.
+      # The span is created within the current thread's trace context as set by
+      # {Google::Cloud::Trace.set}. The context is updated so any further calls
+      # within the block will create subspans. The new span is also yielded to
+      # the block.
+      #
+      # Does nothing if there is no trace context for the current thread.
+      #
+      # @param [String] name Name of the span to create
+      # @param [Google::Cloud::Trace::SpanKind] kind Kind of span to create.
+      #     Optional.
+      # @param [Hash{String => String}] labels Labels for the span
+      #
+      # @example
+      #   require "google/cloud/trace"
+      #
+      #   trace_client = Google::Cloud::Trace.new
+      #   trace = trace_client.new_trace
+      #   Google::Cloud::Trace.set trace
+      #
+      #   Google::Cloud::Trace.in_span "my_span" do |span|
+      #     span.labels["foo"] = "bar"
+      #     # Do stuff...
+      #
+      #     Google::Cloud::Trace.in_span "my_subspan" do |subspan|
+      #       subspan.labels["foo"] = "sub-bar"
+      #       # Do other stuff...
+      #     end
+      #   end
+      #
+      def self.in_span name, kind: Google::Cloud::Trace::SpanKind::UNSPECIFIED,
+                       labels: {}
+        parent = get
+        if parent
+          parent.in_span name, kind: kind, labels: labels do |child|
+            set child
+            begin
+              yield child
+            ensure
+              set parent
+            end
+          end
+        else
+          yield nil
+        end
+      end
+    end
+  end
+end