opencensus-stackdriver 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6648ab08a2f19dcc8378487f54025f43d3f0fbbf5144582a095eb1df50d899a8
-  data.tar.gz: b35b154b195811a9fc6a69cbdf553825f59818390a8e80dbbd9d7138767c8934
+  metadata.gz: 0c38340ddaa943b074e93623040737f17eacbd06d93f2adf0568fa2f4653776e
+  data.tar.gz: fd1589264c08774869166ff8a249e7e35e0a42e30f17048f09a60c859bc71539
 SHA512:
-  metadata.gz: 59d6285c74a85ed961450af1a9d847c436aecd190ad7afae0c76206e0eb33fb7d30eecaa382ab8039a668d8f232a574c5bad65a6b24641d399a57b5fd973db16
-  data.tar.gz: 4559660ff5249c3535b42f4e813c1b93adf026d07c152d855d3c86cd18768fb5d6bd6a6d3430807cc89dbd63c3eb129b4ac949524ee43ca86e3f760bf5b2b0f0
+  metadata.gz: f7404e1915c08587c91fcc6c25664b4419e600dbc5456639c5eff53a07811660b64e610ad45aa0e993b792ca1b5bd24b11915b385661cad9f25aefa0618a1a94
+  data.tar.gz: 584e5a22a969028271fcec0021baa1b24349e461029d2b41bef42cc1bbd5fb3ef3d6abbfbfd93362368b0d60dada4c6648b35484c71a3fd3306fa0015169303c

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # 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.
+
+### 0.3.1 / 2020-02-06
+
+* Support customizing the stackdriver service address
+
+### 0.3.0 / 2019-10-14
+
+This release requires version 0.5 or later of the opencensus gem. It includes
+experimental support for exporting OpenCensus Stats to the Stackdriver
+Monitoring service. Note that Stats support is incomplete and there are known
+issues.
+
+### 0.2.0 / 2018-10-22
+
+This release requires version 0.4 or later of the opencensus gem.
+
+* Map standard HTTP attributes from OpenCensus names to Stackdriver names.
+* Fixed thread pool size configuration.
+
 ### 0.1.2 / 2018-05-22
 
 * Add agent identifier and version attribute to reported spans.

data/README.md

@@ -8,7 +8,8 @@ that exports data to [Stackdriver](https://cloud.google.com/stackdriver/).
 OpenCensus is a platform- and provider-agnostic framework for distributed
 tracing and stats collection. For more information, see https://opencensus.io.
 
-This library is in an alpha stage, and the API is subject to change.
+This library is in an alpha stage, and the API is subject to change. In
+particular, support for the Stats API is currently incomplete and experimental.
 
 ## Quick Start
 

data/lib/opencensus-stackdriver.rb

@@ -12,4 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
+##
+# OpenCensus is a vendor-agnostic single distribution of libraries to provide
+# metrics collection and tracing for your services. See https://opencensus.io/
+# for general information on OpenCensus.
+#
+# The Stackdriver Trace plugin for OpenCensus is implemented in the
+# {OpenCensus::Trace::Exporters::Stackdriver} class.
+#
+module OpenCensus
+end
+
 require "opencensus/stackdriver"

data/lib/opencensus/stackdriver.rb

@@ -12,10 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "opencensus"
 
 module OpenCensus
-  ## Information about the Stackdriver exporter plugin
+  ##
+  # The Stackdriver exporter plugin for OpenCensus exports OpenCensus trace and
+  # stats information to Stackdriver Trace and Monitoring services.
+  #
+  # The Stackdriver Trace plugin for OpenCensus is implemented in the
+  # {OpenCensus::Trace::Exporters::Stackdriver} class and
+  # {OpenCensus::Stats::Exporters::Stackdriver}
+  #
   module Stackdriver
   end
 end
@@ -23,3 +31,5 @@ end
 require "opencensus/stackdriver/version"
 require "opencensus/trace/exporters/stackdriver"
 require "opencensus/trace/exporters/stackdriver/converter"
+require "opencensus/stats/exporters/stackdriver"
+require "opencensus/stats/exporters/stackdriver/converter"

data/lib/opencensus/stackdriver/version.rb

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module OpenCensus
   module Stackdriver
     ## Current OpenCensus Stackdriver plugin version
-    VERSION = "0.1.2".freeze
+    VERSION = "0.4.0".freeze
   end
 end

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

@@ -0,0 +1,324 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenCensus Authors
+#
+# 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.
+
+
+gem "google-cloud-monitoring-v3"
+gem "concurrent-ruby"
+
+require "concurrent"
+require "google/cloud/env"
+require "google/cloud/monitoring/v3"
+
+module OpenCensus
+  ##
+  # OpenCensus Stats provides a standard interface for distributed stats
+  # recording.
+  #
+  module Stats
+    ##
+    # The exporters module is a namespace for stats exporters.
+    #
+    module Exporters
+      ##
+      # The Stackdriver exporter for OpenCensus Stats exports captured stats
+      # to a Google Monitoring project. It calls the Monitoring API in
+      # a background thread pool.
+      #
+      class Stackdriver
+        # Default custom opencensus domain name
+        # @return [String]
+        CUSTOM_OPENCENSUS_DOMAIN = "custom.googleapis.com/opencensus".freeze
+
+        # Default metric resouce type.
+        # @return [String]
+        GLOBAL_RESOURCE_TYPE = "global".freeze
+
+        # The project ID
+        # @return [String]
+        #
+        attr_reader :project_id
+
+        # Metric prefix
+        # @return [String]
+        attr_reader :metric_prefix
+
+        # Metric resource type
+        # @return [String]
+        attr_reader :resource_type
+
+        # Metric resource labels
+        # @return [Hash<String,String>]
+        attr_reader :resource_labels
+
+        # Create a Stackdriver exporter.
+        #
+        # @param [String] project_id The project identifier for the Stackdriver
+        #     Monitoring service you are connecting to. If you are running on
+        #     Google
+        #     Cloud hosting (e.g. Compute Engine, Kubernetes Engine, or App
+        #     Engine), this parameter is optional and will default to the
+        #     hosting project. Otherwise, it is required.
+        # @param [String, Hash, Google::Auth::Credentials] credentials The
+        #     Stackdriver API credentials, which can be a path to a keyfile as
+        #     a String, the contents of a keyfile as a Hash, or a
+        #     Google::Auth::Credentials object. If you are running on Google
+        #     Cloud hosting (e.g. Compute Engine, Kubernetes Engine, or App
+        #     Engine), this parameter is optional and will default to the
+        #     credentials provided by the hosting project. Otherwise, it is
+        #     required.
+        # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
+        #     the set of resources and operations the API client can access.
+        #     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 [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
+        #     rather than in the background. Set to 0 to allow the queue to
+        #     grow indefinitely. Default is 1000.
+        # @param [Integer] max_threads The maximum number of threads that can
+        #     be spun up to handle API requests. Default is 1. If set to 0,
+        #     backgrounding will be disabled and all requests will run in the
+        #     calling thread.
+        # @param [Integer] auto_terminate_time The time in seconds allotted to
+        #     complete any pending background requests when Ruby is exiting.
+        # @param [String] metric_prefix Prefix for stackdriver metric.
+        #   Default value set to {CUSTOM_OPENCENSUS_DOMAIN}
+        # @param [String] resource_type Metric resource type.
+        #   Default value set to {GLOBAL_RESOURCE_TYPE}
+        # @param [Hash<String,String>] resource_labels Metric resource labels.
+        #   Default value set to { "project_id" => project_id }
+        # @param [String] gcm_service_address Override for the Google
+        #   Cloud Monitoring service hostname, or `nil` to leave as
+        #   the default.
+        #
+        def initialize \
+            project_id: nil,
+            credentials: nil,
+            scope: nil,
+            timeout: nil,
+            client_config: nil, # rubocop:disable Lint/UnusedMethodArgument
+            max_queue: 1000,
+            max_threads: 1,
+            auto_terminate_time: 10,
+            mock_client: nil,
+            metric_prefix: nil,
+            resource_type: nil,
+            resource_labels: nil,
+            gcm_service_address: nil
+          @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 || {
+            "project_id" => @project_id
+          }
+          @executor = create_executor max_threads, max_queue
+
+          if auto_terminate_time
+            terminate_at_exit! @executor, auto_terminate_time
+          end
+
+          if mock_client
+            @client_promise =
+              Concurrent::Promise.fulfill mock_client, executor: @executor
+          else
+            @client_promise = create_client_promise \
+              @executor, credentials, scope, timeout, gcm_service_address
+          end
+
+          @converter = Converter.new @project_id
+          paths = Google::Cloud::Monitoring::V3::MetricService::Paths
+          @project_path = paths.project_path project: @project_id
+        end
+
+        # Export stats to Monitoring service asynchronously.
+        #
+        # @param [Array<OpenCensus::Stats::ViewData>] views_data The captured
+        #   stats data
+        #
+        def export views_data
+          raise "Exporter is no longer running" unless @executor.running?
+
+          return if views_data.nil? || views_data.empty?
+
+          @client_promise.execute
+          export_promise = @client_promise.then do |client|
+            export_as_batch(client, views_data)
+          end
+          export_promise.on_error do |reason|
+            warn "Unable to export to Monitoring service because: #{reason}"
+          end
+
+          nil
+        end
+
+        ##
+        # Returns true if this exporter is running and will accept further
+        # export requests. Returns false once the exporter begins shutting down.
+        #
+        # @return [boolean]
+        #
+        def running?
+          @executor.running?
+        end
+
+        ##
+        # Returns true if this exporter has finished shutting down and all
+        # pending stats have been sent.
+        #
+        # @return [boolean]
+        #
+        def shutdown?
+          @executor.shutdown?
+        end
+
+        ##
+        # Returns true if this exporter has begun shutting down and is no
+        # longer accepting export requests, but is still running queued
+        # requests in the background.
+        #
+        # @return [boolean]
+        #
+        def shuttingdown?
+          @executor.shuttingdown?
+        end
+
+        ##
+        # Begin shutting down the exporter gracefully. After this operation is
+        # performed, the exporter will no longer accept export requests, but
+        # will finish any pending requests in the background.
+        #
+        def shutdown
+          @executor.shutdown
+          self
+        end
+
+        ##
+        # Begin shutting down the exporter forcefully. After this operation is
+        # performed, the exporter will no longer accept export requests, and
+        # will finish any currently running export requests, but will cancel
+        # all requests that are still pending in the queue.
+        #
+        def kill
+          @executor.kill
+          self
+        end
+
+        ##
+        # Wait for the exporter to finish shutting down.
+        #
+        # @param [Integer, nil] timeout A timeout in seconds, or nil for no
+        #     timeout.
+        # @return [boolean] true if the exporter is shut down, or false if the
+        #     wait timed out.
+        #
+        def wait_for_termination timeout = nil
+          @executor.wait_for_termination timeout
+        end
+
+        # Create a metric descriptor
+        #
+        # An error will be raised if there is
+        # already a metric descriptor created with the same name
+        # but it has a different aggregation or keys.
+        #
+        # @param [OpenCensus::Stats::View] view
+        # @return [Google::Api::MetricDescriptor]
+        #
+        def create_metric_descriptor view
+          metric_descriptor = @converter.convert_metric_descriptor(
+            view,
+            metric_prefix
+          )
+          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 name: metric_name,
+                                            metric_descriptor: metric_descriptor
+          end
+          descriptor_create_promise.value!
+        end
+
+        private
+
+        # Create the executor
+        def create_executor max_threads, max_queue
+          if max_threads >= 1
+            Concurrent::ThreadPoolExecutor.new \
+              min_threads: 1, max_threads: max_threads,
+              max_queue: max_queue, fallback_policy: :caller_runs,
+              auto_terminate: false
+          else
+            Concurrent::ImmediateExecutor.new
+          end
+        end
+
+        # Create the client promise.
+        # 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,
+                                  timeout, service_address
+          Concurrent::Promise.new executor: executor do
+            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
+
+        # Set up an at_exit hook that shuts the exporter down.
+        def terminate_at_exit! executor, timeout
+          at_exit do
+            executor.shutdown
+            unless executor.wait_for_termination timeout
+              executor.kill
+              executor.wait_for_termination timeout
+            end
+          end
+        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|
+            @converter.convert_time_series(
+              metric_prefix,
+              resource_type,
+              resource_labels,
+              view_data
+            )
+          end
+
+          client.create_time_series name: @project_path,
+                                    time_series: time_series.flatten
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+# Copyright 2019 OpenCensus Authors
+#
+# 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.
+
+
+module OpenCensus
+  module Stats
+    module Exporters
+      class Stackdriver
+        ##
+        # An object that converts OpenCensus stats data objects to Monitoring
+        # service protos
+        #
+        # @private
+        #
+        class Converter
+          ##
+          # Create a converter
+          #
+          # @param [String] project_id Google project ID
+          #
+          def initialize project_id
+            @project_id = project_id
+          end
+
+          # Convert view to metric descriptor
+          #
+          # @param [OpenCensus::Stats:View] view Stats view
+          # @param [String] metric_prefix Metric prefix name
+          # @return [Google::Api::MetricDescriptor]
+          #
+          def convert_metric_descriptor view, metric_prefix
+            descriptor = Google::Api::MetricDescriptor.new(
+              type: make_metric_type(metric_prefix, view.name),
+              display_name: view.measure.name,
+              metric_kind: convert_metric_kind(view.aggregation),
+              value_type: convert_metric_value_type(view),
+              unit: view.measure.unit,
+              labels: convert_labels(view.columns)
+            )
+
+            descriptor.description = view.description if view.description
+            descriptor
+          end
+
+          # Conver to lables
+          #
+          # @param [Array<String>] names
+          # @return [Array<Google::Api::LabelDescriptor>]
+          def convert_labels names
+            names.map do |name|
+              Google::Api::LabelDescriptor.new(
+                key: name,
+                value_type: Google::Api::LabelDescriptor::ValueType::STRING
+              )
+            end
+          end
+
+          # Convert to metric view type.
+          #
+          # @param [OpenCensus::Stats:View] view Stats view
+          # @return [Symbol] Metric value type
+          #
+          def convert_metric_value_type view
+            case view.aggregation
+            when OpenCensus::Stats::Aggregation::Distribution
+              Google::Api::MetricDescriptor::ValueType::DISTRIBUTION
+            when OpenCensus::Stats::Aggregation::Count
+              Google::Api::MetricDescriptor::ValueType::INT64
+            when OpenCensus::Stats::Aggregation::Sum,
+                OpenCensus::Stats::Aggregation::LastValue
+              if view.measure.int64?
+                Google::Api::MetricDescriptor::ValueType::INT64
+              else
+                Google::Api::MetricDescriptor::ValueType::DOUBLE
+              end
+            end
+          end
+
+          # Convert to metric kind
+          #
+          # @param [OpenCensus::Stats:Aggregation::LastValue,
+          #   OpenCensus::Stats:Aggregation::Sum,
+          #   OpenCensus::Stats:Aggregation::Count,
+          #   OpenCensus::Stats:Aggregation::Distribution] aggregation
+          #   Aggregation type
+          # @return [Symbol] Metric kind type
+          #
+          def convert_metric_kind aggregation
+            last_value_class = OpenCensus::Stats::Aggregation::LastValue
+
+            if aggregation.instance_of? last_value_class
+              return Google::Api::MetricDescriptor::MetricKind::GAUGE
+            end
+
+            Google::Api::MetricDescriptor::MetricKind::CUMULATIVE
+          end
+
+          # Convert view data to time series list
+          #
+          # @param [String] metric_prefix Metric prefix name
+          # @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::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::Cloud::Monitoring::V3::TimeSeries.new(
+                metric: {
+                  type: make_metric_type(metric_prefix, view.name),
+                  labels: Hash[view.columns.zip tag_values]
+                },
+                resource: {
+                  type: resource_type,
+                  labels: resource_labels
+                },
+                metric_kind: convert_metric_kind(view.aggregation),
+                value_type: convert_metric_value_type(view)
+              )
+
+              series.points << convert_point(
+                view_data.start_time,
+                aggr_data.time,
+                view.measure,
+                aggr_data
+              )
+
+              series
+            end
+          end
+
+          # Convert aggr data to time series point proto
+          #
+          # @param [Time] start_time Start time
+          # @param [Time] end_time Start time
+          # @param [OpenCensus::Stats:Measure] measure Measure details
+          # @param [OpenCensus::Stats:AggregationData] aggr_data Aggregated data
+          # @raise [TypeError] If invalid aggr data type.
+          # @return [Google::Cloud::Monitoring::V3::Point]
+          def convert_point start_time, end_time, measure, aggr_data
+            case aggr_data
+            when OpenCensus::Stats::AggregationData::Distribution
+              create_distribution_point start_time, end_time, aggr_data
+            when OpenCensus::Stats::AggregationData::LastValue
+              create_number_point(
+                start_time,
+                start_time,
+                aggr_data.value,
+                measure
+              )
+            when OpenCensus::Stats::AggregationData::Sum,
+                OpenCensus::Stats::AggregationData::Count
+              create_number_point(
+                start_time,
+                end_time,
+                aggr_data.value,
+                measure
+              )
+            else
+              raise TypeError, "invalid aggregation type : #{aggr_data.class}"
+            end
+          end
+
+          # Create a distribution point
+          # @param [Time] start_time Start time
+          # @param [Time] end_time Start time
+          # @param [OpenCensus::Stats::AggregationData::Distribution] aggr_data
+          # @return [Google::Cloud::Monitoring::V3::Point]
+          #
+          def create_distribution_point start_time, end_time, aggr_data
+            value = {
+              count: aggr_data.count,
+              mean: aggr_data.mean,
+              sum_of_squared_deviation: aggr_data.sum_of_squared_deviation,
+              bucket_options: {
+                explicit_buckets: {
+                  bounds: [0].concat(aggr_data.buckets)
+                }
+              },
+              bucket_counts: [0].concat(aggr_data.bucket_counts)
+            }
+
+            Google::Cloud::Monitoring::V3::Point.new(
+              interval: {
+                start_time: convert_time(start_time),
+                end_time: convert_time(end_time)
+              },
+              value: {
+                distribution_value: value
+              }
+            )
+          end
+
+          # Create a number point
+          # @param [Time] start_time Start time
+          # @param [Time] end_time Start time
+          # @param [Integer, Float] value
+          # @param [OpenCensus::Stats::Measure] measure Measure defination
+          # @return [Google::Cloud::Monitoring::V3::Point]
+          #
+          def create_number_point start_time, end_time, value, measure
+            value = if measure.int64?
+                      { int64_value: value }
+                    else
+                      { double_value: value }
+                    end
+
+            Google::Cloud::Monitoring::V3::Point.new(
+              interval: {
+                start_time: convert_time(start_time),
+                end_time: convert_time(end_time)
+              },
+              value: value
+            )
+          end
+
+          # Convert time object to protobuf timestamp
+          #
+          # @param [Time] time Ruby Time object
+          # @return [Google::Protobuf::Timestamp] The generated proto
+          #
+          def convert_time time
+            proto = Google::Protobuf::Timestamp.new
+            proto.from_time(time)
+            proto
+          end
+
+          ##
+          # Make make metric type
+          #
+          # @param [String] metric_prefix The metric prefix
+          # @param [String] name The name of the mertic view
+          # @return [String] The metric type path
+          #
+          def make_metric_type metric_prefix, name
+            "#{metric_prefix}/#{name}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,15 +12,22 @@
 # See the License for the specific language governing permissions and
 # 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
