observable 0.1.0 → 0.1.4

data/lib/observable/structured_error.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Observable
+  class StructuredError < StandardError
+    attr_reader :context, :type
+
+    def initialize(message, type: self.class.name, context: {})
+      @context = context.to_h
+      @type = (type || self.class.name).to_s
+      super(message)
+    end
+
+    def to_h
+      {message: message}.merge(@context)
+    end
+
+    def inspect
+      "#<#{self.class.name}: #{message}, type=#{type}, context=#{@context}>"
+    end
+
+    def pretty_print
+      "#<#{self.class.name}: message: #{message}, type: #{type}, context: #{@context}>"
+    end
+
+    def self.from_error(error)
+      custom_converter_result = try_custom_converter(error)
+      if custom_converter_result
+        new(
+          custom_converter_result[:message],
+          type: custom_converter_result[:type],
+          context: custom_converter_result[:context]
+        )
+      else
+        new(
+          safe_message(error),
+          type: safe_type(error),
+          context: safe_context(error)
+        )
+      end
+    end
+
+    def self.safe_message(error)
+      if error.respond_to?(:message)
+        error.message.to_s
+      else
+        ""
+      end
+    rescue
+      ""
+    end
+
+    def self.safe_type(error)
+      return "NilClass" if error.nil?
+
+      if error.respond_to?(:type)
+        type_value = error.type
+        return type_value.to_s unless type_value.nil? || type_value.to_s.empty?
+      end
+
+      if error.respond_to?(:name)
+        name_value = error.name
+        return name_value.to_s unless name_value.nil? || name_value.to_s.empty?
+      end
+
+      error.class.name
+    rescue
+      error.class.name
+    end
+
+    def self.safe_context(error)
+      if error.nil?
+        {}
+      elsif error.respond_to?(:to_h)
+        error.to_h
+      elsif error.respond_to?(:context)
+        error.context
+      else
+        {}
+      end
+    rescue
+      {}
+    end
+
+    def self.try_custom_converter(error)
+      return nil if error.nil?
+
+      converters = Configuration.config.custom_error_converters
+      return nil if converters.empty?
+
+      converter = converters[error.class.name]
+      return nil unless converter
+
+      result = begin
+        converter.call(error)
+      rescue
+        nil
+      end
+
+      if result&.is_a?(Hash) &&
+          result.key?(:message) &&
+          result.key?(:type) &&
+          result.key?(:context)
+        result
+      end
+    end
+
+    private_class_method :safe_message, :safe_type, :safe_context, :try_custom_converter
+  end
+end

data/lib/observable/tracing_test_helper.rb

@@ -0,0 +1,51 @@
+require_relative "persistence/trace_repo"
+require_relative "persistence/span_repo"
+
+module Observable
+  module TracingTestHelper
+    def traces
+      Observable::Persistence::TraceRepo.new(spans: finished_spans)
+    end
+
+    def spans
+      Observable::Persistence::SpanRepo.new(spans: finished_spans)
+    end
+
+    def setup_observable_data!
+      @open_telemetry_exporter = setup_opentelemetry_for_tests
+    end
+
+    def teardown_observable_data!
+      reset_observable_data!
+      @open_telemetry_exporter = nil
+    end
+
+    def reset_observable_data!
+      raise NoOpenTelemetryExporter if @open_telemetry_exporter.nil?
+
+      @open_telemetry_exporter.reset
+    end
+
+    private
+
+    def finished_spans
+      raise NoOpenTelemetryExporter if @open_telemetry_exporter.nil?
+
+      @open_telemetry_exporter.finished_spans
+    end
+
+    def setup_opentelemetry_for_tests
+      require "opentelemetry/sdk"
+
+      exporter = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
+      span_processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(exporter)
+
+      # Configure the tracer provider with our span processor
+      tracer_provider = OpenTelemetry::SDK::Trace::TracerProvider.new
+      tracer_provider.add_span_processor(span_processor)
+      OpenTelemetry.tracer_provider = tracer_provider
+
+      exporter
+    end
+  end
+end

data/lib/observable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Observable
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

data/lib/observable.rb

@@ -1,8 +1,30 @@
 # frozen_string_literal: true
 
 require_relative "observable/version"
+require_relative "observable/configuration"
+require_relative "observable/instrumenter"
+require_relative "observable/structured_error"
+require_relative "observable/persistence/span"
+require_relative "observable/persistence/span_repo"
+require_relative "observable/persistence/trace"
+require_relative "observable/persistence/trace_repo"
 
 module Observable
   class Error < StandardError; end
-  # Your code goes here...
+
+  class NoOpenTelemetryExporter < Error
+    def message
+      "No OpenTelemetry exporter set up. Call `Observable::TracingTestHelper#use_in_memory_otel_exporter!` to set up the exporter."
+    end
+  end
+
+  class NotFound < Error; end
+
+  def self.instrumenter(config: nil)
+    Instrumenter.new(config: config)
+  end
+
+  def self.configure
+    yield Configuration.config
+  end
 end

data/observable.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "lib/observable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "observable"
+  spec.version = Observable::VERSION
+  spec.authors = ["John Gallagher"]
+  spec.email = ["john@synapticmishap.co.uk"]
+
+  spec.summary = "OpenTelemetry instrumentation library for Ruby methods"
+  spec.description = "A Ruby gem that provides automated OpenTelemetry instrumentation for method calls with configurable serialization, PII filtering, and argument tracking"
+  spec.homepage = "https://github.com/JoyfulProgramming/observable"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/JoyfulProgramming/observable"
+  spec.metadata["changelog_uri"] = "https://github.com/JoyfulProgramming/observable/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "opentelemetry-sdk", "~> 1.5"
+  spec.add_dependency "dry-configurable", ">= 0.13.0", "< 2.0"
+  spec.add_dependency "dry-struct", "~> 1.4"
+
+  # Development dependencies
+  spec.add_development_dependency "m", "~> 1.6"
+  spec.add_development_dependency "bump", "~> 0.10"
+  spec.add_development_dependency "minitest", "~> 5.14"
+  spec.add_development_dependency "opentelemetry-exporter-otlp", "~> 0.30"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+  spec.add_development_dependency "standard", "~> 1.40"
+  spec.add_development_dependency "super_diff", "~> 0.9"
+  spec.add_development_dependency "debug", "~> 1.8"
+end

data/pretty.rb

@@ -0,0 +1,12 @@
+require "pp"
+
+data = {
+  users: [
+    {name: "Alice", email: "alice@example.com", roles: ["admin", "user"], active: true, created_at: Time.now},
+    {name: "Bob", email: "bob@example.com", roles: ["user"], active: false, created_at: Time.now},
+    {name: "Charlie", email: "charlie@example.com", roles: ["moderator", "user"], active: true, created_at: Time.now}
+  ],
+  settings: {theme: "dark", notifications: true, language: "en"}
+}
+
+puts data

metadata

@@ -1,31 +1,220 @@
 --- !ruby/object:Gem::Specification
 name: observable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - John Gallagher
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
-dependencies: []
-description: Observe your app using Open Telemetry
+date: 2025-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A Ruby gem that provides automated OpenTelemetry instrumentation for
+  method calls with configurable serialization, PII filtering, and argument tracking
 email:
 - john@synapticmishap.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/settings.local.json"
+- ".ruby-version"
 - ".standard.yml"
 - CHANGELOG.md
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- example.rb
 - lib/observable.rb
+- lib/observable/configuration.rb
+- lib/observable/instrumenter.rb
+- lib/observable/persistence/span.rb
+- lib/observable/persistence/span_repo.rb
+- lib/observable/persistence/trace.rb
+- lib/observable/persistence/trace_repo.rb
+- lib/observable/structured_error.rb
+- lib/observable/tracing_test_helper.rb
 - lib/observable/version.rb
+- observable.gemspec
+- pretty.rb
 - sig/observable.rbs
 homepage: https://github.com/JoyfulProgramming/observable
 licenses:
@@ -35,7 +224,6 @@ metadata:
   homepage_uri: https://github.com/JoyfulProgramming/observable
   source_code_uri: https://github.com/JoyfulProgramming/observable
   changelog_uri: https://github.com/JoyfulProgramming/observable/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,15 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Observe your app using Open Telemetry
+summary: OpenTelemetry instrumentation library for Ruby methods
 test_files: []