opentelemetry-exporter-otlp 0.26.0 → 0.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea9c42597a6b63fe341e3003bee8ffbba2a6e3c5a74e3ddc4ff30ae41345b2e
-  data.tar.gz: b1714933dff93b3e4403732872ac211a5c3562ff6dbed90c739e132e408a2c01
+  metadata.gz: f511b15fd3e7e4d1452f58f852d9e29c97bff2743b520c080b187c657801b1bc
+  data.tar.gz: 52b9151d21904c685e026a813323415ef6b2be589e208b3a2307ad22fe5bead0
 SHA512:
-  metadata.gz: 63b1cdc9d52ca362f06546936a475cbdce954452833057dbf6797443d8a2d728fddc417cc5d8c3fb1a1c6c0dcc44315ca2484e921d1d80a9ed00b4541d87f53b
-  data.tar.gz: d18de69cd1466058ff2af29e38a6015342acbb1baabd7eb7e8022f7ee715202fd8e271edcfd7fde510e0ea67c3fbf378e5428b1600e07d16c800f03f5d59ff39
+  metadata.gz: 5d7c6101418e338123fa98b097028e819a94297a45d5c693ddea11226f9e984026f5951ad74076453636fcb6aee478b57721287d5c6807f8caa112a66f2786ed
+  data.tar.gz: 17a6022b2146e6b94cbae099cf47b3e86bb825c1a49a6e77548febdef93ddded862fa1685a9601c22235cb2996493a1f68db49e8b1399684482ab2bb3cd06cfd

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-exporter-otlp
 
+### v0.26.2 / 2024-01-23
+
+* FIXED: Align endpoint environment variable handling with spec
+* FIXED: Require csv for ruby-3.4 compatibility
+* FIXED: Add context to metrics reporting of buffer-full events
+
+### v0.26.1 / 2023-07-29
+
+* FIXED: Regenerate v0.20.0 protos
+* ADDED: Allow google-protobuf ~> 3.14
+
 ### v0.26.0 / 2023-06-13
 
 * ADDED: Use OTLP 0.20.0 protos 

data/README.md

@@ -16,15 +16,17 @@ Generally, *libraries* that produce telemetry data should avoid depending direct
 
 ### Supported protocol version
 
-This gem supports the [v0.4.0 release](https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.4.0) of OTLP.
+This gem supports the [v0.20.0 release][otel-proto-release] of OTLP.
 
 ## How do I get started?
 
 Install the gem using:
 
-```
+```console
+
 gem install opentelemetry-sdk
 gem install opentelemetry-exporter-otlp
+
 ```
 
 Or, if you use [bundler][bundler-home], include `opentelemetry-sdk` in your `Gemfile`.
@@ -93,6 +95,48 @@ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special int
 
 The `opentelemetry-exporter-otlp` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
 
+## Working with Proto Definitions
+
+The OTel community maintains a [repository with protobuf definitions][otel-proto-github] that language and collector implementors use to generate code.
+
+Maintainers are expected to keep up to date with the latest version of protos. This guide will provide you with step-by-step instructions on updating the OTLP Exporter gem with the latest definitions.
+
+### System Requirements
+
+- [`git` 2.41+][git-install]
+- [`protoc` 22.5][protoc-install]
+- [Ruby 3+][ruby-downloads]
+
+> :warning: `protoc 23.x` *changes the Ruby code generator to emit a serialized proto instead of a DSL.* <https://protobuf.dev/news/2023-04-20/>. Please ensure you use `protoc` version `22.x` in order to ensure we remain compatible with versions of protobuf prior to `google-protobuf` gem `3.18`.
+
+### Upgrade Proto Definitions
+
+**Update the target otel-proto version in the `Rakefile` that matches a release `tag` in the proto repo, e.g.**
+
+```ruby
+  # Rakefile
+
+  # https://github.com/open-telemetry/opentelemetry-proto/tree/v0.20.0
+  PROTO_VERSION = `v0.20.0`
+```
+
+**Generate the Ruby source files using `rake`:**
+
+```console
+
+$> bundle exec rake protobuf:generate
+
+```
+
+**Run tests and fix any errors:**
+
+```console
+
+$> bundle exec rake test
+
+```
+
+**Commit the chnages and open a PR!**
 
 [opentelemetry-collector-home]: https://opentelemetry.io/docs/collector/about/
 [opentelemetry-home]: https://opentelemetry.io
@@ -103,3 +147,8 @@ The `opentelemetry-exporter-otlp` gem is distributed under the Apache 2.0 licens
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+[git-install]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
+[protoc-install]: https://github.com/protocolbuffers/protobuf/releases/tag/v22.5
+[ruby-downloads]: https://www.ruby-lang.org/en/downloads/
+[otel-proto-github]: https://github.com/open-telemetry/opentelemetry-proto
+[otel-proto-release]: https://github.com/open-telemetry/opentelemetry-proto/releases/tag/v0.20.0

data/lib/opentelemetry/exporter/otlp/exporter.rb

@@ -7,7 +7,6 @@
 require 'opentelemetry/common'
 require 'opentelemetry/sdk'
 require 'net/http'
-require 'csv'
 require 'zlib'
 
 require 'google/rpc/status_pb'
@@ -47,21 +46,16 @@ module OpenTelemetry
           end
         end
 
-        def initialize(endpoint: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'http://localhost:4318/v1/traces'),
+        def initialize(endpoint: nil,
                        certificate_file: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CERTIFICATE'),
                        ssl_verify_mode: Exporter.ssl_verify_mode,
                        headers: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_HEADERS', 'OTEL_EXPORTER_OTLP_HEADERS', default: {}),
                        compression: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_COMPRESSION', 'OTEL_EXPORTER_OTLP_COMPRESSION', default: 'gzip'),
                        timeout: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_TRACES_TIMEOUT', 'OTEL_EXPORTER_OTLP_TIMEOUT', default: 10),
                        metrics_reporter: nil)
-          raise ArgumentError, "invalid url for OTLP::Exporter #{endpoint}" unless OpenTelemetry::Common::Utilities.valid_url?(endpoint)
-          raise ArgumentError, "unsupported compression key #{compression}" unless compression.nil? || %w[gzip none].include?(compression)
+          @uri = prepare_endpoint(endpoint)
 
-          @uri = if endpoint == ENV['OTEL_EXPORTER_OTLP_ENDPOINT']
-                   URI.join(endpoint, 'v1/traces')
-                 else
-                   URI(endpoint)
-                 end
+          raise ArgumentError, "unsupported compression key #{compression}" unless compression.nil? || %w[gzip none].include?(compression)
 
           @http = http_connection(@uri, ssl_verify_mode, certificate_file)
 
@@ -172,8 +166,7 @@ module OpenTelemetry
               redo if backoff?(retry_count: retry_count += 1, reason: response.code)
               FAILURE
             when Net::HTTPNotFound
-              OpenTelemetry.handle_error(message: "OTLP exporter received http.code=404 for uri: '#{@path}'")
-              @metrics_reporter.add_to_counter('otel.otlp_exporter.failure', labels: { 'reason' => response.code })
+              log_request_failure(response.code)
               FAILURE
             when Net::HTTPBadRequest, Net::HTTPClientError, Net::HTTPServerError
               log_status(response.body)
@@ -185,6 +178,7 @@ module OpenTelemetry
               redo if backoff?(retry_after: 0, retry_count: retry_count += 1, reason: response.code)
             else
               @http.finish
+              log_request_failure(response.code)
               FAILURE
             end
           rescue Net::OpenTimeout, Net::ReadTimeout
@@ -227,11 +221,16 @@ module OpenTelemetry
             klass_or_nil = ::Google::Protobuf::DescriptorPool.generated_pool.lookup(detail.type_name).msgclass
             detail.unpack(klass_or_nil) if klass_or_nil
           end.compact
-          OpenTelemetry.handle_error(message: "OTLP exporter received rpc.Status{message=#{status.message}, details=#{details}}")
+          OpenTelemetry.handle_error(message: "OTLP exporter received rpc.Status{message=#{status.message}, details=#{details}} for uri=#{@uri}")
         rescue StandardError => e
           OpenTelemetry.handle_error(exception: e, message: 'unexpected error decoding rpc.Status in OTLP::Exporter#log_status')
         end
 
+        def log_request_failure(response_code)
+          OpenTelemetry.handle_error(message: "OTLP exporter received http.code=#{response_code} for uri='#{@uri}' in OTLP::Exporter#send_bytes")
+          @metrics_reporter.add_to_counter('otel.otlp_exporter.failure', labels: { 'reason' => response_code })
+        end
+
         def measure_request_duration
           start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
           begin
@@ -246,7 +245,7 @@ module OpenTelemetry
         end
 
         def backoff?(retry_count:, reason:, retry_after: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-          @metrics_reporter.add_to_counter('otel.otlp_exporter.failure', labels: { 'reason' => reason })
+          log_request_failure(reason)
           return false if retry_count > RETRY_COUNT
 
           sleep_interval = nil
@@ -386,6 +385,21 @@ module OpenTelemetry
           result
         end
 
+        def prepare_endpoint(endpoint)
+          endpoint ||= ENV['OTEL_EXPORTER_OTLP_TRACES_ENDPOINT']
+          if endpoint.nil?
+            endpoint = ENV['OTEL_EXPORTER_OTLP_ENDPOINT'] || 'http://localhost:4318'
+            endpoint += '/' unless endpoint.end_with?('/')
+            URI.join(endpoint, 'v1/traces')
+          elsif endpoint.strip.empty?
+            raise ArgumentError, "invalid url for OTLP::Exporter #{endpoint}"
+          else
+            URI(endpoint)
+          end
+        rescue URI::InvalidURIError
+          raise ArgumentError, "invalid url for OTLP::Exporter #{endpoint}"
+        end
+
         def prepare_headers(config_headers)
           headers = case config_headers
                     when String then parse_headers(config_headers)

data/lib/opentelemetry/exporter/otlp/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Exporter
     module OTLP
       ## Current OpenTelemetry OTLP exporter version
-      VERSION = '0.26.0'
+      VERSION = '0.26.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-exporter-otlp
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.26.2
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2024-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos-types
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.19'
+        version: '3.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.19'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -264,25 +278,21 @@ files:
 - lib/opentelemetry/exporter/otlp/exporter.rb
 - lib/opentelemetry/exporter/otlp/version.rb
 - lib/opentelemetry/proto/collector/logs/v1/logs_service_pb.rb
-- lib/opentelemetry/proto/collector/logs/v1/logs_service_services_pb.rb
 - lib/opentelemetry/proto/collector/metrics/v1/metrics_service_pb.rb
-- lib/opentelemetry/proto/collector/metrics/v1/metrics_service_services_pb.rb
 - lib/opentelemetry/proto/collector/trace/v1/trace_service_pb.rb
-- lib/opentelemetry/proto/collector/trace/v1/trace_service_services_pb.rb
 - lib/opentelemetry/proto/common/v1/common_pb.rb
 - lib/opentelemetry/proto/logs/v1/logs_pb.rb
 - lib/opentelemetry/proto/metrics/v1/metrics_pb.rb
 - lib/opentelemetry/proto/resource/v1/resource_pb.rb
-- lib/opentelemetry/proto/trace/v1/trace_config_pb.rb
 - lib/opentelemetry/proto/trace/v1/trace_pb.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.26.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.26.2/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/otlp
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.26.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp/v0.26.2
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/opentelemetry/proto/collector/logs/v1/logs_service_services_pb.rb

@@ -1,50 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: opentelemetry/proto/collector/logs/v1/logs_service.proto for package 'opentelemetry.proto.collector.logs.v1'
-# Original file comments:
-# Copyright 2020, OpenTelemetry 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.
-#
-
-require 'grpc'
-require 'opentelemetry/proto/collector/logs/v1/logs_service_pb'
-
-module Opentelemetry
-  module Proto
-    module Collector
-      module Logs
-        module V1
-          module LogsService
-            # Service that can be used to push logs between one Application instrumented with
-            # OpenTelemetry and an collector, or between an collector and a central collector (in this
-            # case logs are sent/received to/from multiple Applications).
-            class Service
-
-              include ::GRPC::GenericService
-
-              self.marshal_class_method = :encode
-              self.unmarshal_class_method = :decode
-              self.service_name = 'opentelemetry.proto.collector.logs.v1.LogsService'
-
-              # For performance reasons, it is recommended to keep this RPC
-              # alive for the entire life of the application.
-              rpc :Export, ::Opentelemetry::Proto::Collector::Logs::V1::ExportLogsServiceRequest, ::Opentelemetry::Proto::Collector::Logs::V1::ExportLogsServiceResponse
-            end
-
-            Stub = Service.rpc_stub_class
-          end
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/proto/collector/metrics/v1/metrics_service_services_pb.rb

@@ -1,50 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: opentelemetry/proto/collector/metrics/v1/metrics_service.proto for package 'opentelemetry.proto.collector.metrics.v1'
-# Original file comments:
-# Copyright 2019, OpenTelemetry 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.
-#
-
-require 'grpc'
-require 'opentelemetry/proto/collector/metrics/v1/metrics_service_pb'
-
-module Opentelemetry
-  module Proto
-    module Collector
-      module Metrics
-        module V1
-          module MetricsService
-            # Service that can be used to push metrics between one Application
-            # instrumented with OpenTelemetry and a collector, or between a collector and a
-            # central collector.
-            class Service
-
-              include ::GRPC::GenericService
-
-              self.marshal_class_method = :encode
-              self.unmarshal_class_method = :decode
-              self.service_name = 'opentelemetry.proto.collector.metrics.v1.MetricsService'
-
-              # For performance reasons, it is recommended to keep this RPC
-              # alive for the entire life of the application.
-              rpc :Export, ::Opentelemetry::Proto::Collector::Metrics::V1::ExportMetricsServiceRequest, ::Opentelemetry::Proto::Collector::Metrics::V1::ExportMetricsServiceResponse
-            end
-
-            Stub = Service.rpc_stub_class
-          end
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/proto/collector/trace/v1/trace_service_services_pb.rb

@@ -1,50 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: opentelemetry/proto/collector/trace/v1/trace_service.proto for package 'opentelemetry.proto.collector.trace.v1'
-# Original file comments:
-# Copyright 2019, OpenTelemetry 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.
-#
-
-require 'grpc'
-require 'opentelemetry/proto/collector/trace/v1/trace_service_pb'
-
-module Opentelemetry
-  module Proto
-    module Collector
-      module Trace
-        module V1
-          module TraceService
-            # Service that can be used to push spans between one Application instrumented with
-            # OpenTelemetry and a collector, or between a collector and a central collector (in this
-            # case spans are sent/received to/from multiple Applications).
-            class Service
-
-              include ::GRPC::GenericService
-
-              self.marshal_class_method = :encode
-              self.unmarshal_class_method = :decode
-              self.service_name = 'opentelemetry.proto.collector.trace.v1.TraceService'
-
-              # For performance reasons, it is recommended to keep this RPC
-              # alive for the entire life of the application.
-              rpc :Export, ::Opentelemetry::Proto::Collector::Trace::V1::ExportTraceServiceRequest, ::Opentelemetry::Proto::Collector::Trace::V1::ExportTraceServiceResponse
-            end
-
-            Stub = Service.rpc_stub_class
-          end
-        end
-      end
-    end
-  end
-end

data/lib/opentelemetry/proto/trace/v1/trace_config_pb.rb

@@ -1,49 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: opentelemetry/proto/trace/v1/trace_config.proto
-
-require 'google/protobuf'
-
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("opentelemetry/proto/trace/v1/trace_config.proto", :syntax => :proto3) do
-    add_message "opentelemetry.proto.trace.v1.TraceConfig" do
-      optional :max_number_of_attributes, :int64, 4
-      optional :max_number_of_timed_events, :int64, 5
-      optional :max_number_of_attributes_per_timed_event, :int64, 6
-      optional :max_number_of_links, :int64, 7
-      optional :max_number_of_attributes_per_link, :int64, 8
-      oneof :sampler do
-        optional :constant_sampler, :message, 1, "opentelemetry.proto.trace.v1.ConstantSampler"
-        optional :trace_id_ratio_based, :message, 2, "opentelemetry.proto.trace.v1.TraceIdRatioBased"
-        optional :rate_limiting_sampler, :message, 3, "opentelemetry.proto.trace.v1.RateLimitingSampler"
-      end
-    end
-    add_message "opentelemetry.proto.trace.v1.ConstantSampler" do
-      optional :decision, :enum, 1, "opentelemetry.proto.trace.v1.ConstantSampler.ConstantDecision"
-    end
-    add_enum "opentelemetry.proto.trace.v1.ConstantSampler.ConstantDecision" do
-      value :ALWAYS_OFF, 0
-      value :ALWAYS_ON, 1
-      value :ALWAYS_PARENT, 2
-    end
-    add_message "opentelemetry.proto.trace.v1.TraceIdRatioBased" do
-      optional :samplingRatio, :double, 1
-    end
-    add_message "opentelemetry.proto.trace.v1.RateLimitingSampler" do
-      optional :qps, :int64, 1
-    end
-  end
-end
-
-module Opentelemetry
-  module Proto
-    module Trace
-      module V1
-        TraceConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("opentelemetry.proto.trace.v1.TraceConfig").msgclass
-        ConstantSampler = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("opentelemetry.proto.trace.v1.ConstantSampler").msgclass
-        ConstantSampler::ConstantDecision = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("opentelemetry.proto.trace.v1.ConstantSampler.ConstantDecision").enummodule
-        TraceIdRatioBased = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("opentelemetry.proto.trace.v1.TraceIdRatioBased").msgclass
-        RateLimitingSampler = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("opentelemetry.proto.trace.v1.RateLimitingSampler").msgclass
-      end
-    end
-  end
-end