+  ##
+  # OpenCensus Trace provides a standard interface for distributed tracing.
+  #
   module Trace
+    ##
+    # The exporters module is a namespace for trace exporters.
+    #
     module Exporters
       ##
       # The Stackdriver exporter for OpenCensus Trace exports captured spans
@@ -49,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
@@ -68,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
@@ -84,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
 
@@ -191,7 +194,7 @@ module OpenCensus
         def create_executor max_threads, max_queue
           if max_threads >= 1
             Concurrent::ThreadPoolExecutor.new \
-              min_length: 1, max_length: max_threads,
+              min_threads: 1, max_threads: max_threads,
               max_queue: max_queue, fallback_policy: :caller_runs,
               auto_terminate: false
           else
@@ -203,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
 
@@ -228,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

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "google/devtools/cloudtrace/v2/trace_pb"
 require "google/protobuf/well_known_types"
 
@@ -35,7 +36,7 @@ module OpenCensus
           # @private
           # Alias for the V2 Cloudtrace protos namespace
           #
-          TraceProtos = Google::Devtools::Cloudtrace::V2
+          TraceProtos = Google::Cloud::Trace::V2
 
           ##
           # @private
@@ -52,6 +53,20 @@ module OpenCensus
               "opencensus-ruby [#{::OpenCensus::VERSION}] ruby-stackdriver-" \
               "exporter [#{::OpenCensus::Stackdriver::VERSION}]"
 
