acfs 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45e81963e8044fcd6dbb2c5b3e8026de90c77d35e8ec5de2e73a8a3afaa839a5
-  data.tar.gz: 3507a04d6fcae2bfb6e637c3ef67eeaa9f9d02a154a635fe6b767e0d53669220
+  metadata.gz: 1a8433e212c204d4d4cfac1240933f0db9205e1c7290dd8f22a3cf0f17f41ad2
+  data.tar.gz: e89a53d16da8d2899ec89bbca9d4cf818e820dc7bb7887a34314faa6eaa60ad1
 SHA512:
-  metadata.gz: 2b0fc88443461e879c6c5b10375b7cef376d9690961935165d72be6acc91038a9101ea9073f2ff63f8f3efe1d19656ce7c431b37562ecf4d93deec78a0cbcfc2
-  data.tar.gz: 6518c3f15372487c8d3d4af937c0e9cb97e53f6aea08d5f2bd0a18da3043f105e7300c59b85ca154f7f7d20962587fe4812e8dc36e37bda082172c7e06d03223
+  metadata.gz: a752de373a4d503da9de34886bb4d5e5988c0d04fd40afd95d3570d24f6ccc70136ef487491301d25f0b50120b7e81b38c2f79cf12492d016498c768ed7bb1dd
+  data.tar.gz: fa18f22c3cbb3dddf61d96e660a4c869cbe58efb991a6d2d4460c2b4a2a9388e77ad7f5b54210eb8829c6865d920e3e45ad34f09ece63ecbe0045f7a2d020a28

data/CHANGELOG.md

@@ -12,6 +12,14 @@
 
 ### Breaks
 
+## 2.1.0 - (2025-02-14)
+
+---
+
+### New
+
+- Experimental support for OpenTelemetry
+
 ## 2.0.0 - (2025-01-17)
 
 ---

data/README.md

@@ -14,7 +14,7 @@ Acfs covers model and service abstraction, convenient query and filter methods,
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'acfs', '~> 2.0'
+gem 'acfs', '~> 2.1'
 ```
 
 And then execute:

data/acfs.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activemodel', '>= 7.0'
   spec.add_dependency 'activesupport', '>= 7.0'
   spec.add_dependency 'multi_json', '~> 1.0'
+  spec.add_dependency 'opentelemetry-api', '~> 1.0'
+  spec.add_dependency 'opentelemetry-common'
   spec.add_dependency 'rack'
   spec.add_dependency 'typhoeus', '~> 1.0'
 end

data/lib/acfs/global.rb

@@ -28,9 +28,11 @@ module Acfs
     # @return [undefined]
     #
     def run
-      ::ActiveSupport::Notifications.instrument 'acfs.before_run'
-      ::ActiveSupport::Notifications.instrument 'acfs.run' do
-        runner.start
+      Telemetry.in_span('acfs.run', attributes: {'code.stacktrace' => caller.join("\n")}) do
+        ::ActiveSupport::Notifications.instrument 'acfs.before_run'
+        ::ActiveSupport::Notifications.instrument 'acfs.run' do
+          runner.start
+        end
       end
     end
 
@@ -50,9 +52,11 @@ module Acfs
     # Reset all queues, stubs and internal state.
     #
     def reset
-      ::ActiveSupport::Notifications.instrument 'acfs.reset' do
-        runner.clear
-        Acfs::Stub.clear
+      Telemetry.in_span('acfs.reset') do
+        ::ActiveSupport::Notifications.instrument 'acfs.reset' do
+          runner.clear
+          Acfs::Stub.clear
+        end
       end
     end
 

data/lib/acfs/request.rb

@@ -8,17 +8,18 @@ module Acfs
   #
   class Request
     attr_accessor :body, :format
-    attr_reader :url, :headers, :params, :data, :method, :operation
+    attr_reader :uri, :url, :headers, :params, :data, :method, :operation
 
     include Request::Callbacks
     def initialize(url, **options, &block)
-      @url = URI.parse(url.to_s).tap do |_url|
+      @uri = URI.parse(url.to_s).tap do |_url|
         @data    = options.delete(:data) || nil
         @format  = options.delete(:format) || :json
         @headers = options.delete(:headers) || {}
         @params  = options.delete(:params) || {}
         @method  = options.delete(:method) || :get
-      end.to_s
+      end
+      @url = @uri.to_s
 
       @operation = options.delete(:operation) || nil
 

data/lib/acfs/runner.rb

@@ -7,6 +7,8 @@ module Acfs
   #
   class Runner
     include Service::Middleware
+    include Acfs::Telemetry
+
     attr_reader :adapter
 
     def initialize(adapter)
@@ -25,8 +27,10 @@ module Acfs
     # Run operation right now skipping queue.
     #
     def run(operation)
-      ::ActiveSupport::Notifications.instrument('acfs.runner.sync_run', operation: operation) do
-        operation_request(operation) {|req| adapter.run req }
+      tracer.in_span('acfs.runner.sync_run') do
+        ::ActiveSupport::Notifications.instrument('acfs.runner.sync_run', operation: operation) do
+          operation_request(operation) {|req| adapter.run req }
+        end
       end
     end
 
@@ -39,11 +43,13 @@ module Acfs
     # Enqueue operation to be run later.
     #
     def enqueue(operation)
-      ::ActiveSupport::Notifications.instrument('acfs.runner.enqueue', operation: operation) do
-        if running?
-          operation_request(operation) {|req| adapter.queue req }
-        else
-          queue << operation
+      tracer.in_span('acfs.runner.enqueue') do
+        ::ActiveSupport::Notifications.instrument('acfs.runner.enqueue', operation: operation) do
+          if running?
+            operation_request(operation) {|req| adapter.queue req }
+          else
+            queue << operation
+          end
         end
       end
     end
@@ -93,10 +99,42 @@ module Acfs
       req = operation.service.prepare(operation.request)
       return unless req.is_a? Acfs::Request
 
-      req = prepare req
+      req = prepare(req)
       return unless req.is_a? Acfs::Request
 
       yield req
     end
+
+    def prepare(request)
+      method = request.method.to_s.upcase
+      template = request.operation.location&.raw_uri.to_s
+
+      name = "HTTP #{method}"
+      name = "#{method} #{template}" if template
+
+      attributes = {
+        'http.request.method' => method,
+        'server.address' => request.uri.host,
+        'server.port' => request.uri.port,
+        'url.full' => request.uri.to_s,
+        'url.scheme' => request.uri.scheme,
+        'url.template' => template,
+      }
+
+      span = tracer.start_span(name, attributes:, kind: :client)
+      OpenTelemetry::Trace.with_span(span) do
+        OpenTelemetry.propagation.inject(request.headers)
+
+        request.on_complete do |response, nxt|
+          span.set_attribute('http.response.status_code', response.status_code)
+          span.status = OpenTelemetry::Trace::Status.error unless (100..399).cover?(response.status_code)
+
+          span.finish
+          nxt.call(response)
+        end
+
+        super
+      end
+    end
   end
 end

data/lib/acfs/telemetry.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Acfs
+  module Telemetry
+    class << self
+      delegate :in_span, :start_span, to: :tracer
+
+      def tracer
+        @tracer ||= OpenTelemetry.tracer_provider.tracer('acfs', Acfs::VERSION.to_s)
+      end
+    end
+
+    protected
+
+    def tracer
+      Acfs::Telemetry.tracer
+    end
+  end
+end

data/lib/acfs/version.rb

@@ -3,7 +3,7 @@
 module Acfs
   module VERSION
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
     STAGE = nil
 

data/lib/acfs.rb

@@ -7,12 +7,16 @@ require 'active_support/core_ext/string'
 require 'active_support/core_ext/module'
 require 'active_support/notifications'
 
+require 'opentelemetry'
+require 'opentelemetry/common'
+
 module Acfs
   extend ActiveSupport::Autoload
   require 'acfs/version'
   require 'acfs/errors'
   require 'acfs/global'
   require 'acfs/util'
+  require 'acfs/telemetry'
 
   require 'acfs/collection'
   require 'acfs/configuration'

data/vendor/bundle/ruby/3.4.0/bundler/gems/rubocop-config-67802c9d1826/rubocop-config.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.metadata = { "allowed_push_host" => ".", "rubygems_mfa_required" => "true" } if s.respond_to? :metadata=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jan Graichen".freeze]
-  s.date = "2025-01-17"
+  s.date = "2025-02-14"
   s.email = ["jgraichen@altimos.de".freeze]
   s.files = ["LICENSE".freeze, "README.md".freeze, "default.yml".freeze]
   s.homepage = "https://github.com/jgraichen/rubocop-config".freeze