opentelemetry-exporter-otlp-metrics 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '07981d7af4b22bf63c108726564e1228d26a38ebfe4d82060d5f0cd6b202d484'
-  data.tar.gz: '086c5ecfb4473308fad530a5394e863b62406cb3fb37348315b159fcb307197a'
+  metadata.gz: 4900aee75f04656632debac8b989868fb24fc1097ab8dd30d50216143496cbba
+  data.tar.gz: bc29bb3e4bb368ee6eb3b8aed510d5af2361da1103e7c2d524ddbe2a24e4c601
 SHA512:
-  metadata.gz: 112e0f8a4739e9833a12e35a509cee5564e9386400083990e68f5b45b1a23bb508a0b5d8e27e6419d55b70e82ae547f1c92fe5fe0a76c8c60291f8b42676dd77
-  data.tar.gz: 9dff4b4213c48a870f91b14664a9397df34bd34e51957243b4a07720cb790c2900cc984562ec2034fa55cc5e50e12007d333e04272fa804694ef04399b7b9d01
+  metadata.gz: b7d1227d845b3cc78f8528e712e99cbeb5ca42a610df51bd9a8de00f4e25dc4d5b4289dffd1edfe8da956c34ac46bf152f65999acdffa03343b2f95ef7c6c69e
+  data.tar.gz: 1de7c79780328fd7fd48ba000f60e9dd8a2e0eca7ba02fe73bc1fc7b6a56ffff82aa08fa8ad5b2dfd498d86d41a89c55b299c572463827b7528614e7cbd24f41

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-exporter-otlp-metrics
 
+### v0.2.0 / 2024-11-19
+
+* ADDED: Add basic metrics view
+* FIXED: Remove Metrics OTLP exporter `Util#measure_request_duration` and duplicate files
+* FIXED: Add mTLS for metrics exporter
+
 ### v0.1.0 / 2024-08-27
 
 Initial release.

data/README.md

@@ -18,6 +18,41 @@ Generally, *libraries* that produce telemetry data should avoid depending direct
 
 This gem supports the [v0.20.0 release][otel-proto-release] of OTLP.
 
