application_insights 0.2.0 → 0.3.0

data/lib/application_insights/unhandled_exception.rb

@@ -0,0 +1,48 @@
+require_relative 'telemetry_client'
+require_relative 'channel/telemetry_channel'
+require_relative 'channel/synchronous_queue'
+require_relative 'channel/synchronous_sender'
+
+include ApplicationInsights
+
+module ApplicationInsights
+  module UnhandledException
+    @sender = nil
+
+    # Auto collects unhandled exception and send to the Application Insights service.
+    # @param (string) instrumentation_key used to identify which Application Insights application this data is for.
+    # @example
+    #   require 'application_insights'
+    #   ApplicationInsights::UnhandledException.collect('<YOUR INSTRUMENTATION KEY GOES HERE>')
+    #   raise Exception, 'Boom!'
+    def self.collect(instrumentation_key)
+      at_exit do
+        # Avoid sending exception more than once if this method got invoked multiple times
+        send(instrumentation_key) if !@sender
+      end
+    end
+
+    # @api private
+    # Send the last raised exception to the Application Insights service if telemetry_sender is not customized.
+    # @param (string) instrumentation_key used to identify which Application Insights application this data is for.
+    # @param (SenderBase) telemetry_sender used to send the last raised exception.
+    def self.send(instrumentation_key, telemetry_sender = nil)
+      if $! && !$!.is_a?(SystemExit) && !$!.is_a?(SignalException)
+        if telemetry_sender
+          @sender = telemetry_sender
+        elsif !@sender
+          # Use a synchronized sender to guarantee the data would be sent out once flush
+          @sender = Channel::SynchronousSender.new
+        end
+
+        queue = Channel::SynchronousQueue.new @sender
+        channel = Channel::TelemetryChannel.new nil, queue
+        client = TelemetryClient.new channel
+        client.context.instrumentation_key = instrumentation_key
+        client.track_exception($!, {:handled_at => 'Unhandled'})
+        client.flush
+      end
+    end
+
+  end
+end

data/lib/application_insights/version.rb

@@ -1,3 +1,3 @@
 module ApplicationInsights
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/test/application_insights/channel/test_asynchronous_queue.rb

@@ -0,0 +1,68 @@
+require_relative '../../../lib/application_insights/channel/sender_base'
+require_relative '../../../lib/application_insights/channel/asynchronous_queue'
+require 'test/unit'
+
+include ApplicationInsights::Channel
+
+class TestAsynchronousQueue < Test::Unit::TestCase
+  def test_initialize
+    queue = AsynchronousQueue.new MockAsynchronousSender.new
+    assert_not_nil queue.flush_notification
+  end
+
+  def test_flush_notification_works_as_expected
+    queue = AsynchronousQueue.new MockAsynchronousSender.new
+    assert_not_nil queue.flush_notification
+    result = queue.flush_notification.wait 1
+    assert_equal false, result
+    queue.flush_notification.set
+    result = queue.flush_notification.wait
+    assert_equal true, result
+    queue.flush_notification.clear
+    result = queue.flush_notification.wait 1
+    assert_equal false, result
+  end
+
+  def test_push_works_As_expected
+    sender = MockAsynchronousSender.new
+    queue = AsynchronousQueue.new sender
+    queue.push 42
+    assert_equal 1, sender.start_call_count
+    assert_equal 42, queue.pop
+    assert_nil queue.pop
+  end
+
+  def test_flush_works_as_expected
+    sender = MockAsynchronousSender.new
+    queue = AsynchronousQueue.new sender
+    assert_not_nil queue.flush_notification
+    result = queue.flush_notification.wait 1
+    assert_equal false, result
+    queue.flush
+    assert_equal 1, sender.start_call_count
+    result = queue.flush_notification.wait
+    assert_equal true, result
+  end
+end
+
+class MockAsynchronousSender
+  def initialize
+    @send_buffer_size = 2
+    @data = []
+    @queue = nil
+    @start_call_count = 0
+  end
+
+  attr_accessor :start_call_count
+  attr_accessor :send_buffer_size
+  attr_accessor :data
+  attr_accessor :queue
+
+  def start
+    @start_call_count += 1
+  end
+
+  def send(data_to_send)
+    @data.push data_to_send
+  end
+end

