opencensus-stackdriver 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a4b99ffafcd195ad6f1e10fa9957dc71e99af29a49fdc333e804426b1311f2a
-  data.tar.gz: 47f8a94bb41ea9bd68f7bcb8c40abfb752333bb61b473f8e7389d2d211b9e636
+  metadata.gz: 0c38340ddaa943b074e93623040737f17eacbd06d93f2adf0568fa2f4653776e
+  data.tar.gz: fd1589264c08774869166ff8a249e7e35e0a42e30f17048f09a60c859bc71539
 SHA512:
-  metadata.gz: 501f0cd5aab282baadbb2183a6bbfd03afb1ef72aee2a20a2ed2c52ef0cece43d5a945b9babbb94a52384e22a4177cd6f4cc2b8f08780126ab344c0cbb1eb314
-  data.tar.gz: 33d165acd0a0d36d8ab7afa82a61daba8951a5d5cb822c80bc8d8e08cd1274a2121e1b68ca7c189211b48e99694a11a7663950c099ebd95a7cbcf911c86c1e54
+  metadata.gz: f7404e1915c08587c91fcc6c25664b4419e600dbc5456639c5eff53a07811660b64e610ad45aa0e993b792ca1b5bd24b11915b385661cad9f25aefa0618a1a94
+  data.tar.gz: 584e5a22a969028271fcec0021baa1b24349e461029d2b41bef42cc1bbd5fb3ef3d6abbfbfd93362368b0d60dada4c6648b35484c71a3fd3306fa0015169303c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+### 0.4.0 / 2020-07-23
+
+* Update for compatibility with changes to the google-cloud-trace and google-cloud-monitoring library structure.
+* Requires Ruby 2.4 or later.
+
 ### 0.3.2 / 2020-02-24
 
 * Update the google-cloud-trace and google-cloud-monitoring dependencies to versions that support service address override.

data/lib/opencensus/stackdriver/version.rb

@@ -16,6 +16,6 @@
 module OpenCensus
   module Stackdriver
     ## Current OpenCensus Stackdriver plugin version
-    VERSION = "0.3.2".freeze
+    VERSION = "0.4.0".freeze
   end
 end

data/lib/opencensus/stats/exporters/stackdriver.rb

@@ -15,11 +15,11 @@
 # limitations under the License.
 
 
-gem "google-cloud-monitoring"
+gem "google-cloud-monitoring-v3"
 gem "concurrent-ruby"
 
 require "concurrent"
-require "google/cloud/monitoring"
+require "google/cloud/env"
 require "google/cloud/monitoring/v3"
 
 module OpenCensus
@@ -112,7 +112,7 @@ module OpenCensus
             credentials: nil,
             scope: nil,
             timeout: nil,
-            client_config: nil,
+            client_config: nil, # rubocop:disable Lint/UnusedMethodArgument
             max_queue: 1000,
             max_threads: 1,
             auto_terminate_time: 10,
@@ -121,7 +121,9 @@ module OpenCensus
             resource_type: nil,
             resource_labels: nil,
             gcm_service_address: nil
-          @project_id = final_project_id project_id
+          @project_id = project_id ||
+                        ENV["GOOGLE_CLOUD_PROJECT"] ||
+                        Google::Cloud.env.project_id
           @metric_prefix = metric_prefix || CUSTOM_OPENCENSUS_DOMAIN
           @resource_type = resource_type || GLOBAL_RESOURCE_TYPE
           @resource_labels = resource_labels || {
@@ -137,15 +139,13 @@ module OpenCensus
             @client_promise =
               Concurrent::Promise.fulfill mock_client, executor: @executor
           else
-            credentials = final_credentials credentials, scope
             @client_promise = create_client_promise \
-              @executor, credentials, scope, client_config, timeout,
-              gcm_service_address
+              @executor, credentials, scope, timeout, gcm_service_address
           end
 
           @converter = Converter.new @project_id
-          @project_path = Google::Cloud::Monitoring::V3:: \
-            MetricServiceClient.project_path @project_id
+          paths = Google::Cloud::Monitoring::V3::MetricService::Paths
+          @project_path = paths.project_path project: @project_id
         end
 
         # Export stats to Monitoring service asynchronously.
@@ -247,15 +247,16 @@ module OpenCensus
             view,
             metric_prefix
           )
