influx_reporter 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1b0c481adf3b258ec29fc1a2a526d2d4053fbb50
-  data.tar.gz: f1fce2792f3ff3b7be73160c81aa9ce05dbd81d7
+SHA256:
+  metadata.gz: 3ddddb2aec52aed72cd27b0068fd4c293b9f3300e4ad01955068aa335a2bca73
+  data.tar.gz: ae5677b7955e961a06f2e95927fb112474e02457ac506b8f84f16009518afad7
 SHA512:
-  metadata.gz: 345a3d341374f25b18ceed08ffd6ca770019e05b43c5391b716aec17ae3c63eb95af2287fa69e65a078feae930f2a6d4fc84be441b40143ead5df96e5a4d18cf
-  data.tar.gz: 54528657a0b66f92a36392f5dd768efd5137997ec8f1a1dc84d4174ec0982a320ca157000d594ff2a7cfa9fd186e100e5a221c2c50cba32e90f3101c74b155f4
+  metadata.gz: 73ab7f2528040eee3c65135adb3e5e2192705378741b3c3863c3d5d9ee1e34e4e9a617f577448eca2396919433e45db21488c5b39c893f1d774af071b5941578
+  data.tar.gz: 6f6013c5f538cd50c46a07ccb3b5facef447af48dc1891e924cd9cdaab47f8e2085d6b19dd2987e339cf3bc1ea94f516e3a920e3447c9909546543ab2986f93a

data/README.md