data/test/application_insights/channel/test_asynchronous_sender.rb

@@ -0,0 +1,81 @@
+require_relative '../../../lib/application_insights/channel/sender_base'
+require_relative '../../../lib/application_insights/channel/asynchronous_sender'
+require_relative '../../../lib/application_insights/channel/asynchronous_queue'
+require 'test/unit'
+
+include ApplicationInsights::Channel
+
+class TestAsynchronousSender < Test::Unit::TestCase
+  def test_initialize
+    sender = AsynchronousSender.new
+    assert_equal 'https://dc.services.visualstudio.com/v2/track', sender.service_endpoint_uri
+    assert_equal 1.0, sender.send_interval
+    assert_equal 3.0, sender.send_time
+  end
+
+  def test_send_interval_works_as_expected
+    sender = AsynchronousSender.new
+    assert_equal 1.0, sender.send_interval
+    sender.send_interval = 10.0
+    assert_equal 10.0, sender.send_interval
+  end
+
+  def test_send_time_works_as_expected
+    sender = AsynchronousSender.new
+    assert_equal 3.0, sender.send_time
+    sender.send_time = 10.0
+    assert_equal 10.0, sender.send_time
+  end
+
+  def test_work_thread_works_as_expected
+    sender = InterceptableAsynchronousSender.new
+    assert_nil sender.work_thread
+    sender.send_interval = 1.0
+    sender.send_time = 3.0
+    queue = AsynchronousQueue.new sender
+    sender.invoke_base_start = true
+    queue.push 1
+    assert_not_nil sender.work_thread
+    sleep 3.0
+    assert_nil sender.work_thread
+  end
+
+  def test_start
+    sender = InterceptableAsynchronousSender.new
+    sender.send_interval = 1.0
+    sender.send_time = 3.0
+    queue = AsynchronousQueue.new sender
+    sender.invoke_base_start = false
+    queue.push 1
+    queue.push 2
+    sender.invoke_base_start = true
+    sender.start
+    sleep 2.0
+    queue.push 3
+    sleep 5.0
+    data = sender.data_to_send
+    assert_equal [[1, 2], [3]], data
+  end
+
+end
+
+class InterceptableAsynchronousSender < AsynchronousSender
+  def initialize
+    @data_to_send = []
+    @invoke_base_start = false
+    super
+  end
+
+  attr_accessor :invoke_base_start
+  attr_accessor :data_to_send
+
+  def start
+    if invoke_base_start
+      super
+    end
+  end
+
+  def send(data_to_send)
+    @data_to_send.push data_to_send
+  end
+end

data/test/application_insights/channel/test_event.rb

@@ -0,0 +1,53 @@
+require_relative '../../../lib/application_insights/channel/sender_base'
+require_relative '../../../lib/application_insights/channel/asynchronous_queue'
+require 'thread'
+require 'test/unit'
+
+include ApplicationInsights::Channel
+
+class TestEvent < Test::Unit::TestCase
+  def test_initialize
+    event = Event.new
+    assert_equal false, event.signal
+  end
+
+  def test_set_works_as_expected
+    event = Event.new
+    assert_equal false, event.signal
+    Thread.new do
+      sleep 1
+      event.set
+    end
+    result = event.wait 2.0
+    assert_equal true, result
+  end
+
+  def test_clear_works_as_expected
+    event = Event.new
+    assert_equal false, event.signal
+    event.set
+    assert_equal true, event.signal
+    event.clear
+    assert_equal false, event.signal
+  end
+
+  def test_wait_works_as_expected
+    event1 = Event.new
+    assert_equal false, event1.signal
+    Thread.new do
+      sleep 1
+      event1.set
+    end
+    result = event1.wait 0.5
+    assert_equal false, result
+
+    event2 = Event.new
+    assert_equal false, event1.signal
+    Thread.new do
+      sleep 1
+      event2.set
+    end
+    result = event2.wait 2.0
+    assert_equal true, result
+  end
+end