+## Prerequisite
+
+The exporter-oltp-metrics depends on two gems that have not been officially released: opentelemetry-metrics-sdk and opentelemetry-metrics-api.
+
+Within the .gemspec file, these gems are not listed as dependencies. However, for users who need utilize this metrics exporter, they must first install and load these two gems before they can use the exporter.
+
+To facilitate this, there are couple recommended approaches:
+
+### 1. Download the source code
+
+1. Download the [opentelemetry-ruby](https://github.com/open-telemetry/opentelemetry-ruby).
+2. Navigate to subfolder, then build the [metrics_sdk](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/metrics_sdk) and [metrics_api](https://github.com/open-telemetry/opentelemetry-ruby/tree/main/metrics_api).
+3. Execute `gem build *.gemspec`.
+4. Lastly, install the built gem into the system.
+
+### 2. Using `path:` option in Gemfile with downloaded source code
+
+git clone [opentelemetry-ruby](https://github.com/open-telemetry/opentelemetry-ruby) first, then use Gemfile
+
+```ruby
+# Gemfile
+source 'https://rubygems.org'
+gem 'opentelemetry-metrics-api', path: "opentelemetry-ruby/metrics_api"
+gem 'opentelemetry-metrics-sdk', path: "opentelemetry-ruby/metrics_sdk"
+```
+
+### 3. Using `git:` option in Gemfile
+
+```ruby
+# Gemfile
+source 'https://rubygems.org'
+gem 'opentelemetry-metrics-api', git: "https://github.com/open-telemetry/opentelemetry-ruby", glob: 'metrics_api/*.gemspec'
+gem 'opentelemetry-metrics-sdk', git: "https://github.com/open-telemetry/opentelemetry-ruby", glob: 'metrics_sdk/*.gemspec'
+```
+
 ## How do I get started?
 
 Install the gem using:
@@ -67,15 +102,15 @@ The collector exporter can be configured explicitly in code, or via environment
 | ------------------- | -------------------------------------------- | ----------------------------------- |
 | `endpoint:`         | `OTEL_EXPORTER_OTLP_ENDPOINT`                | `"http://localhost:4318/v1/metrics"` |
 | `certificate_file: `| `OTEL_EXPORTER_OTLP_CERTIFICATE`             |                                     |
+| `client_certificate_file: `| `OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE` |                                   |
+| `client_key_file:`       | `OTEL_EXPORTER_OTLP_CLIENT_KEY`              |                                     |
 | `headers:`          | `OTEL_EXPORTER_OTLP_HEADERS`                 |                                     |
 | `compression:`      | `OTEL_EXPORTER_OTLP_COMPRESSION`             | `"gzip"`                            |
 | `timeout:`          | `OTEL_EXPORTER_OTLP_TIMEOUT`                 | `10`                                |
-| `ssl_verify_mode:`  | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` or | `OpenSSL::SSL:VERIFY_PEER`          |
-|                     | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE`    |                                     |
+| `ssl_verify_mode:`  | `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_PEER` or `OTEL_RUBY_EXPORTER_OTLP_SSL_VERIFY_NONE` | `OpenSSL::SSL:VERIFY_PEER`          |
 
 `ssl_verify_mode:` parameter values should be flags for server certificate verification: `OpenSSL::SSL:VERIFY_PEER` and `OpenSSL::SSL:VERIFY_NONE` are acceptable. These values can also be set using the appropriately named environment variables as shown where `VERIFY_PEER` will take precedence over `VERIFY_NONE`.  Please see [the Net::HTTP docs](https://ruby-doc.org/stdlib-2.7.6/libdoc/net/http/rdoc/Net/HTTP.html#verify_mode) for more information about these flags.
 
-
 ## How can I get involved?
 
 The `opentelemetry-exporter-otlp-metrics` gem source is [on github][repo-github], along with related gems including `opentelemetry-metrics-sdk`.

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

@@ -26,7 +26,7 @@ module OpenTelemetry
     module OTLP
       module Metrics
         # An OpenTelemetry metrics exporter that sends metrics over HTTP as Protobuf encoded OTLP ExportMetricsServiceRequest.
-        class MetricsExporter < ::OpenTelemetry::SDK::Metrics::Export::MetricReader # rubocop:disable Metrics/ClassLength
+        class MetricsExporter < ::OpenTelemetry::SDK::Metrics::Export::MetricReader
           include Util
 
           attr_reader :metric_snapshots
@@ -47,6 +47,8 @@ module OpenTelemetry
 
           def initialize(endpoint: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_METRICS_ENDPOINT', 'OTEL_EXPORTER_OTLP_ENDPOINT', default: 'http://localhost:4318/v1/metrics'),
                          certificate_file: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CERTIFICATE'),
+                         client_certificate_file: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE', 'OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE'),
+                         client_key_file: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY', 'OTEL_EXPORTER_OTLP_CLIENT_KEY'),
                          ssl_verify_mode: MetricsExporter.ssl_verify_mode,
                          headers: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_METRICS_HEADERS', 'OTEL_EXPORTER_OTLP_HEADERS', default: {}),
                          compression: OpenTelemetry::Common::Utilities.config_opt('OTEL_EXPORTER_OTLP_METRICS_COMPRESSION', 'OTEL_EXPORTER_OTLP_COMPRESSION', default: 'gzip'),
@@ -63,7 +65,7 @@ module OpenTelemetry
                      URI(endpoint)
                    end
 
-            @http = http_connection(@uri, ssl_verify_mode, certificate_file)
+            @http = http_connection(@uri, ssl_verify_mode, certificate_file, client_certificate_file, client_key_file)
 
             @path = @uri.path
             @headers = prepare_headers(headers)
@@ -87,7 +89,7 @@ module OpenTelemetry
             end
           end
 
-          def send_bytes(bytes, timeout:) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+          def send_bytes(bytes, timeout:)
             return FAILURE if bytes.nil?
 
             request = Net::HTTP::Post.new(@path)
@@ -115,7 +117,7 @@ module OpenTelemetry
               @http.read_timeout = remaining_timeout
               @http.write_timeout = remaining_timeout
               @http.start unless @http.started?
-              response = measure_request_duration { @http.request(request) }
+              response = @http.request(request)
               case response
               when Net::HTTPOK
                 response.body # Read and discard body
@@ -181,7 +183,7 @@ module OpenTelemetry
             @http.write_timeout = @timeout
           end
 
-          def encode(metrics_data) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+          def encode(metrics_data)
             Opentelemetry::Proto::Collector::Metrics::V1::ExportMetricsServiceRequest.encode(
               Opentelemetry::Proto::Collector::Metrics::V1::ExportMetricsServiceRequest.new(
                 resource_metrics: metrics_data
@@ -215,7 +217,7 @@ module OpenTelemetry
           # current metric sdk only implements instrument: :counter -> :sum, :histogram -> :histogram
           #
           # metrics [MetricData]
-          def as_otlp_metrics(metrics) # rubocop:disable Metrics/MethodLength
+          def as_otlp_metrics(metrics)
             case metrics.instrument_kind
             when :observable_gauge
               Opentelemetry::Proto::Metrics::V1::Metric.new(

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

@@ -15,11 +15,13 @@ module OpenTelemetry
           ERROR_MESSAGE_INVALID_HEADERS = 'headers must be a String with comma-separated URL Encoded UTF-8 k=v pairs or a Hash'
           DEFAULT_USER_AGENT = "OTel-OTLP-MetricsExporter-Ruby/#{OpenTelemetry::Exporter::OTLP::Metrics::VERSION} Ruby/#{RUBY_VERSION} (#{RUBY_PLATFORM}; #{RUBY_ENGINE}/#{RUBY_ENGINE_VERSION})".freeze
 
-          def http_connection(uri, ssl_verify_mode, certificate_file)
+          def http_connection(uri, ssl_verify_mode, certificate_file, client_certificate_file, client_key_file)
             http = Net::HTTP.new(uri.host, uri.port)
             http.use_ssl = uri.scheme == 'https'
             http.verify_mode = ssl_verify_mode
             http.ca_file = certificate_file unless certificate_file.nil?
+            http.cert = OpenSSL::X509::Certificate.new(File.read(client_certificate_file)) unless client_certificate_file.nil?
+            http.key = OpenSSL::PKey::RSA.new(File.read(client_key_file)) unless client_key_file.nil?
             http.keep_alive_timeout = KEEP_ALIVE_TIMEOUT
             http
           end
@@ -67,16 +69,6 @@ module OpenTelemetry
             headers
           end
 
-          def measure_request_duration
-            start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-            begin
-              yield
-            ensure
-              stop = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-              1000.0 * (stop - start)
-            end
-          end
-
           def parse_headers(raw)
             entries = raw.split(',')
             raise ArgumentError, ERROR_MESSAGE_INVALID_HEADERS if entries.empty?
@@ -97,7 +89,7 @@ module OpenTelemetry
             end
           end
 
-          def backoff?(retry_count:, reason:, retry_after: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          def backoff?(retry_count:, reason:, retry_after: nil)
             return false if retry_count > RETRY_COUNT
 
             sleep_interval = nil

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

@@ -9,7 +9,7 @@ module OpenTelemetry
     module OTLP
       module Metrics
         ## Current OpenTelemetry OTLP exporter version
-        VERSION = '0.1.0'
+        VERSION = '0.2.0'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-exporter-otlp-metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleapis-common-protos-types
@@ -324,10 +324,10 @@ 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-metrics/v0.1.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp-metrics/v0.2.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/exporter/otlp-metrics
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp-metrics/v0.1.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-exporter-otlp-metrics/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: