binnacle 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac88903228fc74fc1b88017ad2b8a5c61432bb5d
-  data.tar.gz: 5faf3822abed8fe7e29efc915821fd376015476f
+  metadata.gz: 957b5284e87ffafca6a136ed720f5b7fc95cf095
+  data.tar.gz: 78b6d5c88873e108f166a13b2d8b001ded78c98d
 SHA512:
-  metadata.gz: e1fdc27769de722bf9f258b42aadca2cf4ce4497a01a7caa156b067ddc890f7ce1f0e2e556dbf90ea2d72e87614fd6e53d39e43a7a7965ba751ce76efd33ffc8
-  data.tar.gz: f06922bca53b26e5e60b27b923665d6a1a517036f8ec0fedb353b424c461c0adc28cba825c74b459dbad2beb3ef781f171b2d2d20c1e642e83e9977d960638e2
+  metadata.gz: 652ce111e80447a30de76e235bc54626908cb9a25d2bab117d9360643ed045b301a416e91206793c30ff47744e78911e9bf1141c7242b6b6c2386225238e6509
+  data.tar.gz: 56720fc4a5ce64a7966472b6703d0a03714215fdab8253f232b63c6b8d640a418b1b257ac61ca15dc98f9a8cfea26a480f9a701bf91352b01e283a018f0634a2

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 source 'https://rails-assets.org'
 
 source 'https://rails-assets.org' do
-  gem 'rails-assets-binnacle', '>= 0.2.5'
+  gem 'rails-assets-binnacle', '>= 0.2.6'
 end
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    binnacle (0.4.8)
+    binnacle (0.4.9)
       addressable (~> 2.5)
       colorize (~> 0.8.1)
       faraday (~> 0.11)
@@ -29,37 +29,37 @@ GEM
     ethon (0.10.1)
       ffi (>= 1.3.0)
     eventmachine (1.2.3)
-    excon (0.55.0)
-    faraday (0.12.0.1)
+    excon (0.57.1)
+    faraday (0.12.1)
       multipart-post (>= 1.2, < 3)
     faye-websocket (0.10.7)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     ffi (1.9.18)