data/test/application_insights/channel/test_queue_base.rb

@@ -5,15 +5,6 @@ require 'test/unit'
 include ApplicationInsights::Channel
 
 class TestQueueBase < Test::Unit::TestCase
-  def test_initialize_raises_exception_when_sender_is_nil
-    begin
-      QueueBase.new nil
-      assert false
-    rescue ArgumentError => e
-      assert_equal 'Sender was required but not provided', e.message
-    end
-  end
-
   def test_initialize
     sender = SenderBase.new 'http://tempuri.org'
     item = QueueBase.new sender
@@ -72,6 +63,16 @@ class TestQueueBase < Test::Unit::TestCase
       assert_equal i, item.pop
     end
   end
+
+  def test_empty_works_as_expected
+    sender = SenderBase.new 'http://tempuri.org'
+    queue = QueueBase.new sender
+    assert_equal true, queue.empty?
+    queue.push 1
+    assert_equal false, queue.empty?
+    queue.pop
+    assert_equal true, queue.empty?
+  end
 end
 
 class MockQueueBase < QueueBase

data/test/application_insights/channel/test_sender_base.rb

@@ -7,15 +7,6 @@ require 'thread'
 include ApplicationInsights::Channel
 
 class TestSenderBase < Test::Unit::TestCase
-  def test_initialize_raises_exception_when_service_endpoint_uri_is_nil
-    begin
-      SenderBase.new nil
-      assert false
-    rescue ArgumentError => e
-      assert_equal 'Service endpoint URI was required but not provided', e.message
-    end
-  end
-
   def test_initialize
     sender = SenderBase.new 'http://tempuri.org'
     assert_equal 'http://tempuri.org', sender.service_endpoint_uri

data/test/application_insights/test_telemetry_client.rb

@@ -48,8 +48,13 @@ class TestTelemetryClient < Test::Unit::TestCase
     end
     client.flush
     expected = '[{"ver":1,"name":"Microsoft.ApplicationInsights.Exception","time":"TIME_PLACEHOLDER","sampleRate":100.0,"tags":{"ai.internal.sdkVersion":"rb:0.1.0"},"data":{"baseType":"ExceptionData","baseData":{"ver":2,"handledAt":"UserCode","exceptions":[{"id":1,"outerId":0,"typeName":"ArgumentError","message":"Some error","hasFullStack":true,"stack":"STACK_PLACEHOLDER"}]}}}]'
+    assert_equal 'UserCode', sender.data_to_send[0].data.base_data.handled_at
+    assert_operator sender.data_to_send[0].data.base_data.exceptions[0].parsed_stack.count, :>, 0
+    assert_equal 'test_track_exception_works_as_expected', sender.data_to_send[0].data.base_data.exceptions[0].parsed_stack[0].method
+    assert_equal __FILE__, sender.data_to_send[0].data.base_data.exceptions[0].parsed_stack[0].file_name
     sender.data_to_send[0].time = 'TIME_PLACEHOLDER'
     sender.data_to_send[0].data.base_data.exceptions[0].stack = 'STACK_PLACEHOLDER'
+    sender.data_to_send[0].data.base_data.exceptions[0].parsed_stack = []
     actual = sender.data_to_send.to_json
     assert_equal expected, actual
   end

data/test/application_insights/test_unhandled_exception.rb

