instrument-decorator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c0088d00cff2e5b8c03bde5f110383c774cceacb4ec8b2f72fff8a2aca67e3e
+  data.tar.gz: ea062a349d8017f07f34bb929304a2b8f1a16e67be9170ca0ae3888ee235760a
+SHA512:
+  metadata.gz: 852672abea987fbc334cd461592983c3fee3787ca9189eb40cccce8a9bac173fcb96e7f48fb6ab5126b3389c19e9a850567ce9fb94a7e638c9549cec328b0a80
+  data.tar.gz: f4b4f8c66986e1b99c1f1a8ccc6a1f6b4b0a4182961b566f3fc869d48dac67079557a282d252f78fcc65fef661f8b20d7cb3f59febb6667053eed248e9703f15

data/.env.example

@@ -0,0 +1,2 @@
+OTEL_SERVICE_NAME="instrument-decorator-tests"
+OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4318"

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Josh Clayton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Instrument::Decorator
+
+This gem provides a way to decorate methods with instrumentation. Its primary
+use case is to send information about invoked methods and their arguments to
+OpenTelemetry collectors.
+
+## Usage
+
+Instrumentation is provided via a decorator that can be mixed into your classes.
+
+### Instrumenting an instance method
+
+```ruby
+class Example
+  include Instrument::Decorator
+
+  instrument def example_method
+    # Your method implementation here
+  end
+end
+```
+
+### Instrumenting a class method
+
+```ruby
+class Example
+  include Instrument::Decorator
+
+  instrument_class_method def self.example_method
+    # Your method implementation here
+  end
+end
+```
+
+This sends any `args` or `kwargs` data, along with any exception information
+that gets raised during the execution of the method.
+
+Name information sent follow Ruby's `ClassName#method_name` or
+`ClassName.method_name` conventions.
+
+## Tests
+
+First, ensure your `.env` is set up correctly:
+
+```sh
+cp .env.example .env
+```
+
+To verify data is spent to an OTel collector, start a Jaeger instance via Docker:
+
+```sh
+docker run --name jaeger \
+  -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+  -e COLLECTOR_OTLP_ENABLED=true \
+  -p 6831:6831/udp \
+  -p 6832:6832/udp \
+  -p 5778:5778 \
+  -p 16686:16686 \
+  -p 4317:4317 \
+  -p 4318:4318 \
+  -p 14250:14250 \
+  -p 14268:14268 \
+  -p 14269:14269 \
+  -p 9411:9411 \
+  jaegertracing/all-in-one:latest
+```
+
+Open up your browser to `http://localhost:16686` to view the Jaeger UI.
+
+Finally, run tests:
+
+```sh
+bin/test
+```
+
+This will run the test suite with a null tracer (which has no behavior) and with an OTel tracer.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/joshuaclayton/instrument-decorator. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [code of
+conduct](https://github.com/joshuaclayton/instrument-decorator/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Instrument::Decorator project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/joshuaclayton/instrument-decorator/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/lib/instrument/decorator/config.rb

@@ -0,0 +1,67 @@
+module Instrument::Decorator
+  class Config
+    def initialize
+      @generate_tracer = ->(provided_namespace, version = nil) do
+        Instrument::Decorator::NullTracer.new(provided_namespace, version)
+      end
+
+      @generate_error_status = ->(error) do
+        Instrument::Decorator::NullTracer.error_status(error)
+      end
+    end
+
+    def for_open_telemetry
+      @generate_tracer = ->(provided_namespace, version = nil) do
+        OpenTelemetry.tracer_provider.tracer(provided_namespace, version)
+      end
+
+      @generate_error_status = ->(error) do
+        OpenTelemetry::Trace::Status.error(error.to_s)
+      end
+    end
+
+    def generate_tracer(provided_namespace, version = nil)
+      @generate_tracer.call(namespace(provided_namespace), version)
+    end
+
+    def on_generate_tracer(&block)
+      @generate_tracer = block
+    end
+
+    def track_error(span:, error:)
+      span.record_exception(error)
+      span.status = @generate_error_status.call(error)
+    end
+
+    def track_call(span:, args:, kwargs:)
+      span.add_attributes(
+        args_label => format_args(args),
+        kwargs_label => format_kwargs(kwargs)
+      )
+    end
+
+    def namespace(value)
+      (value || "{unknown}").to_s
+    end
+
+    def display_name(class_name:, method_name:, method_type:)
+      "#{class_name || "{anonymous}"}#{(method_type == :class) ? "." : "#"}#{method_name}"
+    end
+
+    def format_args(args)
+      args.to_json
+    end
+
+    def format_kwargs(kwargs)
+      kwargs.to_json
+    end
+
+    def args_label
+      "method.args"
+    end
+
+    def kwargs_label
+      "method.kwargs"
+    end
+  end
+end

data/lib/instrument/decorator/null_tracer.rb

@@ -0,0 +1,25 @@
+module Instrument::Decorator
+  class NullTracer
+    def initialize(*)
+    end
+
+    def in_span(*)
+      yield(NullSpan.new)
+    end
+
+    def self.error_status(error)
+      error.to_s
+    end
+
+    class NullSpan
+      def record_exception(*)
+      end
+
+      def status=(*)
+      end
+
+      def add_attributes(*)
+      end
+    end
+  end
+end

data/lib/instrument/decorator/track.rb

@@ -0,0 +1,44 @@
+module Instrument::Decorator
+  class Track
+    attr_reader :name, :args, :kwargs, :block, :namespace, :error
+
+    def initialize(name:, args:, kwargs:, block:, namespace:)
+      @name = name
+      @args = args
+      @kwargs = kwargs
+      @block = block
+      @namespace = namespace
+      @span = nil
+      @error = nil
+      @started_at = nil
+    end
+
+    def track_error(error)
+      Instrument::Decorator.config.track_error(span:, error:)
+
+      @error = error
+    end
+
+    def duration
+      if @ended_at && @started_at
+        @ended_at - @started_at
+      end
+    end
+
+    def start(span:)
+      @span = span
+      Instrument::Decorator.config.track_call(span:, args:, kwargs:)
+
+      @started_at = Time.now
+      self
+    end
+
+    def finish
+      @ended_at = Time.now
+    end
+
+    private
+
+    attr_reader :span
+  end
+end

data/lib/instrument/decorator/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Instrument
+  module Decorator
+    VERSION = "0.1.0"
+  end
+end

data/lib/instrument/decorator.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "decorator/version"
+require_relative "decorator/track"
+require_relative "decorator/config"
+require_relative "decorator/null_tracer"
+require "active_support/all"
+
+module Instrument
+  module Decorator
+    extend ActiveSupport::Concern
+    class Error < StandardError; end
+
+    mattr_accessor :config
+
+    def self.configure(&block)
+      self.config ||= Config.new
+
+      block.call(config)
+    end
+
+    def self.reset
+      self.config = Config.new
+    end
+
+    def self.[](custom)
+      Interior[custom]
+    end
+
+    included do
+      include Interior[nil]
+    end
+
+    module Interior
+      extend ActiveSupport::Concern
+
+      mattr_accessor :namespace
+
+      private :namespace=
+
+      def self.[](custom)
+        self.namespace = custom
+
+        self
+      end
+
+      class_methods do
+        def instrument_class_method(method_name)
+          __instrument__(method_name, class_name: name, method_type: :class, target: singleton_class)
+        end
+
+        def instrument(method_name)
+          __instrument__(method_name, class_name: name, method_type: :instance, target: self)
+        end
+
+        def __instrument__(method_name, class_name:, method_type:, target:)
+          namespace = Interior.namespace
+
+          __instrumentation_module__(target).class_eval do
+            define_method(method_name) do |*args, **kwargs, &block|
+              tracer = Instrument::Decorator.config.generate_tracer(namespace)
+
+              display_name = Instrument::Decorator.config.display_name(
+                class_name:,
+                method_name:,
+                method_type:
+              )
+
+              track = Instrument::Decorator::Track.new(name: method_name, args:, kwargs:, block:, namespace:)
+
+              tracer.in_span(display_name) do |span|
+                track.start(span:)
+                super(*args, **kwargs, &block)
+              rescue => e
+                track.track_error(e)
+                raise e
+              ensure
+                track.finish
+              end
+            end
+          end
+        end
+
+        def __instrumentation_module__(target)
+          if target.const_defined?(:Instrumentation)
+            target.const_get(:Instrumentation)
+          else
+            target.const_set(:Instrumentation, Module.new).tap do
+              target.prepend(_1)
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: instrument-decorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Clayton
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+email:
+- joshua.clayton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/instrument/decorator.rb
+- lib/instrument/decorator/config.rb
+- lib/instrument/decorator/null_tracer.rb
+- lib/instrument/decorator/track.rb
+- lib/instrument/decorator/version.rb
+homepage: https://github.com/joshuaclayton/instrument-decorator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/joshuaclayton/instrument-decorator
+  source_code_uri: https://github.com/joshuaclayton/instrument-decorator
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Method decorator for instrumentation, allowing hooks to e.g. OpenTelemetry
+test_files: []