-    fivemat (1.3.3)
-    hashdiff (0.3.2)
-    http (2.2.1)
+    fivemat (1.3.5)
+    hashdiff (0.3.4)
+    http (2.2.2)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 1.0.1)
       http_parser.rb (~> 0.6.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (1.0.1)
+    http-form_data (1.0.3)
     http_parser.rb (0.6.0)
-    httparty (0.14.0)
+    httparty (0.15.5)
       multi_xml (>= 0.5.2)
     httpclient (2.8.3)
-    json (2.0.4)
+    json (2.1.0)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
     patron (0.8.0)
     public_suffix (2.0.5)
-    rack (2.0.1)
+    rack (2.0.3)
     rack-timeout (0.4.2)
     rails-assets-atmosphere (2.3.2)
     rails-assets-base64 (1.0.0)
-    rails-assets-binnacle (0.2.5)
+    rails-assets-binnacle (0.2.6)
       rails-assets-atmosphere (= 2.3.2)
       rails-assets-base64 (= 1.0.0)
       rails-assets-firebase (= 3.7.1)
@@ -67,21 +67,21 @@ GEM
     rails-assets-firebase (3.7.1)
     rails-assets-moment (2.18.0)
     rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
     rspec-collection_matchers (1.1.3)
       rspec-expectations (>= 2.99.0.beta1)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     rspec-wait (0.0.9)
       rspec (>= 3, < 4)
     safe_yaml (1.0.4)
@@ -89,8 +89,8 @@ GEM
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    thin (1.7.0)
+    simplecov-html (0.10.1)
+    thin (1.7.1)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
@@ -99,7 +99,7 @@ GEM
       ethon (>= 0.9.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.3)
+    unf_ext (0.0.7.4)
     vcr (3.0.3)
     webmock (2.3.2)
       addressable (>= 2.3.6)
@@ -123,7 +123,7 @@ DEPENDENCIES
   httparty (~> 0.14)
   patron (~> 0.8)
   rack (~> 2.0)
-  rails-assets-binnacle (>= 0.2.5)!
+  rails-assets-binnacle (>= 0.2.6)!
   rake (~> 10.5)
   rspec (~> 3.5, >= 3.2.0)
   rspec-collection_matchers (~> 1.1, >= 1.1.2)

data/lib/binnacle/client.rb

@@ -29,15 +29,19 @@ module Binnacle
       @formatter = Binnacle::Logging::Formatter.new(self)
     end
 
-    def signal(channel_id, event_name, client_id, session_id, log_level, tags = [], json = {}, asynch = false)
+    def signal(channel_id, event_name, client_id, session_id, log_level, environment = Event.rails_env, tags = [], json = {}, asynch = false)
       event = Binnacle::Event.new()
-      event.configure(channel_id, event_name, client_id, session_id, log_level, nil, tags, json)
+      event.configure(channel_id, event_name, client_id, session_id, log_level, environment, nil, tags, json)
       event.connection = connection
       asynch ? event.post_asynch : event.post
     end
 
-    def signal_asynch(channel_id, event_name, client_id = '', session_id = '', log_level = 'INFO', tags = [], json = {})
-      signal(channel_id, event_name, client_id, session_id, log_level, tags, json, true)
+    def signal_asynch(channel_id, event_name, client_id = '', session_id = '', log_level = 'INFO', environment = Event.rails_env, tags = [], json = {})
+      signal(channel_id, event_name, client_id, session_id, log_level, environment, tags, json, true)
+    end
+
+    def broadcast(channel_id, event_name, json)
+      signal(channel_id, event_name, "", "", 'CABLE', nil, [], json, true)
     end
 
     def recents(lines, since, channel)
@@ -82,7 +86,7 @@ module Binnacle
       event_name = %[#{data[:method]} #{data[:path]}]
 
       event = Binnacle::Event.new()
-      event.configure(logging_channel_id, event_name, client_id, session_id, 'log', data[:time], [], data)
+      event.configure(logging_channel_id, event_name, client_id, session_id, 'log', nil, data[:time], [], data)
       write(event)
     end
 
@@ -91,7 +95,7 @@ module Binnacle
       event_name = %[#{data[:method]} #{data[:url]}]
 
       event = Binnacle::Event.new()
-      event.configure(logging_channel_id, event_name, client_id, session_id, 'log', data[:time], [], data)
+      event.configure(logging_channel_id, event_name, client_id, session_id, 'log', nil, data[:time], [], data)
       write(event)
     end
 

data/lib/binnacle/commands/tail.rb

@@ -22,6 +22,8 @@ module Binnacle::Commands
       opt(:lines, "Get the last n events on the Channel", type: :int, short: '-n')
       opt(:since, "Number of minutes in the past to search for events", type: :int)
       opt(:encrypted, "Use SSL/HTTPS", default: true)
+      opt(:environment, "The target environment (Rails.env)", type: :string, default: 'production')
+      opt(:payload, "Show JSON Payload", default: false)
     end
 
     if (errors = validate(opts)).empty?
@@ -48,23 +50,23 @@ module Binnacle::Commands
   def self.dispatch(opts)
     # tail --follow
     if opts[:follow_given] && opts[:app_given]
-      monitor(opts[:host], opts[:api_key], opts[:api_secret], opts[:app], true, opts[:encrypted])
+      monitor(opts[:host], opts[:api_key], opts[:api_secret], opts[:app], opts[:environment], true, opts[:encrypted], opts[:payload])
     elsif opts[:follow_given] && opts[:channel_given]
-      monitor(opts[:host], opts[:api_key], opts[:api_secret], opts[:channel], false, opts[:encrypted])
+      monitor(opts[:host], opts[:api_key], opts[:api_secret], opts[:channel], opts[:environment], false, opts[:encrypted], opts[:payload])
     end
 
     # tail --lines
-    lines(opts[:host], opts[:api_key], opts[:api_secret], opts[:channel], opts[:lines], opts[:since], opts[:encrypted_given] ? opts[:encrypted] : false) if opts[:lines_given]
+    lines(opts[:host], opts[:api_key], opts[:api_secret], opts[:channel], opts[:lines], opts[:since], opts[:environment], opts[:encrypted]) if opts[:lines_given]
   end
 
   #
   # tail --follow --host=my_host --channel=my_channel
-  def self.monitor(host, api_key, api_secret, channel, is_app = false, encrypted = true)
+  def self.monitor(host, api_key, api_secret, channel, environment, is_app = false, encrypted = true, payload = false)
     EM.run do
       Signal.trap("INT")  { EventMachine.stop }
       Signal.trap("TERM") { EventMachine.stop }
 
-      ws_url = build_ws_url(host, api_key, api_secret, channel, is_app, encrypted)
+      ws_url = build_ws_url(host, api_key, api_secret, channel, environment, is_app, encrypted)
       ws = Faye::WebSocket::Client.new(ws_url)
 
       ws.on :open do |event|
@@ -73,7 +75,7 @@ module Binnacle::Commands
 
       ws.on :message do |event|
         if event.data !~ /\s/ && event.data != 'X'
-          print_event_from_json(event.data)
+          print_event_from_json(event.data, payload)
         end
       end
 
@@ -85,24 +87,24 @@ module Binnacle::Commands
 
   #
   # tail --lines=50 --since=10 --host=my_host --channel=my_channel
-  def self.lines(host, api_key, api_secret, channel, lines, since, encrypted = true)
+  def self.lines(host, api_key, api_secret, channel, lines, since, environment = 'production', encrypted = true, payload = false)
     puts "Retrieving last #{lines} lines since #{since} minutes ago from Channel #{channel} ..."
     Binnacle.configuration.encrypted = encrypted
     client = Binnacle::Client.new(api_key, api_secret, host)
 
     client.recents(lines, since, channel).each do |e|
-      print_event(e)
+      print_event(e, payload)
     end
   end
 
   protected
 
-  def self.build_ws_url(host, api_key, api_secret, channel, is_app = false, encrypted = true)
+  def self.build_ws_url(host, api_key, api_secret, channel, environment, is_app = false, encrypted = Binnacle.configuration.encrypted)
     Addressable::URI.new(
       host: host,
       port: Binnacle::Configuration::DEFAULT_PORT,
       scheme: encrypted ? 'wss' : 'ws',
-      path: ["/api/subscribe", is_app ? "app" : "channel", channel].join("/"),
+      path: ["/api/subscribe", is_app ? "app" : "channel", channel, environment].join("/"),
       query: build_ws_query(api_key, api_secret)
     ).to_s
   end
@@ -118,7 +120,7 @@ module Binnacle::Commands
     }.map { |n,v| "#{n}=#{v}" }.join("&")
   end
 
-  def self.print_event(event)
+  def self.print_event(event, payload = false)
     message = ""
 
     level = '%-10.10s' % event.log_level
@@ -138,7 +140,9 @@ module Binnacle::Commands
       level.colorize(:blue)
     end.colorize(mode: :bold)
 
-    message << "#{level} [#{Time.at(event.event_time)}] "
+    env = event.environment.colorize(mode: :bold)
+
+    message << "#{env}::#{level} [#{Time.at(event.event_time)}] "
 
     message << ('%-10.10s' % event.event_name).colorize(color: :green, mode: :bold)
 
@@ -158,19 +162,23 @@ module Binnacle::Commands
 
     unless event.tags.empty?
       tags = event.tags.join(',')
-      rest << "#{'tags'.colorize(mode: :bold)} = [#{event.tags}]"
+      rest << "#{'tags'.colorize(mode: :bold)} = [#{tags}]"
     end
 
     message << " :: ".colorize(mode: :bold) + rest.join(", ") unless rest.empty?
 
+    if payload && event.json
+      message << "\n\t ==> #{event.json}"
+    end
+
     puts message
   end
 
-  def self.print_event_from_json(json)
+  def self.print_event_from_json(json, payload = false)
     begin
       data = JSON.parse(json)
       event = Binnacle::Event.from_hash(data)
-      print_event(event)
+      print_event(event, payload)
     rescue JSON::ParserError => jpe
       # do nothing!
     end

data/lib/binnacle/logging/formatter.rb

@@ -14,15 +14,14 @@ module Binnacle
           event = Binnacle::Event.new()
 
           logging_tags = current_tags.dup
-
           if progname
-            event.configure_from_logging_progname(progname, @client.logging_channel_id, client_id, session_id, severity, datetime, [], { message: msg })
+            event.configure_from_logging_progname(progname, @client.logging_channel_id, client_id, session_id, severity, nil, datetime, [], { message: msg })
           elsif defined?(ActiveSupport::TaggedLogging) && logging_tags && !logging_tags.empty? && logging_tags.size > 2
             logging_tags.shift(2)
             event_name = logging_tags.shift
-            event.configure_from_logging_progname(event_name, @client.logging_channel_id, client_id, session_id, severity, datetime, logging_tags, { message: msg })
+            event.configure_from_logging_progname(event_name, @client.logging_channel_id, client_id, session_id, severity, nil, datetime, logging_tags, { message: msg })
           else
-            event.configure(@client.logging_channel_id, 'log', client_id, session_id, severity, datetime, [], { message: msg })
+            event.configure(@client.logging_channel_id, 'log', client_id, session_id, severity, nil, datetime, [], { message: msg })
           end
 
           event

data/lib/binnacle/resources/event.rb

@@ -11,8 +11,9 @@ module Binnacle
     attr_accessor :tags
     attr_accessor :json
     attr_accessor :event_time
+    attr_accessor :environment
 
-    def configure(channel_id, event_name, client_id, session_id, log_level, ts = Time.now, tags = [], json = {})
+    def configure(channel_id, event_name, client_id, session_id, log_level, environment = Event.rails_env, ts = Time.now, tags = [], json = {})
       self.channel_id = channel_id
       self.event_name = event_name
       self.client_id = client_id
@@ -21,9 +22,10 @@ module Binnacle
       self.log_level = log_level
       self.tags = tags
       self.json = json
+      self.environment = environment || Event.rails_env
     end
 
-    def configure_from_logging_progname(progname, channel_id, client_id, session_id, log_level, ts = Time.now, tags = [], json = {})
+    def configure_from_logging_progname(progname, channel_id, client_id, session_id, log_level, environment =  Event.rails_env, ts = Time.now, tags = [], json = {})
       if progname.is_a?(Hash)
         self.client_id = progname[:client_id] || client_id
         self.session_id = progname[:session_id] || session_id
@@ -32,6 +34,7 @@ module Binnacle
         self.tags = progname[:tags] || tags
         self.json = json
         self.json.merge!(progname[:json]) if progname[:json]
+        self.environment = environment || Event.rails_env
       elsif progname.is_a?(String)
         self.client_id = client_id
         self.session_id = session_id
@@ -39,10 +42,12 @@ module Binnacle
         self.event_name = progname
         self.tags = tags
         self.json = json
+        self.environment = environment || Event.rails_env
       end
 
       self.timestamp = ts ? ts : Time.now
       self.log_level = log_level
+      self.environment = environment || Event.rails_env
     end
 
     def timestamp=(ts)
@@ -60,6 +65,7 @@ module Binnacle
       event.event_time = Time.at(h['eventTime']/1000)
       event.tags = h['tags']
       event.json = h['json']
+      event.environment = h['environment']
 
       event
     end
@@ -73,6 +79,7 @@ module Binnacle
         "clientId" => client_id,
         "logLevel" => log_level,
         "tags" => tags,
+        "environment" => environment,
         "json" => json
       }.to_json
     end
@@ -85,16 +92,22 @@ module Binnacle
       "/api/events/#{channel}"
     end
 
-    def self.recents(connection, lines, since, channel)
-      path = [route(channel), 'recents'].compact.join('/')
+    def self.recents(connection, lines, since, channel, environment = rails_env)
+      path = [route(channel), environment, 'recents'].compact.join('/')
 
       get(connection, path, {'limit' => lines, 'since' => since})
     end
 
-    def self.events(connection, channel, date, start_hour, end_hour, lines)
-      path = [route(channel), date].compact.join('/')
+    def self.events(connection, channel, date, start_hour, end_hour, lines, environment = rails_env)
+      path = [route(channel), environment, date].compact.join('/')
 
       get(connection, path, {'start_hour' => start_hour, 'end_hour' => end_hour, 'limit' => lines})
     end
+
+    protected
+
+    def self.rails_env
+      defined?(Rails) ? Rails.env : "production"
+    end
   end
 end

data/lib/binnacle/trap/exception_event.rb

@@ -59,7 +59,9 @@ module Binnacle
       private
 
       def unwrap_exception(exception)
-        if exception.respond_to?(:original_exception)
+        if exception.respond_to?(:cause)
+          exception.cause
+        elsif exception.respond_to?(:original_exception)
           exception.original_exception
         elsif exception.respond_to?(:continued_exception)
           exception.continued_exception
@@ -122,10 +124,6 @@ module Binnacle
         'UNKNOWN'
       end
 
-      def extract_rails_environment_level
-        defined?(Rails) ? Rails.env : "UNKNOWN"
-      end
-
       def extract_libraries_loaded
         libraries = {}
         begin
@@ -157,7 +155,7 @@ module Binnacle
           message: @exception.message,
           component: @component,
           method: @method,
-          environment_level: extract_rails_environment_level,
+          environment_level: Event.rails_env,
           hostname: extract_hostname,
           user_agent: @request.user_agent,
           ruby_version: extract_ruby_version,

data/lib/binnacle/version.rb

@@ -1,3 +1,3 @@
 module Binnacle
-  VERSION = "0.4.8"
+  VERSION = "0.4.9"
 end

data/spec/client_spec.rb

@@ -1,12 +1,17 @@
 require 'spec_helper'
 
 describe Binnacle::Client do
-  before { reset_env }
+  before do 
+    reset_env 
+    Binnacle.configure do |config|
+      config.encrypted = false
+    end
+  end
   let(:client) { Binnacle::Client.new('vceth4xcwqfoowpz2esi', '1grttyb8ozbe9axt88ji', 'localhost') }
 
   describe 'signal' do
     it 'invokes the events api signal', :vcr do
-      client.signal('icoc0tnol3obe8pas207', 'TEST_EVT', 'binnacle-rb', 'My Sess', 'INFO')
+      client.signal('icoc0tnol3obe8pas207', 'TEST_EVT', 'binnacle-rb', 'My Sess', 'INFO', 'development')
 
       expect(a_request(:get, 'http://localhost:8080/api/endpoints'))
       expect(
@@ -67,62 +72,31 @@ describe Binnacle::Client do
     it 'invokes the events api recents', :vcr do
       expect(a_request(:get, 'http://localhost:8080/api/endpoints'))
       expect(
-        a_request(:get, "http://localhost:8080/api/events/icoc0tnol3obe8pas207/recents?limit=10&since=500")
+        a_request(:get, "http://localhost:8080/api/events/icoc0tnol3obe8pas207/production/recents?limit=10&since=500")
       ).to(have_been_made.times(1))
     end
 
     it 'returns a collection of event objects', :vcr do
-      expect(@recents).to have(10).events
+      expect(@recents).to have(1).events
     end
   end
 
   describe 'events' do
-    before { @events = client.events('icoc0tnol3obe8pas207', '2015-12-29', 8, 9, 500) }
+    before { 
+      @events = client.events('icoc0tnol3obe8pas207', '2017-07-06', 11, 12, 500) 
+    }
 
     it 'invokes the events api', :vcr do
       expect(a_request(:get, 'http://localhost:8080/api/endpoints'))
       expect(
-        a_request(:get, "http://localhost:8080/api/events/icoc0tnol3obe8pas207/2015-12-29?end_hour=9&limit=500&start_hour=8")
+        a_request(:get, "http://localhost:8080/api/events/icoc0tnol3obe8pas207/production/2017-07-06?end_hour=12&limit=500&start_hour=11")
       ).to(have_been_made.times(1))
     end
 
     it 'returns a collection of event objects', :vcr do
-      expect(@events).to have(40).events
-      expect(@events).to all(satisfy { |e| e.event_time.strftime("%Y-%m-%d") == '2015-12-29' })
+      expect(@events).to have(1).events
+      expect(@events).to all(satisfy { |e| e.event_time.strftime("%Y-%m-%d") == '2017-07-06' })
     end
 
   end
-
-  describe 'report_exception' do
-    before { Binnacle.binnacle_logger.pause }
-    after  { Binnacle.binnacle_logger.continue }
-
-    it 'invokes the events api signal', :vcr do
-
-      Binnacle.configure do |config|
-        config.error_channel = 'id0czm8eryfffcgp875c'
-        config.encrypted = false
-      end
-
-      exception = ZeroDivisionError.new
-      env = Rack::MockRequest.env_for(client.connection.active_url)
-      client.report_exception(exception, env, false)
-
-      expect(a_request(:get, 'http://localhost:8080/api/endpoints'))
-      expect(
-        a_request(:post, "http://localhost:8080/api/events/id0czm8eryfffcgp875c").
-        with(body: hash_including({
-          "channelId": "id0czm8eryfffcgp875c",
-          "eventName":"ZeroDivisionError",
-          "logLevel":"EXCEPTION"
-        }))
-      ).to(have_been_made.times(1))
-
-      # TODO: need a way to check nested partial hash in the body for:
-      # "json": hash_including({
-      #   "exception":"ZeroDivisionError",
-      #   "message":"ZeroDivisionError"
-      # })
-    end
-  end
 end