@@ -0,0 +1,42 @@
+require 'test/unit'
+require_relative '../../lib/application_insights/unhandled_exception'
+
+include ApplicationInsights
+
+class TestUnhandledException < Test::Unit::TestCase
+
+  def test_send
+    sender = MockSender.new
+    error = 'Boom!'
+    instrumentation_key = 'one'
+    begin
+      raise StandardError, error
+    rescue
+      UnhandledException.send instrumentation_key, sender
+    end
+
+    assert_equal 1, sender.buffer.count
+    payload = sender.buffer[0]
+    assert_equal instrumentation_key, payload[0].i_key
+    assert_equal 'Unhandled', payload[0].data.base_data.handled_at
+  end
+end
+
+class MockSender
+  def initialize
+    @buffer = []
+    @queue = nil
+    @send_buffer_size = 100
+  end
+
+  attr_accessor :buffer
+  attr_accessor :queue
+  attr_accessor :send_buffer_size
+
+  def send(data)
+    @buffer << data
+  end
+
+  def flush
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: application_insights
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Microsoft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.2
 description: This project extends the Application Insights API surface to support
   Ruby.
 email:
@@ -53,6 +81,8 @@ files:
 - Rakefile
 - application_insights.gemspec
 - lib/application_insights.rb
+- lib/application_insights/channel/asynchronous_queue.rb
+- lib/application_insights/channel/asynchronous_sender.rb
 - lib/application_insights/channel/contracts/application.rb
 - lib/application_insights/channel/contracts/data.rb
 - lib/application_insights/channel/contracts/data_point.rb
@@ -77,6 +107,7 @@ files:
 - lib/application_insights/channel/contracts/severity_level.rb
 - lib/application_insights/channel/contracts/stack_frame.rb
 - lib/application_insights/channel/contracts/user.rb
+- lib/application_insights/channel/event.rb
 - lib/application_insights/channel/queue_base.rb
 - lib/application_insights/channel/sender_base.rb
 - lib/application_insights/channel/synchronous_queue.rb
@@ -84,6 +115,7 @@ files:
 - lib/application_insights/channel/telemetry_channel.rb
 - lib/application_insights/channel/telemetry_context.rb
 - lib/application_insights/telemetry_client.rb
+- lib/application_insights/unhandled_exception.rb
 - lib/application_insights/version.rb
 - test/application_insights.rb
 - test/application_insights/channel/contracts/test_application.rb
@@ -105,6 +137,9 @@ files:
 - test/application_insights/channel/contracts/test_session.rb
 - test/application_insights/channel/contracts/test_stack_frame.rb
 - test/application_insights/channel/contracts/test_user.rb
+- test/application_insights/channel/test_asynchronous_queue.rb
+- test/application_insights/channel/test_asynchronous_sender.rb
+- test/application_insights/channel/test_event.rb
 - test/application_insights/channel/test_queue_base.rb
 - test/application_insights/channel/test_sender_base.rb
 - test/application_insights/channel/test_synchronous_queue.rb
@@ -112,6 +147,7 @@ files:
 - test/application_insights/channel/test_telemetry_channel.rb
 - test/application_insights/channel/test_telemetry_context.rb
 - test/application_insights/test_telemetry_client.rb
+- test/application_insights/test_unhandled_exception.rb
 homepage: https://github.com/Microsoft/AppInsights-Ruby
 licenses:
 - MIT
@@ -132,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Application Insights SDK for Ruby
@@ -157,6 +193,9 @@ test_files:
 - test/application_insights/channel/contracts/test_session.rb
 - test/application_insights/channel/contracts/test_stack_frame.rb
 - test/application_insights/channel/contracts/test_user.rb
+- test/application_insights/channel/test_asynchronous_queue.rb
+- test/application_insights/channel/test_asynchronous_sender.rb
+- test/application_insights/channel/test_event.rb
 - test/application_insights/channel/test_queue_base.rb
 - test/application_insights/channel/test_sender_base.rb
 - test/application_insights/channel/test_synchronous_queue.rb
@@ -164,3 +203,5 @@ test_files:
 - test/application_insights/channel/test_telemetry_channel.rb
 - test/application_insights/channel/test_telemetry_context.rb
 - test/application_insights/test_telemetry_client.rb
+- test/application_insights/test_unhandled_exception.rb
+has_rdoc: