opentelemetry-exporter-google_cloud_trace 0.a → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbb7704b47e872f8746e81fac2410bada324a56fcfa4c8c0f95ceff38c7dc7ac
-  data.tar.gz: fce4c9855d89a1275a43df6dc92fd4cbb84d32d426827dfcbecc27f06d2c7292
+  metadata.gz: 896a1567355cdf1e2f6daa30f1ca4acfa2e9053862a61f14c1a94c07a02c7993
+  data.tar.gz: e4c54cb48a88a8a2a525dd2bbeef8c716bc20beb91d67b49c367c82b7ba58bd4
 SHA512:
-  metadata.gz: c1b1036636c362f089086d0f8b7859c187caf2879ed932a4592375ca416ba86d128b84ceb5e1b982f9b7ac68b8fb51e1cbf27504e690510af6d708b6040cd541
-  data.tar.gz: 52d390117ee58d9c3518ad47e434fe2fb74a6e3bce28d52e4d914e5e5fde35085876bf83bd05014dd2e39ffef82f2f948374adcbb5bfedebb301a947fd1afcaa
+  metadata.gz: 7336a9662a78da966767d1683019dbe1f804a1bcdf6f5da92e5189d4a4b034c3e30f34d76e52df2fd0e81137c2bbeeb52bf58a22d3b6cd34282ba8dcdb25c7cc
+  data.tar.gz: 586be672dd22def225b4dcf0137ec8e2530fd198fba56e9450471e6f219dcbd40f7c149d672ef0c9bb1f0841edb4a4e145deaf978510facdad7f72fb02f9d02d

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_gem:
+  google-style: google-style.yml
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude: 
+    - test/**/*
+    - opentelemetry-exporter-google_cloud_trace.gemspec
+
+Style/PreferredHashMethods:
+  Enabled: true
+  Exclude: 
+    - test/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - "**/translator.rb"   
+
+Naming/FileName:
+  Exclude:
+    - "lib/opentelemetry-exporter-google_cloud_trace.rb"     

data/.yardopts

@@ -0,0 +1,17 @@
+--no-private
+--title=OpenTelemetry Exporter Google Cloud Trace
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+--main OVERVIEW.md
+
+./lib/**/*.rb
+-
+OVERVIEW.md
+AUTHENTICATION.md
+LOGGING.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.0 (2023-07-04)
+
+#### Features
+
+* first release of exporter with minimal support 

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in opentelemetry-exporter-google_cloud_trace.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/README.md

@@ -1,8 +1,38 @@
-# Placeholder for Ruby gem opentelemetry-exporter-google_cloud_trace
-
-This is a placeholder for the future Google-authored gem opentelemetry-exporter-google_cloud_trace.
-This placeholder is being released on 2023-06-13 in order to reserve the name.
-The final gem should be available shortly after that date. If it has not been
-released in a timely manner, or if this placeholder interferes with your work,
-you can contact the Google Ruby team by opening an issue in the GitHub
-repository https://github.com/googleapis/google-cloud-ruby.
+# Opentelemetry Google Cloud Trace exporter
+
+This library is an exporter for OpenTelemetry instrumentation which will help translate the spans into Google Cloud Trace understandable format and publish it to Trace service.
+
+## Installation
+
+```sh
+$ gem install opentelemetry-exporter-google_cloud_trace
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Contributions to this library are always welcome and highly encouraged.
+
+See the {file:../docs/CONTRIBUTING.md Contributing Guide}
+for more information on how to get started.
+
+Please note that this project is released with a Contributor Code of Conduct. By
+participating in this project you agree to abide by its terms. 
+See {file:../docs/CODE_OF_CONDUCT.md Code of Conduct}
+for more information.
+
+## License
+
+This library is licensed under Apache 2.0. Full license text is available in
+[LICENSE](../LICENSE).
+
+## Support
+
+Please [report bugs at the project on
+Github](https://github.com/GoogleCloudPlatform/opentelemetry-operations-ruby/issues). Don't
+hesitate to [ask
+questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
+about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/Rakefile

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new :test do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "yard"
+require "yard/rake/yardoc_task"
+YARD::Rake::YardocTask.new do |y|
+  # y.options << "--fail-on-warning"
+end
+
+task :acceptance, :project, :keyfile do |_t, args|
+  project = args[:project]
+  project ||= ENV["TRACE_EXPORTER_TEST_PROJECT"] || ENV["GCLOUD_TEST_PROJECT"]
+  keyfile = args[:keyfile]
+  keyfile ||= ENV["TRACE_EXPORTER_TEST_KEYFILE"] || ENV["GCLOUD_TEST_KEYFILE"]
+  if keyfile
+    keyfile = File.read keyfile
+  end
+  if project.nil? || keyfile.nil?
+    raise "You must provide a project and keyfile. e.g. rake acceptance[test123, /path/to/keyfile.json] or " \
+          "TRACE_EXPORTER_TEST_PROJECT=test123 TRACE_EXPORTER_TEST_KEYFILE=/path/to/keyfile.json rake acceptance"
+  end
+
+  Rake::Task["acceptance:run"].invoke
+end
+
+namespace :acceptance do
+  Rake::TestTask.new :run do |t|
+    t.libs << "acceptance"
+    t.libs << "lib"
+    t.test_files = FileList["acceptance/**/*_test.rb"]
+  end
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/acceptance/sinatra/gcp_trace_exporter_test.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "test_helper"
+require "webrick"
+require "fileutils"
+require "google/protobuf/well_known_types"
+
+# Test the Sinatra server for the Cloud Scheduler sample.
+describe "Opentelemety exporter for Google Cloud Trace" do
+  before :all do
+    @project_id = ENV["TRACE_EXPORTER_TEST_PROJECT"] || ENV["GCLOUD_TEST_PROJECT"]
+    Google::Cloud.configure do |config|
+      config.project_id = @project_id
+      config.credentials = ENV["TRACE_EXPORTER_TEST_KEYFILE"] || ENV["GCLOUD_TEST_KEYFILE"]
+    end
+
+    @pid = Process.spawn "bundle exec ruby acceptance/sinatra/sinatra_app.rb"
+
+    # wait for server to start
+    sleep 10
+    @trace_client = Google::Cloud::Trace::V1::TraceService::Client.new
+  end
+
+  after :all do
+    Process.kill "KILL", @pid
+    Process.wait2 @pid
+  end
+
+  it "test_returns_hello_world" do
+    uri = URI("http://127.0.0.1:4567")
+    start_time = Google::Protobuf::Timestamp.from_time Time.now
+    res = Net::HTTP.get uri
+    assert_match "Hello !", res
+    sleep 10 # wait for trace to be sent
+    end_time = Google::Protobuf::Timestamp.from_time Time.now
+
+    assert_trace start_time, end_time
+  end
+end
+
+def assert_trace start_time, end_time
+  result = @trace_client.list_traces project_id: @project_id, start_time: start_time, end_time: end_time
+  traces = result.response.traces
+  test_span = nil
+  parent_span = nil
+
+  traces.each do |trace|
+    full_trace = @trace_client.get_trace project_id: @project_id, trace_id: trace.trace_id
+    full_trace.spans.each do |span|
+      if span.name === "test_span"
+        test_span = span
+        break
+      end
+    end
+
+    if test_span
+      parent_span = full_trace.spans.find { |span| span.span_id === test_span.parent_span_id }
+      break
+    end
+  end
+
+  assert_child_span test_span
+  assert_parent_span parent_span
+end
+
+def assert_child_span span
+  refute_nil span
+  assert_equal span.labels["span_attr"], "span_value"
+end
+
+def assert_parent_span span
+  refute_nil span
+  assert_equal span.kind, :RPC_SERVER
+  assert_equal span.name, "GET /"
+  assert_equal span.labels["g.co/agent"], "opentelemetry-ruby #{OpenTelemetry::SDK::VERSION};" \
+                                          "google-cloud-trace-exporter " \
+                                          "#{OpenTelemetry::Exporter::GoogleCloudTrace::VERSION}"
+  assert_equal span.labels["/http/client_protocol"], "http"
+  assert_equal span.labels["/http/status_code"], "200"
+  assert_equal span.labels["http.target"], "/"
+  assert_equal span.labels["/http/method"], "GET"
+  assert_equal span.labels["/http/host"], "127.0.0.1:4567"
+  assert_equal span.labels["/http/route"], "/"
+  assert_equal span.labels["/http/user_agent"], "Ruby"
+end

data/acceptance/sinatra/sinatra_app.rb

@@ -0,0 +1,25 @@
+require "sinatra"
+require "opentelemetry-sdk"
+require "opentelemetry/instrumentation/sinatra"
+require "opentelemetry/instrumentation/rack"
+require "opentelemetry/exporter/google_cloud_trace"
+
+OpenTelemetry::SDK.configure do |c|
+  c.service_name = "test_app"
+  c.add_span_processor(
+    OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+      OpenTelemetry::Exporter::GoogleCloudTrace::SpanExporter.new
+    )
+  )
+  c.use "OpenTelemetry::Instrumentation::Sinatra"
+end
+
+get "/" do
+  test_tracer = OpenTelemetry.tracer_provider.tracer "test_tracer"
+  span_to_link_from = OpenTelemetry::Trace.current_span
+  link = OpenTelemetry::Trace::Link.new(span_to_link_from.context, { "some.attribute" => 12 })
+  test_tracer.in_span "test_span", attributes: { "span_attr" => "span_value" }, links: [link] do |span|
+    span.add_event "Creating test span event!!", attributes: { "event_attr" => "event_value" }
+  end
+  "Hello !"
+end

data/acceptance/test_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/hooks/default"
+require "minitest/rg"
+require "ostruct"
+require "google/cloud"
+require "google/cloud/trace/v1"
+require "opentelemetry/exporter/google_cloud_trace"

data/lib/opentelemetry/exporter/google_cloud_trace/span_exporter.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/trace/v2/trace_service"
+require "opentelemetry/exporter/google_cloud_trace/translator"
+require "google/cloud/env"
+
+module OpenTelemetry
+  module Exporter
+    module GoogleCloudTrace
+      ##
+      # This provides an implementation of span exporter for Google Cloud Trace
+      # It will convert the Opentelemetry span data into Clould Trace spans
+      # and publish them to the Cloud trace service.
+      class SpanExporter
+        SUCCESS = OpenTelemetry::SDK::Trace::Export::SUCCESS
+        FAILURE = OpenTelemetry::SDK::Trace::Export::FAILURE
+        private_constant :SUCCESS, :FAILURE
+
+
+        ##
+        # Creates a new object for google cloud trace
+        # opentelemetry span exporter. It creates client for
+        # Google cloud trace service to be used for publihing span.
+        #
+        #
+        # @param [String] project_id Project identifier for the Trace service
+        #   you are connecting to. If not present, the default project for the
+        #   credentials is used.
+        # @param [String, Hash, Google::Auth::Credentials] credentials The path to
+        #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+        #   Google::Auth::Credentials object.
+        # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
+        #   the set of resources and operations that the connection can access.
+        #   See [Using OAuth 2.0 to Access Google
+        #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+        #
+        #   The default scope is:
+        #
+        #   * `https://www.googleapis.com/auth/trace.append`
+        # @param [Numeric] timeout Default timeout to use in requests. Optional.
+        # @param [String] endpoint Override of the endpoint host name. Optional.
+        #   If the param is nil, uses the default endpoint.
+        #
+        # @return [OpenTelemetry::Exporter::GoogleCloudTrace::SpanExporter]
+        #
+        # @example
+        #   require 'opentelemetry/sdk'
+        #   require 'opentelemetry/instrumentation/all'
+        #   require 'opentelemetry/exporter/google_cloud_trace'
+        #   OpenTelemetry::SDK.configure do |c|
+        #     c.service_name = 'test_app'
+        #     c.add_span_processor(
+        #          OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+        #            OpenTelemetry::Exporter::GoogleCloudTrace::SpanExporter.new
+        #          )
+        #        )
+        #     c.use_all() # enables all instrumentation!
+        #   end
+        #
+        def initialize project_id: nil,
+                       credentials: nil,
+                       scope: nil,
+                       timeout: nil,
+                       endpoint: nil
+
+          @client = ::Google::Cloud::Trace::V2::TraceService::Client.new do |config|
+            config.project_id = project_id if project_id
+            config.credentials = credentials if credentials
+            config.scope = scope if scope
+            config.timeout = timeout if timeout
+            config.endpoint = endpoint if endpoint
+          end
+          @project_id = (project_id || default_project_id || credentials&.project_id)
+          @project_id = @project_id.to_s
+          raise ArgumentError, "project_id is missing" if @project_id.empty?
+          @shutdown = false
+          @translator = Translator.new @project_id
+        end
+
+        # rubocop:disable Lint/UnusedMethodArgument
+        # timeout is needed to match Opentelemetry exporter interface
+
+        # Called to export sampled {OpenTelemetry::SDK::Trace::SpanData} structs.
+        #
+        # @param [Enumerable<OpenTelemetry::SDK::Trace::SpanData>] span_data the
+        #   list of recorded {OpenTelemetry::SDK::Trace::SpanData} structs to be
+        #   exported.
+        # @return [Integer] the result of the export.
+        def export span_data, timeout: nil
+          return FAILURE if @shutdown
+
+          begin
+            batch_request = @translator.create_batch span_data
+            @client.batch_write_spans batch_request
+            SUCCESS
+          rescue StandardError
+            FAILURE
+          end
+        end
+
+        # Called when {OpenTelemetry::SDK::Trace::TracerProvider#force_flush} is called, if
+        # this exporter is registered to a {OpenTelemetry::SDK::Trace::TracerProvider}
+        # object.
+        def force_flush timeout: nil
+          SUCCESS
+        end
+
+        # Called when {OpenTelemetry::SDK::Trace::TracerProvider#shutdown} is called, if
+        # this exporter is registered to a {OpenTelemetry::SDK::Trace::TracerProvider}
+        # object.
+        def shutdown timeout: nil
+          @shutdown = true
+          SUCCESS
+        end
+
+        # rubocop:enable Lint/UnusedMethodArgument
+
+        private
+
+        def default_project_id
+          Google::Cloud.env.project_id
+        end
+
+        def shutdown?
+          @shutdown
+        end
+      end
+    end
+  end
+end