+          ##
+          # @private
+          # Mapping for certain well-known attributes defined in
+          # https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/HTTP.md
+          #
+          ATTRIBUTE_NAME_MAPPING = {
+            "http.host" => "/http/host",
+            "http.method" => "/http/method",
+            "http.path" => "/http/path",
+            "http.route" => "/http/route",
+            "http.user_agent" => "/http/user_agent",
+            "http.status_code" => "/http/status_code"
+          }.freeze
+
           ##
           # Create a converter
           #
@@ -68,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
@@ -117,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
@@ -131,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
@@ -155,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
@@ -170,6 +185,16 @@ module OpenCensus
             end
           end
 
+          ##
+          # Map OpenCensus attribute name to Stackdriver Trace name.
+          #
+          # @param [String] name OpenCensus attribute name
+          # @return [String] Corresponding Stackdriver Trace attribute.
+          #
+          def convert_attribute_name name
+            ATTRIBUTE_NAME_MAPPING[name] || name
+          end
+
           ##
           # Convert an attributes hash
           #
@@ -177,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,
@@ -187,7 +212,8 @@ module OpenCensus
               attribute_map[AGENT_KEY] = convert_attribute_value AGENT_VALUE
             end
             attributes.each do |k, v|
-              attribute_map[k] = convert_attribute_value v
+              attribute_map[convert_attribute_name k] =
+                convert_attribute_value v
             end
             TraceProtos::Span::Attributes.new \
               attribute_map: attribute_map,
@@ -199,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
@@ -216,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,
@@ -241,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
@@ -261,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
@@ -271,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
@@ -285,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,
@@ -310,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
@@ -329,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
@@ -347,6 +373,7 @@ module OpenCensus
           #
           def convert_optional_status status
             return nil if status.nil?
+
             Google::Rpc::Status.new code: status.code, message: status.message
           end
 
@@ -358,6 +385,7 @@ module OpenCensus
           #
           def convert_optional_bool value
             return nil if value.nil?
+
             Google::Protobuf::BoolValue.new value: value
           end
 
@@ -369,6 +397,7 @@ module OpenCensus
           #
           def convert_optional_int32 value
             return nil if value.nil?
+
             Google::Protobuf::Int32Value.new value: value
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opencensus-stackdriver
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 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,75 @@ 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.31'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-monitoring-v3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-trace-v2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: opencensus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -86,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
@@ -142,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.59.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 0.59.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +223,8 @@ files:
 - lib/opencensus-stackdriver.rb
 - lib/opencensus/stackdriver.rb
 - lib/opencensus/stackdriver/version.rb
+- lib/opencensus/stats/exporters/stackdriver.rb
+- lib/opencensus/stats/exporters/stackdriver/converter.rb
 - lib/opencensus/trace/exporters/stackdriver.rb
 - lib/opencensus/trace/exporters/stackdriver/converter.rb
 homepage: https://github.com/census-instrumentation/ruby-stackdriver-exporter
@@ -209,15 +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: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Stackdriver exporter for OpenCensus