application_insights 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Nzg1ZmY4ZmVkNGVmNzY4MTY1ZmU5MTgxMmM0NGRmNGJlMGUwZTAxYw==
+    NWFiNjNiNjljMTc2ODI1NzQ4M2VhNTlmODU2MTcxZTFlZjliMTA2Yw==
   data.tar.gz: !binary |-
-    NzY2YjU4OTM1NzAzNGE4ZDk4NzhlZDgwYWI3Y2VmYzMzOGVhOWM0OA==
-SHA512:
+    NGM3NzEwNDZkYzI1MWEwNjRiNTMwNWMyOGJlYTkwODA5MjM2MmI2Yw==
+!binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjI2ZTM5MWUyZDViNjFhYzY0MjUzZmQyZTI1YTFhYTE1MjYwYzYxNTA4ZjU3
-    MDU2Zjk4NWRhODkzY2IzNTA5NjM1M2Q2Njg0OTkwNjliNDY4YjE0NjQyN2Vi
-    ZDg4YzI5ZTg2NjYwZGQyNjUzMzc4NDYxMmYxMGY1OWE0ZGJiYTU=
+    MTU5OTgzY2QzMWMwOTJmYTM3YTZiZWNlYTg4NmQ0NWM4ODkzYjk2ZTI4MTQ4
+    NzJmMDJiNTQxNTA0YzkwNjBmYTEwYTc3ZjBhNmU5YjQxZTRmODA2ZTU4Zjgz
+    ZWJhMzAzZWI2NmYyNzRjMzg0ZDNmZmQwNjZkNmY3MGU2NjYzN2U=
   data.tar.gz: !binary |-
-    MDc0MTc2ZTdjODBjY2IzM2NiZGU2MjI1MWIzN2ZkYjdkMWE4NmVmODRlMGYw
-    ZGJjYmM5NWQ0MDgzZWM1Nzg4ZDY0ZDFhNzEyMTBmMzdhNGEwNTFlNzhkMmI0
-    M2MzNjFlYzU5NDk4OTRiNGIyMDEzZWNjNDU3MTcwMDkwYjZlN2M=
+    NjA1MDU4ZWY2Mjc0MDZiZTYxM2Y0ZTk3MzQ2MjI2NzdjZDU1Y2FkZTY0MGY5
+    ZDBkNDQ1ZGQ4Zjk5M2MwNThmM2VjNjg4ZWNlNjE3ZjMxMjdkMWI3NDRiYmMy
+    YTc5ZDcxYmUwZWM1MzNjMDVhYTU1ZmEwYTFjNDUxOTUxMDYyY2M=

data/LICENSE.txt

@@ -1,22 +1,11 @@
-The MIT License (MIT)
+AppInsights-Ruby
+Copyright (c) Microsoft Corporation
+All rights reserved. 
 
-Copyright (c) 2014 Microsoft
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -27,7 +27,7 @@ Once installed, you can send telemetry to Application Insights. Here are a few s
 >**Note**: before you can send data to you will need an instrumentation key. Please see the [Getting an Application Insights Instrumentation Key](https://github.com/Microsoft/AppInsights-Home/wiki#getting-an-application-insights-instrumentation-key) section for more information.
 
 
-**Sending a simple event telemetry item**
+###Sending a simple event telemetry item###
 ```ruby
 require 'application_insights'
 tc = ApplicationInsights::TelemetryClient.new
@@ -36,7 +36,7 @@ tc.track_event 'My event'
 tc.flush
 ```
 
-**Sending an event telemetry item with custom properties and measurements**
+###Sending an event telemetry item with custom properties and measurements###
 ```ruby
 require 'application_insights'
 tc = ApplicationInsights::TelemetryClient.new
@@ -45,7 +45,7 @@ tc.track_event 'My event', :properties => { 'custom property' => 'some value' },
 tc.flush
 ```
 
-**Sending a trace telemetry item with custom properties**
+###Sending a trace telemetry item with custom properties###
 ```ruby
 require 'application_insights'
 tc = ApplicationInsights::TelemetryClient.new
@@ -54,7 +54,7 @@ tc.track_trace 'My trace statement', :properties => { 'custom property' => 'some
 tc.flush
 ```  
 
-**Sending a metric telemetry item (without and with optional values)**
+###Sending a metric telemetry item (without and with optional values)###
 ```ruby
 require 'application_insights'
 tc = ApplicationInsights::TelemetryClient.new
@@ -65,7 +65,7 @@ tc.track_metric 'My metric', 42, :kind => ApplicationInsights::Channel::Contract
 tc.flush
 ``` 
 
-**Sending an exception telemetry item with custom properties and measurements**
+###Sending an exception telemetry item with custom properties and measurements###
 ```ruby
 require 'application_insights'
 tc = ApplicationInsights::TelemetryClient.new
@@ -78,7 +78,7 @@ end
 tc.flush
 ```  
 
-**Configuring context for a telemetry client instance**
+###Configuring context for a telemetry client instance###
 ```ruby
 require 'application_insights'
 tc = ApplicationInsights::TelemetryClient.new
@@ -94,7 +94,7 @@ tc.track_trace 'My trace with context'
 tc.flush
 ```  
 
-**Configuring channel related properties**
+###Configuring synchronous (default) channel properties###
 ```ruby
 require 'application_insights'
 tc = ApplicationInsights::TelemetryClient.new
@@ -104,5 +104,40 @@ tc.channel.queue.max_queue_length = 10
 tc.channel.sender.send_buffer_size = 5
 ```
 
+###Configuring an asynchronous channel instead of the synchronous default###
+```ruby
+require 'application_insights'
+sender = ApplicationInsights::Channel::AsynchronousSender.new
+queue = ApplicationInsights::Channel::AsynchronousQueue.new sender
+channel = ApplicationInsights::Channel::TelemetryChannel.new nil, queue
+tc = ApplicationInsights::TelemetryClient.new channel
+# Note: the event will be sent on a separate thread; if the app finishes before
+#       the thread finishes, the data is lost
+tc.track_event 'My event'
+```
 
+###Configuring asynchronous channel properties###
+```ruby
+require 'application_insights'
+sender = ApplicationInsights::Channel::AsynchronousSender.new
+queue = ApplicationInsights::Channel::AsynchronousQueue.new sender
+channel = ApplicationInsights::Channel::TelemetryChannel.new nil, queue
+tc = ApplicationInsights::TelemetryClient.new channel
+# flush telemetry if we have 10 or more telemetry items in our queue
+tc.channel.queue.max_queue_length = 10
+# send telemetry to the service in batches of 5
+tc.channel.sender.send_buffer_size = 5
+# the background worker thread will be active for 5 seconds before it shuts down. if
+# during this time items are picked up from the queue, the timer is reset.
+tc.channel.sender.send_time = 5
+# the background worker thread will poll the queue every 0.5 seconds for new items
+tc.channel.sender.send_interval = 0.5
+```
 
+###Collecting unhandled exceptions###
+```ruby
+require 'application_insights'
+# setup unhandled exception handler
+ApplicationInsights::UnhandledException.collect('<YOUR INSTRUMENTATION KEY GOES HERE>')
+# raise an exception and this would be send to Application Insights Service
+raise Exception, 'Boom!'

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
+require 'yard'
 
 Rake::TestTask.new do |test|
   test.libs << 'test'
@@ -7,4 +8,8 @@ Rake::TestTask.new do |test|
   test.verbose = true
 end
 
-task :default => [ :test, :build ]
+YARD::Rake::YardocTask.new do |task|
+  task.files   = ['lib/**/*.rb', '-', 'LICENSE.txt', 'README.md']
+end
+
+task :default => [ :test, :build, :yard ]

data/application_insights.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7.6'
+  spec.add_development_dependency 'redcarpet', '~> 3.2.2'
 end

data/lib/application_insights.rb

@@ -1,2 +1,3 @@
 require_relative 'application_insights/telemetry_client'
+require_relative 'application_insights/unhandled_exception'
 require_relative 'application_insights/version'

data/lib/application_insights/channel/asynchronous_queue.rb

@@ -0,0 +1,51 @@
+require_relative 'event'
+require_relative 'queue_base'
+
+module ApplicationInsights
+  module Channel
+    # An asynchronous queue for use in conjunction with the {AsynchronousSender}. The queue
+    # will notify the sender that it needs to pick up items when it reaches {#max_queue_length}, or when the consumer
+    # calls {#flush} via the {#flush_notification} event.
+    # @example
+    #   require 'application_insights'
+    #   require 'thread'
+    #   queue = ApplicationInsights::Channel::AsynchronousQueue.new nil
+    #   Thread.new do
+    #     sleep 1
+    #     queue.push 1
+    #     queue.flush
+    #   end
+    #   queue.flush_notification.wait
+    #   queue.flush_notification.clear
+    #   result = queue.pop
+    class AsynchronousQueue < QueueBase
+      # Initializes a new instance of the class.
+      # @param [SenderBase] sender the sender object that will be used in conjunction with this queue. In addition to
+      #   the sender object must support a {AsynchronousSender#start} method which is invoked
+      #   each time an item is pushed to the queue as well as use the {#flush_notification} event.
+      def initialize(sender)
+        @flush_notification = Event.new
+        super sender
+      end
+
+      # The flush notification {ApplicationInsights::Channel::Event} that the {#sender} will use to get notified
+      # that a flush is needed.
+      # @return [Event] object that the {#sender} can wait on.
+      attr_reader :flush_notification
+
+      # Adds the passed in item object to the queue and notifies the {#sender} to start an asynchronous send operation
+      # by calling {AsynchronousSender#start}.
+      # @param [Contracts::Envelope] item the telemetry envelope object to send to the service.
+      def push(item)
+        super item
+        @sender.start if @sender
+      end
+
+      # Flushes the current queue by notifying the {#sender} via the {#flush_notification} event.
+      def flush
+        @flush_notification.set
+        @sender.start if @sender
+      end
+    end
+  end
+end

data/lib/application_insights/channel/asynchronous_sender.rb

@@ -0,0 +1,121 @@
+require_relative 'sender_base'
+require 'thread'
+
+module ApplicationInsights
+  module Channel
+    # An asynchronous sender that works in conjunction with the {AsynchronousQueue}. The sender object will start a
+    # worker thread that will pull items from the {#queue}. The thread will be created when the client calls {#start} and
+    # will check for queue items every {#send_interval} seconds. The worker thread can also be forced to check the queue
+    # by setting the {AsynchronousQueue#flush_notification} event.
+    #
+    # - If no items are found, the thread will go back to sleep.
+    # - If items are found, the worker thread will send items to the specified service in batches of {#send_buffer_size}.
+    #
+    # If no queue items are found for {#send_time} seconds,  the worker thread will shut down (and {#start} will
+    # need  to be called again).
+    class AsynchronousSender < SenderBase
+      # Initializes a new instance of the class.
+      # @param [String] service_endpoint_uri the address of the service to send telemetry data to.
+      def initialize(service_endpoint_uri='https://dc.services.visualstudio.com/v2/track')
+        @send_interval = 1.0
+        @send_remaining_time = 0
+        @send_time = 3.0
+        @lock_send_remaining_time = Mutex.new
+        @work_thread = nil
+        super service_endpoint_uri
+      end
+
+      # The time span in seconds at which the the worker thread will check the {#queue} for items (defaults to: 1.0).
+      # @return [Fixnum] the interval in seconds.
+      attr_accessor :send_interval
+
+      # The time span in seconds for which the worker thread will stay alive if no items are found in the {#queue} (defaults to 3.0).
+      # @return [Fixnum] the interval in seconds.
+      attr_accessor :send_time
+
+      # The worker thread which checks queue items and send data every (#send_interval) seconds or upon flush.
+      # @return [Thread] the work thread
+      attr_reader :work_thread
+
+      # Calling this method will create a worker thread that checks the {#queue} every {#send_interval} seconds for
+      # a total duration of {#send_time} seconds for new items. If a worker thread has already been created, calling
+      # this method does nothing.
+      def start
+        @lock_send_remaining_time.synchronize do
+          # only maintain one working thread at one time
+          if !@work_thread
+            local_send_interval = (@send_interval < 0.1) ? 0.1 : @send_interval
+            @send_remaining_time = (@send_time < local_send_interval) ? local_send_interval : @send_time
+            @work_thread = Thread.new do
+              run
+            end
+            @work_thread.abort_on_exception = false
+          end
+        end
+      end
+
+      # Calling this method will shut down the worker thread that checks the {#queue} for new items. The thread will be
+      # allowed to shut down gracefully.
+      def stop
+        @lock_send_remaining_time.synchronize do
+          @send_remaining_time = 0
+        end
+      end
+
+      private
+
+      def run
+        # save the queue locally
+        local_queue = @queue
+        if local_queue == nil
+          stop
+          return
+        end
+
+        # fix up the send interval (can't be lower than 100ms)
+        local_send_interval = (@send_interval < 0.1) ? 0.1 : @send_interval
+        while TRUE
+          while TRUE
+            # get at most @send_buffer_size items from the queue
+            counter = @send_buffer_size
+            data = []
+            while counter > 0
+              item = local_queue.pop
+              break if not item
+              data.push item
+              counter -= 1
+            end
+
+            # if we didn't get any items from the queue, we're done here
+            break if data.length == 0
+
+            # reset the send time
+            @lock_send_remaining_time.synchronize do
+              @send_remaining_time = @send_time
+            end
+
+            # finally send the data
+            send data
+          end
+
+          # wait at most @send_interval ms (or until we get signalled)
+          result = local_queue.flush_notification.wait local_send_interval
+          if result
+            local_queue.flush_notification.clear
+            next
+          end
+
+          # decrement the remaining time
+          @lock_send_remaining_time.synchronize do
+            @send_remaining_time -= local_send_interval
+            # Check queue as well to avoid missing any 'start' notification occurred during waiting
+            if @send_remaining_time <= 0 && local_queue.empty?
+              @work_thread = nil
+              break
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/application_insights/channel/contracts/application.rb

@@ -17,8 +17,9 @@ module ApplicationInsights
         
         # Gets the ver property.
         def ver
-          return @values['ai.application.ver'] if @values.key?('ai.application.ver')
-          @defaults['ai.application.ver']
+          @values.fetch('ai.application.ver') { 
+            @values['ai.application.ver'] = nil
+          }
         end
         
         # Sets the ver property.

data/lib/application_insights/channel/contracts/data.rb

@@ -19,8 +19,9 @@ module ApplicationInsights
         
         # Gets the base_type property.
         def base_type
-          return @values['baseType'] if @values.key?('baseType')
-          @defaults['baseType']
+          @values.fetch('baseType') { 
+            @values['baseType'] = nil
+          }
         end
         
         # Sets the base_type property.

data/lib/application_insights/channel/contracts/data_point.rb

@@ -37,8 +37,9 @@ module ApplicationInsights
         
         # Gets the kind property.
         def kind
-          return @values['kind'] if @values.key?('kind')
-          @defaults['kind']
+          @values.fetch('kind') { 
+            @values['kind'] = DataPointType::MEASUREMENT
+          }
         end
         
         # Sets the kind property.
@@ -62,8 +63,9 @@ module ApplicationInsights
         
         # Gets the count property.
         def count
-          return @values['count'] if @values.key?('count')
-          @defaults['count']
+          @values.fetch('count') { 
+            @values['count'] = nil
+          }
         end
         
         # Sets the count property.
@@ -77,8 +79,9 @@ module ApplicationInsights
         
         # Gets the min property.
         def min
-          return @values['min'] if @values.key?('min')
-          @defaults['min']
+          @values.fetch('min') { 
+            @values['min'] = nil
+          }
         end
         
         # Sets the min property.
@@ -92,8 +95,9 @@ module ApplicationInsights
         
         # Gets the max property.
         def max
-          return @values['max'] if @values.key?('max')
-          @defaults['max']
+          @values.fetch('max') { 
+            @values['max'] = nil
+          }
         end
         
         # Sets the max property.
@@ -107,8 +111,9 @@ module ApplicationInsights
         
         # Gets the std_dev property.
         def std_dev
-          return @values['stdDev'] if @values.key?('stdDev')
-          @defaults['stdDev']
+          @values.fetch('stdDev') { 
+            @values['stdDev'] = nil
+          }
         end
         
         # Sets the std_dev property.