-          metric_name = Google::Cloud::Monitoring::V3:: \
-            MetricServiceClient.metric_descriptor_path(
-              project_id,
-              metric_descriptor.type
-            )
+          paths = Google::Cloud::Monitoring::V3::MetricService::Paths
+          metric_name = paths.metric_descriptor_path(
+            project: project_id,
+            metric_descriptor: metric_descriptor.type
+          )
 
           @client_promise.execute
           descriptor_create_promise = @client_promise.then do |client|
-            client.create_metric_descriptor metric_name, metric_descriptor
+            client.create_metric_descriptor name: metric_name,
+                                            metric_descriptor: metric_descriptor
           end
           descriptor_create_promise.value!
         end
@@ -278,18 +279,17 @@ module OpenCensus
         # We create the client lazily so grpc doesn't get initialized until
         # we actually need it. This is important because if it is intialized
         # too early, before a fork, it can go into a bad state.
-        def create_client_promise executor, credentials, scopes, client_config,
+        def create_client_promise executor, credentials, scopes,
                                   timeout, service_address
           Concurrent::Promise.new executor: executor do
-            Google::Cloud::Monitoring::Metric.new(
-              credentials: credentials,
-              scopes: scopes,
-              client_config: client_config,
-              timeout: timeout,
-              lib_name: "opencensus",
-              lib_version: OpenCensus::Stackdriver::VERSION,
-              service_address: service_address
-            )
+            Google::Cloud::Monitoring::V3::MetricService::Client.new do |config|
+              config.credentials = credentials if credentials
+              config.scope = scopes if scopes
+              config.timeout = timeout if timeout
+              config.endpoint = service_address if service_address
+              config.lib_name = "opencensus"
+              config.lib_version = OpenCensus::Stackdriver::VERSION
+            end
           end
         end
 
@@ -304,27 +304,6 @@ module OpenCensus
           end
         end
 
-        # Fall back to default project ID
-        def final_project_id project_id
-          project_id ||
-            Google::Cloud.configure.project_id ||
-            Google::Cloud.env.project_id
-        end
-
-        # Fall back to default credentials, and wrap in a creds object
-        def final_credentials credentials, scope
-          credentials ||=
-            Google::Cloud.configure.credentials ||
-            Google::Cloud::Monitoring::V3::Credentials.default(scope: scope)
-          unless credentials.is_a? Google::Auth::Credentials
-            credentials = Google::Cloud::Monitoring::V3::Credentials.new(
-              credentials,
-              scope: scope
-            )
-          end
-          credentials
-        end
-
         # Export a list of stats in the current thread
         def export_as_batch client, views_data
           time_series = views_data.map do |view_data|
@@ -336,7 +315,8 @@ module OpenCensus
             )
           end
 
-          client.create_time_series @project_path, time_series.flatten!
+          client.create_time_series name: @project_path,
+                                    time_series: time_series.flatten
         end
       end
     end

data/lib/opencensus/stats/exporters/stackdriver/converter.rb

@@ -114,14 +114,14 @@ module OpenCensus
           # @param [String] resource_type Metric resource type
           # @param [Hash<String,String>] resource_labels Metric resource labels
           # @param [OpenCensus::Stats::ViewData] view_data Stats view data
-          # @return [Array[Google::Monitoring::V3::TimeSeries]]
+          # @return [Array[Google::Cloud::Monitoring::V3::TimeSeries]]
           #
           def convert_time_series metric_prefix, resource_type, resource_labels,
                                   view_data
             view = view_data.view
 
             view_data.data.map do |tag_values, aggr_data|
-              series = Google::Monitoring::V3::TimeSeries.new(
+              series = Google::Cloud::Monitoring::V3::TimeSeries.new(
                 metric: {
                   type: make_metric_type(metric_prefix, view.name),
                   labels: Hash[view.columns.zip tag_values]
@@ -152,7 +152,7 @@ module OpenCensus
           # @param [OpenCensus::Stats:Measure] measure Measure details
           # @param [OpenCensus::Stats:AggregationData] aggr_data Aggregated data
           # @raise [TypeError] If invalid aggr data type.
-          # @return [Google::Monitoring::V3::Point]
+          # @return [Google::Cloud::Monitoring::V3::Point]
           def convert_point start_time, end_time, measure, aggr_data
             case aggr_data
             when OpenCensus::Stats::AggregationData::Distribution
@@ -181,7 +181,7 @@ module OpenCensus
           # @param [Time] start_time Start time
           # @param [Time] end_time Start time
           # @param [OpenCensus::Stats::AggregationData::Distribution] aggr_data
-          # @return [Google::Monitoring::V3::Point]
+          # @return [Google::Cloud::Monitoring::V3::Point]
           #
           def create_distribution_point start_time, end_time, aggr_data
             value = {
@@ -196,7 +196,7 @@ module OpenCensus
               bucket_counts: [0].concat(aggr_data.bucket_counts)
             }
 
-            Google::Monitoring::V3::Point.new(
+            Google::Cloud::Monitoring::V3::Point.new(
               interval: {
                 start_time: convert_time(start_time),
                 end_time: convert_time(end_time)
@@ -212,7 +212,7 @@ module OpenCensus
           # @param [Time] end_time Start time
           # @param [Integer, Float] value
           # @param [OpenCensus::Stats::Measure] measure Measure defination
-          # @return [Google::Monitoring::V3::Point]
+          # @return [Google::Cloud::Monitoring::V3::Point]
           #
           def create_number_point start_time, end_time, value, measure
             value = if measure.int64?
@@ -221,7 +221,7 @@ module OpenCensus
                       { double_value: value }
                     end
 
-            Google::Monitoring::V3::Point.new(
+            Google::Cloud::Monitoring::V3::Point.new(
               interval: {
                 start_time: convert_time(start_time),
                 end_time: convert_time(end_time)

data/lib/opencensus/trace/exporters/stackdriver.rb

@@ -13,11 +13,11 @@
 # limitations under the License.
 
 
-gem "google-cloud-trace"
+gem "google-cloud-trace-v2"
 gem "concurrent-ruby"
 
 require "concurrent"
-require "google/cloud/trace"
+require "google/cloud/env"
 require "google/cloud/trace/v2"
 
 module OpenCensus
@@ -56,8 +56,7 @@ module OpenCensus
         #     Optional. Most applications can leave this set to the default.
         # @param [Integer] timeout The default timeout for API requests, in
         #     seconds. Optional.
-        # @param [Hash] client_config An optional set of additional
-        #     configuration values for the API connection.
+        # @param [Hash] client_config Unused.
         # @param [Integer] max_queue The maximum number of API requests that
         #     can be queued for background operation. If the queue exceeds this
         #     value, additional requests will be run in the calling thread
@@ -75,13 +74,14 @@ module OpenCensus
             credentials: nil,
             scope: nil,
             timeout: nil,
-            client_config: nil,
+            client_config: nil, # rubocop:disable Lint/UnusedMethodArgument
             max_queue: 1000,
             max_threads: 1,
             auto_terminate_time: 10,
             mock_client: nil
-          @project_id = final_project_id project_id
-
+          @project_id = project_id ||
+                        ENV["GOOGLE_CLOUD_PROJECT"] ||
+                        Google::Cloud.env.project_id
           @executor = create_executor max_threads, max_queue
           if auto_terminate_time
             terminate_at_exit! @executor, auto_terminate_time
@@ -91,12 +91,8 @@ module OpenCensus
             @client_promise =
               Concurrent::Promise.fulfill mock_client, executor: @executor
           else
-            credentials = final_credentials credentials, scope
-            scope ||= Google::Cloud.configure.trace.scope
-            timeout ||= Google::Cloud.configure.trace.timeout
-            client_config ||= Google::Cloud.configure.trace.client_config
             @client_promise = create_client_promise \
-              @executor, credentials, scope, client_config, timeout
+              @executor, credentials, scope, timeout
           end
         end
 
@@ -210,17 +206,15 @@ module OpenCensus
         # We create the client lazily so grpc doesn't get initialized until
         # we actually need it. This is important because if it is intialized
         # too early, before a fork, it can go into a bad state.
-        def create_client_promise executor, credentials, scopes, client_config,
-                                  timeout
+        def create_client_promise executor, credentials, scopes, timeout
           Concurrent::Promise.new executor: executor do
-            Google::Cloud::Trace::V2.new(
-              credentials: credentials,
-              scopes: scopes,
-              client_config: client_config,
-              timeout: timeout,
-              lib_name: "opencensus",
-              lib_version: OpenCensus::Stackdriver::VERSION
-            )
+            Google::Cloud::Trace::V2::TraceService::Client.new do |config|
+              config.credentials = credentials if credentials
+              config.scope = scopes if scopes
+              config.timeout = timeout if timeout
+              config.lib_name = "opencensus"
+              config.lib_version = OpenCensus::Stackdriver::VERSION
+            end
           end
         end
 
@@ -235,32 +229,12 @@ module OpenCensus
           end
         end
 
-        # Fall back to default project ID
-        def final_project_id project_id
-          project_id ||
-            Google::Cloud.configure.trace.project_id ||
-            Google::Cloud.configure.project_id ||
-            Google::Cloud.env.project_id
-        end
-
-        # Fall back to default credentials, and wrap in a creds object
-        def final_credentials credentials, scope
-          credentials ||=
-            Google::Cloud.configure.trace.credentials ||
-            Google::Cloud.configure.credentials ||
-            Google::Cloud::Trace::Credentials.default(scope: scope)
-          unless credentials.is_a? Google::Auth::Credentials
-            credentials =
-              Google::Cloud::Trace::Credentials.new credentials, scope: scope
-          end
-          credentials
-        end
-
         # Export a list of spans in a single batch write, in the current thread
         def export_as_batch client, spans
           converter = Converter.new project_id
           span_protos = Array(spans).map { |span| converter.convert_span span }
-          client.batch_write_spans "projects/#{project_id}", span_protos
+          client.batch_write_spans name: "projects/#{project_id}",
+                                   spans: span_protos
         end
       end
     end

data/lib/opencensus/trace/exporters/stackdriver/converter.rb

@@ -36,7 +36,7 @@ module OpenCensus
           # @private
           # Alias for the V2 Cloudtrace protos namespace
           #
-          TraceProtos = Google::Devtools::Cloudtrace::V2
+          TraceProtos = Google::Cloud::Trace::V2
 
           ##
           # @private
@@ -83,7 +83,7 @@ module OpenCensus
           # Convert a span object.
           #
           # @param [OpenCensus::Trace::Span] obj OpenCensus span object
-          # @return [Google::Devtools::Cloudtrace::V2::Span] The generated
+          # @return [Google::Cloud::Trace::V2::Span] The generated
           #     proto
           #
           def convert_span obj
@@ -132,7 +132,7 @@ module OpenCensus
           # @param [String] str The string
           # @param [Integer] truncated_byte_count The number of bytes omitted.
           #     Defaults to 0.
-          # @return [Google::Devtools::Cloudtrace::V2::TruncatableString] The
+          # @return [Google::Cloud::Trace::V2::TruncatableString] The
           #     generated proto
           #
           def make_truncatable_string str, truncated_byte_count = 0
@@ -146,7 +146,7 @@ module OpenCensus
           #
           # @param [OpenCensus::Trace::TruncatableString] obj OpenCensus
           #     truncatable string object
-          # @return [Google::Devtools::Cloudtrace::V2::TruncatableString] The
+          # @return [Google::Cloud::Trace::V2::TruncatableString] The
           #     generated proto
           #
           def convert_truncatable_string obj
@@ -170,7 +170,7 @@ module OpenCensus
           #
           # @param [OpenCensus::Trace::TruncatableString, Integer, boolean]
           #     obj Object to convert
-          # @return [Google::Devtools::Cloudtrace::V2::AttributeValue] The
+          # @return [Google::Cloud::Trace::V2::AttributeValue] The
           #     generated proto
           #
           def convert_attribute_value obj
@@ -202,7 +202,7 @@ module OpenCensus
           # @param [Integer] dropped_attributes_count Number of dropped
           # @param [Boolean] include_agent_attribute Include the `g.co/agent`
           #     attribute in the result. Default is false.
-          # @return [Google::Devtools::Cloudtrace::V2::Attributes] The
+          # @return [Google::Cloud::Trace::V2::Attributes] The
           #     generated proto
           #
           def convert_attributes attributes, dropped_attributes_count,
@@ -225,7 +225,7 @@ module OpenCensus
           #
           # @param [Thread::Backtrace::Location] frame The backtrace element to
           #     convert
-          # @return [Google::Devtools::Cloudtrace::V2::StackTrace::StackFrame]
+          # @return [Google::Cloud::Trace::V2::StackTrace::StackFrame]
           #     The generated proto
           #
           def convert_stack_frame frame
@@ -242,7 +242,7 @@ module OpenCensus
           #     element array to convert
           # @param [Integer] dropped_frames_count Frames that were dropped
           # @param [Integer] stack_trace_hash_id Hash of the data
-          # @return [Google::Devtools::Cloudtrace::V2::StackTrace] The
+          # @return [Google::Cloud::Trace::V2::StackTrace] The
           #     generated proto
           #
           def convert_stack_trace backtrace, dropped_frames_count,
@@ -267,7 +267,7 @@ module OpenCensus
           # @param [OpenCensus::Trace::Annotation] annotation The annotation
           #     object to convert
           # @return
-          #     [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::Annotation]
+          #     [Google::Cloud::Trace::V2::Span::TimeEvent::Annotation]
           #     The generated proto
           #
           def convert_annotation annotation
@@ -287,7 +287,7 @@ module OpenCensus
           # @param [OpenCensus::Trace::MessageEvent] message_event The message
           #     event object to convert
           # @return
-          #    [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::MessageEvent]
+          #    [Google::Cloud::Trace::V2::Span::TimeEvent::MessageEvent]
           #    The generated proto
           #
           def convert_message_event message_event
@@ -297,7 +297,7 @@ module OpenCensus
                 id: message_event.id,
                 uncompressed_size_bytes: message_event.uncompressed_size,
                 compressed_size_bytes: message_event.compressed_size
-            Google::Devtools::Cloudtrace::V2::Span::TimeEvent.new \
+            TraceProtos::Span::TimeEvent.new \
               time: convert_time(message_event.time),
               message_event: message_event_proto
           end
@@ -311,7 +311,7 @@ module OpenCensus
           #     annotations
           # @param [Integer] dropped_message_events_count Number of dropped
           #     message events
-          # @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvents] The
+          # @return [Google::Cloud::Trace::V2::Span::TimeEvents] The
           #     generated proto
           #
           def convert_time_events time_events, dropped_annotations_count,
@@ -336,7 +336,7 @@ module OpenCensus
           # Convert a link object
           #
           # @param [OpenCensus::Trace::Link] link The link object to convert
-          # @return [Google::Devtools::Cloudtrace::V2::Span::Link] The
+          # @return [Google::Cloud::Trace::V2::Span::Link] The
           #     generated proto
           #
           def convert_link link
@@ -355,7 +355,7 @@ module OpenCensus
           # @param [Array<OpenCensus::Trace::Link>] links The link objects to
           #     convert
           # @param [Integer] dropped_links_count Number of dropped links
-          # @return [Google::Devtools::Cloudtrace::V2::Span::Links] The
+          # @return [Google::Cloud::Trace::V2::Span::Links] The
           #     generated proto
           #
           def convert_links links, dropped_links_count

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opencensus-stackdriver
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -25,47 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: google-cloud-trace
+  name: google-cloud-env
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.35'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: opencensus
+  name: google-cloud-monitoring-v3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: google-cloud-monitoring
+  name: google-cloud-trace-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: opencensus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -225,14 +239,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Stackdriver exporter for OpenCensus