hermes-rb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61eb45c503cb8431d679fd198af4b65f379fd3efe4d40381ae72baf39bffa9bc
-  data.tar.gz: '09cf809349943da3991e64e9ceea38b3e9a54cd5d992a6aeb11524c784bbe837'
+  metadata.gz: e7a8150916885c53a7ec982a4a8b4c52b3ae181c372a49d848af7e1938c4e57d
+  data.tar.gz: 1df94ecfc4595c5c8e6c67d79750c4a2fbca4f1a7119a1f5c532b83890a9e1f8
 SHA512:
-  metadata.gz: 67a2991af401ec5a66b2717b683b82ad4816fd6a9bb6be17a688ee19de05bf112c511b81b126cdb224c219b42720125ff59acfd95b865a2fbde908f4f59338ef
-  data.tar.gz: f7104301bfc8993a15cade245ec42d2a1a40e308c04033004caa1883aba238908358d6f62bca024c250a6208d20c4d5116db3b1553068c59895db9ce34fa60eb
+  metadata.gz: 57bd2ad4a3a48368360bc1d7fcd42817ef698f326c423068b237123142707d64ca025af62cc8fc0bc9540a0cfe338d701124d73a19b3fe6795c98a7a91ff3a50
+  data.tar.gz: 89550087ed862bdeb2cb3472d766071f6504f8608ffad58c3fa164c756dee2775b91d7ee299a55949e8ba7d8a31750accaff0688269a13cf81185a924bf71cfc

data/Changelog.md

@@ -2,6 +2,10 @@
 
 ## Master
 
+## 0.5.0
+- Add Datadog tracer
+- Allow to provide a custom tracer
+
 ## 0.4.0
 - Make it possible to provide Hutch consumer config
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hermes-rb (0.4.0)
+    hermes-rb (0.5.0)
       activerecord (>= 5)
       activesupport (>= 5)
       dry-container (~> 0)
@@ -29,6 +29,8 @@ GEM
     carrot-top (0.0.7)
       json
     concurrent-ruby (1.1.8)
+    ddtrace (0.45.0)
+      msgpack
     diff-lcs (1.4.4)
     dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
@@ -61,7 +63,8 @@ GEM
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     json (2.5.1)
-    minitest (5.14.3)
+    minitest (5.14.4)
+    msgpack (1.4.2)
     multi_json (1.15.0)
     newrelic_rpm (6.15.0)
     pg (1.2.3)
@@ -93,6 +96,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  ddtrace
   hermes-rb!
   newrelic_rpm
   pg

data/README.md

@@ -38,6 +38,7 @@ Rails.application.config.to_prepare do
       hutch.uri = ENV.fetch("HUTCH_URI")
       hutch.force_publisher_confirms = true
       hutch.enable_http_api_use = false 
+      hutch.tracer = MyOwnCustomTracerIfIWantToDoSomethingCrazy 
     end
     config.distributed_tracing_database_uri = ENV.fetch("DISTRIBUTED_TRACING_DATABASE_URI", nil)
     config.error_notification_service = Raven
@@ -92,6 +93,7 @@ If you know what you are doing, you don't necessarily have to process things in
    - `uri` - the URI for RabbitMQ, required.
    - `force_publisher_confirms` - defaults to `true`
    - `enable_http_api_use` - defaults to `false`