@@ -138,6 +138,24 @@ Resque::Failure::Multiple.classes = [InfluxReporter::Integration::Resque]
 Resque::Failure.backend = Resque::Failure::Multiple
 ```
 
+## Sending events to Influx
+
+You may want to send events instead of errors or performance traces to Influx. In this case, a method is provided:
+
+```ruby
+InfluxReporter.report_event 'event_name'
+```
+
+By default, the InfluxDB series name will be "events". You can change this with an extra parameter:
+```ruby
+InfluxReporter.report_event 'event_name', extra: { series: 'my_series' }
+```
+
+Adding tags & values is also possible:
+```ruby
+InfluxReporter.report_event 'event_name', extra: { tags: { key: 'tag' }, values: { key: 'value' } }
+```
+
 ## Manual profiling
 
 It's easy to add performance tracking wherever you want using the `InfluxReporter` module.

data/lib/influx_reporter.rb

@@ -123,6 +123,15 @@ module InfluxReporter
     client&.report_message message, opts
   end
 
+  # Send an event to InfluxReporter
+  #
+  # @param message [String]
+  # @param opts [Hash]
+  # @return [Net::HTTPResponse]
+  def self.report_event(message, opts = {})
+    client&.report_event message, opts
+  end
+
   # Captures any exceptions raised inside the block
   #
   def self.capture(&block)

data/lib/influx_reporter/client.rb

@@ -7,6 +7,7 @@ require 'influx_reporter/worker'
 require 'influx_reporter/transaction'
 require 'influx_reporter/trace'
 require 'influx_reporter/error_message'
+require 'influx_reporter/event_message'
 require 'influx_reporter/data_builders'
 
 module InfluxReporter
@@ -57,9 +58,10 @@ module InfluxReporter
       @influx_client = InfluxDBClient.new config
       @queue = Queue.new
 
-      @data_builders = Struct.new(:transactions, :error_message).new(
+      @data_builders = Struct.new(:transactions, :error_message, :event).new(
           DataBuilders::Transactions.new(config),
-          DataBuilders::Error.new(config)
+          DataBuilders::Error.new(config),
+          DataBuilders::Event.new(config)
       )
 
       unless config.disable_performance
@@ -227,6 +229,15 @@ module InfluxReporter
       enqueue Worker::PostRequest.new('/errors/', data)
     end
 
+    def report_event(message, opts = {})
+      ensure_worker_running
+
+      event = EventMessage.new(config, message, opts)
+      event.add_extra(@context) if @context
+      data = @data_builders.event.build event
+      enqueue Worker::PostRequest.new('/events/', data)
+    end
+
     def capture
       unless block_given?
         return Kernel.at_exit do

data/lib/influx_reporter/data_builders.rb

@@ -11,7 +11,7 @@ module InfluxReporter
       attr_reader :config
     end
 
-    %w[transactions error].each do |f|
+    %w[transactions error event].each do |f|
       require "influx_reporter/data_builders/#{f}"
     end
   end

data/lib/influx_reporter/data_builders/event.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module InfluxReporter
+  module DataBuilders
+    class Event < DataBuilder
+      # @param event [InfluxReporter::Event]
+      def build(event)
+        {
+            series: build_series_name(event),
+            values: build_values(event),
+            tags: build_tags(event),
+            timestamp: event.timestamp
+        }
+      end
+
+      private
+
+      # @param event [InfluxReporter::Event]
+      def build_series_name(event)
+        return event.extra[:series] if event.extra && event.extra[:series].is_a?(String)
+        'events'
+      end
+
+      # @param event [InfluxReporter::Event]
+      def build_tags(event)
+        tags = event.extra[:tags] if event.extra && event.extra[:tags].is_a?(Hash)
+        tags = event.config.tags.merge(tags || {})
+        tags.reject { |_, value| value.nil? || value == '' }
+      end
+
+      # @param event [InfluxReporter::Event]
+      def build_values(event)
+        values = {
+            message: event.message
+        }
+        values = event.extra[:values].merge(values) if event.extra && event.extra[:values].is_a?(Hash)
+
+        values.reject { |_, value| value.nil? }
+      end
+    end
+  end
+end

data/lib/influx_reporter/error_message.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/hash/deep_merge'
 require 'influx_reporter/line_cache'
 require 'influx_reporter/error_message/exception'
 require 'influx_reporter/error_message/stacktrace'
@@ -79,7 +80,7 @@ module InfluxReporter
 
     def add_extra(info)
       @extra ||= {}
-      @extra.merge! info
+      @extra.deep_merge! info
     end
   end
 end

data/lib/influx_reporter/event_message.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/deep_merge'
+require 'influx_reporter/util/timestamp'
+
+module InfluxReporter
+  class EventMessage
+    extend Logging
+
+    def initialize(config, message, attrs = {})
+      @config = config
+
+      @message = message
+      @timestamp = Util.nanos
+
+      attrs.each do |k, v|
+        send(:"#{k}=", v)
+      end
+
+      yield self if block_given?
+    end
+
+    attr_reader :config
+    attr_accessor :message
+    attr_reader :timestamp
+    attr_accessor :extra
+
+    def add_extra(info)
+      @extra ||= {}
+      @extra.deep_merge! info
+    end
+  end
+end

data/lib/influx_reporter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InfluxReporter
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/influx_reporter/data_builders/event_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module InfluxReporter
+  module DataBuilders
+    RSpec.describe Event do
+      let(:config) { Configuration.new }
+
+      subject do
+        Event.new config
+      end
+
+      describe '#build' do
+        it 'builds an event message dict from an event' do
+          event_message = InfluxReporter::EventMessage.new(config, 'Event', extra: { tags: { key: 'tag' }, values: { key: 'value' } })
+          example = {
+              series: 'events',
+              values: {
+                  message: 'Event',
+                  key: 'value'
+              },
+              tags: {
+                  key: 'tag'
+              },
+              timestamp: an_instance_of(Integer)
+          }
+          expect(subject.build(event_message)).to match(example)
+        end
+
+        it 'builds an event message dict from an event with a custom series name' do
+          event_message = InfluxReporter::EventMessage.new(config, 'Event', extra: { series: 'test' })
+          example = {
+              series: 'test',
+              values: {
+                  message: 'Event'
+              },
+              tags: {},
+              timestamp: an_instance_of(Integer)
+          }
+          expect(subject.build(event_message)).to match(example)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influx_reporter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kacper Kawecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,6 +84,7 @@ files:
 - lib/influx_reporter/configuration.rb
 - lib/influx_reporter/data_builders.rb
 - lib/influx_reporter/data_builders/error.rb
+- lib/influx_reporter/data_builders/event.rb
 - lib/influx_reporter/data_builders/transactions.rb
 - lib/influx_reporter/error.rb
 - lib/influx_reporter/error_message.rb
@@ -91,6 +92,7 @@ files:
 - lib/influx_reporter/error_message/http.rb
 - lib/influx_reporter/error_message/stacktrace.rb
 - lib/influx_reporter/error_message/user.rb
+- lib/influx_reporter/event_message.rb
 - lib/influx_reporter/filter.rb
 - lib/influx_reporter/http_client.rb
 - lib/influx_reporter/influx_db_client.rb
@@ -127,6 +129,7 @@ files:
 - spec/influx_reporter/client_spec.rb
 - spec/influx_reporter/configuration_spec.rb
 - spec/influx_reporter/data_builders/error_spec.rb
+- spec/influx_reporter/data_builders/event_spec.rb
 - spec/influx_reporter/data_builders/transactions_spec.rb
 - spec/influx_reporter/error_message/exception_spec.rb
 - spec/influx_reporter/error_message/http_spec.rb
@@ -181,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Metrics collector for rails and InfluxDB based on Opbeat Ruby client library