lib/deimos/instrumentation.rb in deimos-ruby-1.16.3 vs lib/deimos/instrumentation.rb in deimos-ruby-1.16.4

@@ -6,27 +6,33 @@
 # :nodoc:
 module Deimos
   # Copied from Phobos instrumentation.
   module Instrumentation
     extend ActiveSupport::Concern
+
+    # @return [String]
     NAMESPACE = 'Deimos'
 
     # :nodoc:
     module ClassMethods
-      # :nodoc:
+      # @param event [String]
+      # @return [void]
       def subscribe(event)
         ActiveSupport::Notifications.subscribe("#{NAMESPACE}.#{event}") do |*args|
           yield(ActiveSupport::Notifications::Event.new(*args)) if block_given?
         end
       end
 
-      # :nodoc:
+      # @param subscriber [ActiveSupport::Subscriber]
+      # @return [void]
       def unsubscribe(subscriber)
         ActiveSupport::Notifications.unsubscribe(subscriber)
       end
 
-      # :nodoc:
+      # @param event [String]
+      # @param extra [Hash]
+      # @return [void]
       def instrument(event, extra={})
         ActiveSupport::Notifications.instrument("#{NAMESPACE}.#{event}", extra) do |extra2|
           yield(extra2) if block_given?
         end
       end
@@ -37,10 +43,11 @@
 
   # This module listens to events published by RubyKafka.
   module KafkaListener
     # Listens for any exceptions that happen during publishing and re-publishes
     # as a Deimos event.
-    # @param event [ActiveSupport::Notification]
+    # @param event [ActiveSupport::Notifications::Event]
+    # @return [void]
     def self.send_produce_error(event)
       exception = event.payload[:exception_object]
       return if !exception || !exception.respond_to?(:failed_messages)
 
       messages = exception.failed_messages