google-cloud-trace 0.34.1 → 0.34.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02b2e97b5844be3d6cdeb71952946f9a9a508bed27d0e50129ab62f99809cebf
-  data.tar.gz: '0149ae3e5a579db3e91c7dc38f4e3eeff117c53682d724eca50e4890ec2b4dc0'
+  metadata.gz: 7519f860e058884c0abedc93d49565ff8bc7b6a12a432bfd4194e5dca06b12fa
+  data.tar.gz: 2b2f62529a7a9741143d4ecf592387489f4e7ce856dbd83976cd9fbf41321151
 SHA512:
-  metadata.gz: f318a17c151faaf6eb790a0378eacde5a50764c9826d8f158dc83b668fd29c4f34e84d9e36907f23e79cbc327b1f0b013c7cc57f83d4353a97f00e5a917f8ca1
-  data.tar.gz: 06f9ca91cccf1262eed810ddf6e8ea65478d00fd4a7c77d08a0093535260267ad4601c531c3e87a5517fd1f689e0f73a2fdd5ac07f380153436e0807f17cebe8
+  metadata.gz: 27a1d602c21c19dd03526088cf664b85c2ed729ed35363a828fc1c63043fe97937a9056d1640bbce1bf96fa2a8d253478fe22f22599408adaec3f9f857f6ada1
+  data.tar.gz: 16a6f56576e8494af4886d3165bf904015b906df8a7b5416c51bf5ab5e173a33bcdd297df0dd97ffddd166638bf1712a23138d6764a78d24f0498014dfd43594

data/AUTHENTICATION.md

@@ -2,20 +2,39 @@
 
 In general, the google-cloud-trace library uses [Service
 Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running on Compute Engine
+credentials to connect to Google Cloud services. When running within [Google
+Cloud Platform environments](#google-cloud-platform-environments)
 the credentials will be discovered automatically. When running on other
 environments, the Service Account credentials can be specified by providing the
 path to the [JSON
 keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
-the account (or the JSON itself) in environment variables. Additionally, Cloud
-SDK credentials can also be discovered automatically, but this is only
-recommended during development.
+the account (or the JSON itself) in [environment
+variables](#environment-variables). Additionally, Cloud SDK credentials can also
+be discovered automatically, but this is only recommended during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export TRACE_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/trace"
+
+client = Google::Cloud::Trace.new
+```
 
 ## Project and Credential Lookup
 
-The google-cloud-trace library aims to make authentication as simple as
-possible, and provides several mechanisms to configure your system without
-providing **Project ID** and **Service Account Credentials** directly in code.
+The google-cloud-trace library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without providing **Project ID** and **Service Account Credentials** directly in
+code.
 
 **Project ID** is discovered in the following order:
 
@@ -23,6 +42,7 @@ providing **Project ID** and **Service Account Credentials** directly in code.
 2. Specify project ID in configuration
 3. Discover project ID in environment variables
 4. Discover GCE project ID
+5. Discover project ID in credentials JSON
 
 **Credentials** are discovered in the following order:
 
@@ -73,12 +93,12 @@ environment variable, or the **Credentials JSON** itself can be stored for
 environments such as Docker containers where writing files is difficult or not
 encouraged.
 
-The environment variables that Trace checks for project ID are:
+The environment variables that google-cloud-trace checks for project ID are:
 
 1. `TRACE_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that Trace checks for credentials are configured on {Google::Cloud::Trace::V1::Credentials}:
+The environment variables that google-cloud-trace checks for credentials are configured on {Google::Cloud::Trace::V2::Credentials}:
 
 1. `TRACE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `TRACE_KEYFILE` - Path to JSON file, or JSON contents
@@ -92,7 +112,7 @@ require "google/cloud/trace"
 ENV["TRACE_PROJECT"]     = "my-project-id"
 ENV["TRACE_CREDENTIALS"] = "path/to/keyfile.json"
 
-trace = Google::Cloud::Trace.new
+client = Google::Cloud::Trace.new
 ```
 
 ### Configuration
@@ -107,7 +127,7 @@ Google::Cloud::Trace.configure do |config|
   config.credentials = "path/to/keyfile.json"
 end
 
-trace = Google::Cloud::Trace.new
+client = Google::Cloud::Trace.new
 ```
 
 ### Cloud SDK
@@ -140,7 +160,8 @@ Google Cloud requires a **Project ID** and **Service Account Credentials** to
 connect to the APIs. You will use the **Project ID** and **JSON key file** to
 connect to most services with google-cloud-trace.
 
-If you are not running this client on Google Compute Engine, you need a Google
+If you are not running this client within [Google Cloud Platform
+environments](#google-cloud-platform-environments), you need a Google
 Developers service account.
 
 1. Visit the [Google Developers Console][dev-console].

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+### 0.34.2 / 2019-04-29
+
+* Add AUTHENTICATION.md guide.
+* Update generated documentation.
+* Update generated code examples.
+* Extract gRPC header values from request.
+
 ### 0.34.1 / 2019-02-13
 
 * Fix bug (typo) in retrieving default on_error proc.

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

@@ -15,17 +15,19 @@
 
 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).
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The 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](https://www.ietf.org/rfc/rfc3339.txt) date strings.
     #
     # = Examples
     #
@@ -86,12 +88,12 @@ module Google
     # 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]
+    # 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://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
     # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [Integer]

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

@@ -179,7 +179,10 @@ module Google
             @patch_traces = Google::Gax.create_api_call(
               @trace_service_stub.method(:patch_traces),
               defaults["patch_traces"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
             @get_trace = Google::Gax.create_api_call(
               @trace_service_stub.method(:get_trace),
@@ -189,7 +192,10 @@ module Google
             @list_traces = Google::Gax.create_api_call(
               @trace_service_stub.method(:list_traces),
               defaults["list_traces"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'project_id' => request.project_id}
+              end
             )
           end
 
@@ -217,14 +223,14 @@ module Google
           # @example
           #   require "google/cloud/trace"
           #
-          #   trace_service_client = Google::Cloud::Trace.new(version: :v1)
+          #   trace_client = Google::Cloud::Trace.new(version: :v1)
           #
           #   # TODO: Initialize `project_id`:
           #   project_id = ''
           #
           #   # TODO: Initialize `traces`:
           #   traces = {}
-          #   trace_service_client.patch_traces(project_id, traces)
+          #   trace_client.patch_traces(project_id, traces)
 
           def patch_traces \
               project_id,
@@ -257,14 +263,14 @@ module Google
           # @example
           #   require "google/cloud/trace"
           #
-          #   trace_service_client = Google::Cloud::Trace.new(version: :v1)
+          #   trace_client = Google::Cloud::Trace.new(version: :v1)
           #
           #   # TODO: Initialize `project_id`:
           #   project_id = ''
           #
           #   # TODO: Initialize `trace_id`:
           #   trace_id = ''
-          #   response = trace_service_client.get_trace(project_id, trace_id)
+          #   response = trace_client.get_trace(project_id, trace_id)
 
           def get_trace \
               project_id,
@@ -287,9 +293,11 @@ module Google
           #   Type of data returned for traces in the list. Optional. Default is
           #   `MINIMAL`.
           # @param page_size [Integer]
-          #   Maximum number of traces to return. If not specified or <= 0, the
-          #   implementation selects a reasonable value.  The implementation may
-          #   return fewer traces than the requested page size. Optional.
+          #   The maximum number of resources contained in the underlying API
+          #   response. If page streaming is performed per-resource, this
+          #   parameter does not affect the return value. If page streaming is
+          #   performed per-page, this determines the maximum number of
+          #   resources in a page.
           # @param start_time [Google::Protobuf::Timestamp | Hash]
           #   Start of the time interval (inclusive) during which the trace data was
           #   collected from the application.
@@ -360,18 +368,18 @@ module Google
           # @example
           #   require "google/cloud/trace"
           #
-          #   trace_service_client = Google::Cloud::Trace.new(version: :v1)
+          #   trace_client = Google::Cloud::Trace.new(version: :v1)
           #
           #   # TODO: Initialize `project_id`:
           #   project_id = ''
           #
           #   # Iterate over all results.
-          #   trace_service_client.list_traces(project_id).each do |element|
+          #   trace_client.list_traces(project_id).each do |element|
           #     # Process element.
           #   end
           #
           #   # Or iterate over results one page at a time.
-          #   trace_service_client.list_traces(project_id).each_page do |page|
+          #   trace_client.list_traces(project_id).each_page do |page|
           #     # Process each page at a time.
           #     page.each do |element|
           #       # Process element.

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

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

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

@@ -15,17 +15,19 @@
 
 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).
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The 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](https://www.ietf.org/rfc/rfc3339.txt) date strings.
     #
     # = Examples
     #
@@ -86,12 +88,12 @@ module Google
     # 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]
+    # 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://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
     # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [Integer]

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

@@ -15,24 +15,25 @@
 
 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:
+    # 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.
+    # 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
     #
@@ -69,12 +70,14 @@ module Google
     #   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}.
+    #     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.
+    #     {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

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

@@ -202,12 +202,18 @@ module Google
             @batch_write_spans = Google::Gax.create_api_call(
               @trace_service_stub.method(:batch_write_spans),
               defaults["batch_write_spans"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @create_span = Google::Gax.create_api_call(
               @trace_service_stub.method(:create_span),
               defaults["create_span"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
           end
 
@@ -234,12 +240,12 @@ module Google
           # @example
           #   require "google/cloud/trace"
           #
-          #   trace_service_client = Google::Cloud::Trace.new(version: :v2)
+          #   trace_client = Google::Cloud::Trace.new(version: :v2)
           #   formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.project_path("[PROJECT]")
           #
           #   # TODO: Initialize `spans`:
           #   spans = []
-          #   trace_service_client.batch_write_spans(formatted_name, spans)
+          #   trace_client.batch_write_spans(formatted_name, spans)
 
           def batch_write_spans \
               name,
@@ -339,7 +345,7 @@ module Google
           # @example
           #   require "google/cloud/trace"
           #
-          #   trace_service_client = Google::Cloud::Trace.new(version: :v2)
+          #   trace_client = Google::Cloud::Trace.new(version: :v2)
           #   formatted_name = Google::Cloud::Trace::V2::TraceServiceClient.span_path("[PROJECT]", "[TRACE]", "[SPAN]")
           #
           #   # TODO: Initialize `span_id`:
@@ -353,7 +359,7 @@ module Google
           #
           #   # TODO: Initialize `end_time`:
           #   end_time = {}
-          #   response = trace_service_client.create_span(formatted_name, span_id, display_name, start_time, end_time)
+          #   response = trace_client.create_span(formatted_name, span_id, display_name, start_time, end_time)
 
           def create_span \
               name,

data/lib/google/cloud/trace/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Trace
-      VERSION = "0.34.1".freeze
+      VERSION = "0.34.2".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-trace
 version: !ruby/object:Gem::Version
-  version: 0.34.1
+  version: 0.34.2
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.64.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.64.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -328,8 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Application Instrumentation and API Client library for Stackdriver Trace