+   - `tracer` - defaults to `Hermes::Tracers::Datadog` if you use Datadog, `Hutch::Tracers::NewRelic` for NewRelic and `Hutch::Tracers::NullTracer` if you use neither Datadog, nor NewRelic. Check APM section for more details if you want to provide a custom tracer.
 8. `event_handler.handle_events` - that's how you declare events and their handlers. The event handler is an object that responds to `call` method and takes `event` as an argument. All events should ideally be subclasses of `Hermes::BaseEvent`
 
 This class inherits from `Dry::Struct`, so getting familiar with [dry-struct gem](https://dry-rb.org/gems/dry-struct/) would be beneficial. Here is an example event:
@@ -187,9 +189,11 @@ parsed_response_hash = Hermes::RpcClient.new(rpc_call_timeout: 10).call(event)
 
 If the request timeouts, `Hermes::RpcClient::RpcTimeoutError` will be raised.
 
-## NewRelic integration
+## APM and tracing
 
-The integration is enabled automatically if you use `newrelic_rpm` gem via `Hutch::Tracers::NewRelic`.
+The integration is enabled automatically if you use `newrelic_rpm` gem via `Hutch::Tracers::NewRelic` or via `Hermes::Tracers::Datadog` when using `ddtrace` gem.
+
+You can also provide your own tracer, as long as it implements an interface expected by [Hutch][https://github.com/ruby-amqp/hutch].
 
 ## Distributed Tracing (experimental feature, the interface might change in the future)
 

data/hermes-rb.gemspec

@@ -41,4 +41,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "newrelic_rpm"
+  spec.add_development_dependency "ddtrace"
 end

data/lib/hermes.rb

@@ -24,6 +24,7 @@ require "hermes/retryable_event_producer"
 require "hermes/producer_error_handler"
 require "hermes/producer_error_handler/null_handler"
 require "hermes/producer_error_handler/safe_handler"
+require "hermes/tracers"
 require "active_support"
 require "active_support/core_ext/string"
 require "active_record"

data/lib/hermes/configuration.rb

@@ -4,7 +4,7 @@ module Hermes
       :background_processor, :enqueue_method, :event_handler, :rpc_call_timeout,
       :instrumenter, :distributed_tracing_database_uri, :distributed_tracing_database_table,
       :distributes_tracing_mapper, :database_error_handler, :error_notification_service, :producer_error_handler,
-      :producer_error_handler_job_class, :producer_retryable, :logger_params_filter
+      :producer_error_handler_job_class, :producer_retryable, :logger_params_filter, :tracer
 
     def configure_hutch
       yield hutch
@@ -82,14 +82,14 @@ module Hermes
       attr_reader :original_hutch_config
       private     :original_hutch_config
 
-      attr_accessor :uri, :force_publisher_confirms, :enable_http_api_use
+      attr_accessor :uri, :force_publisher_confirms, :enable_http_api_use, :tracer
 
       def initialize(original_hutch_config: Hutch::Config)
         @original_hutch_config = original_hutch_config
       end
 
       def commit_config
-        original_hutch_config.set(:tracer, Hutch::Tracers::NewRelic) if Object.const_defined?("NewRelic")
+        original_hutch_config.set(:tracer, tracer) if tracer
         original_hutch_config.set(:force_publisher_confirms, force_publisher_confirms)
         original_hutch_config.set(:uri, uri)
       end
@@ -105,6 +105,13 @@ module Hermes
 
         @enable_http_api_use ||= false
       end
+
+      def tracer
+        return @tracer if @tracer
+        return Hermes::Tracers::Datadog if Object.const_defined?("Datadog")
+        return Hutch::Tracers::NewRelic if Object.const_defined?("NewRelic")
+        Hutch::Tracers::NullTracer
+      end
     end
     private_constant :HutchConfig
   end

data/lib/hermes/rb/version.rb

@@ -1,5 +1,5 @@
 module Hermes
   module Rb
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/hermes/tracers.rb

@@ -0,0 +1,5 @@
+module Hermes
+  module Tracers
+    autoload :Datadog, "hermes/tracers/datadog"
+  end
+end

data/lib/hermes/tracers/datadog.rb

@@ -0,0 +1,20 @@
+require "ddtrace"
+
+module Hermes
+  module Tracers
+    class Datadog
+      attr_reader :klass
+      private     :klass
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def handle(message)
+        ::Datadog.tracer.trace(klass.class.name, service: "hermes", span_type: "rabbitmq") do
+          klass.process(message)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes-rb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A messenger of gods, delivering them via RabbitMQ with a little help
   from Hutch
 email:
@@ -245,6 +259,8 @@ files:
 - lib/hermes/serializer.rb
 - lib/hermes/support/matchers/publish_async_message.rb
 - lib/hermes/trace_context.rb
+- lib/hermes/tracers.rb
+- lib/hermes/tracers/datadog.rb
 - untitled
 homepage: https://github.com/BookingSync/hermes-rb
 licenses: