application_insights 0.1.0

data/lib/application_insights/channel/sender_base.rb

@@ -0,0 +1,46 @@
+require 'json'
+require 'net/http'
+
+module ApplicationInsights
+  module Channel
+    # The base class for all of our senders.
+    class SenderBase
+      # Initializes a new instance of the sender class.
+      def initialize(service_endpoint_uri)
+        raise ArgumentError, 'Service endpoint URI was required but not provided' unless service_endpoint_uri
+        @service_endpoint_uri = service_endpoint_uri
+        @queue = nil
+        @send_buffer_size = 100
+      end
+
+      # Gets the service endpoint URI property. This is where we send data to.
+      attr_accessor :service_endpoint_uri
+
+      # The queue that we will be draining
+      attr_accessor :queue
+
+      # Gets or sets the buffer size for a single batch of telemetry. This is the maximum number of items in a single service request we are going to send.
+      attr_accessor :send_buffer_size
+
+      # Sends the data to send list to the service immediately.
+      def send(data_to_send)
+        uri = URI(@service_endpoint_uri)
+        request = Net::HTTP::Post.new(uri.path, { 'Accept' => 'application/json', 'Content-Type' => 'application/json; charset=utf-8' })
+        request.body = data_to_send.to_json
+
+        response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+          http.request(request)
+        end
+
+        case response
+          when Net::HTTPSuccess, Net::HTTPRedirection, Net::HTTPBadRequest
+            return
+          else
+            data_to_send.each do |item|
+              @queue.push item
+            end
+        end
+      end
+    end
+  end
+end

data/lib/application_insights/channel/synchronous_queue.rb

@@ -0,0 +1,28 @@
+require_relative 'queue_base'
+
+module ApplicationInsights
+  module Channel
+    # A synchronous queue for use in conjunction with the SynchronousSender. The queue will flush either when it reaches max_queue_length or when someone calls flush().
+    class SynchronousQueue < QueueBase
+      # Initializes a new instance of the synchronous queue class.
+      def initialize(sender)
+        super sender
+      end
+
+      # Flushes the current queue to the passed in sender.
+      def flush
+        while TRUE
+          # get at most send_buffer_size items and send them
+          data = []
+          while data.length < @sender.send_buffer_size
+            item = pop()
+            break if not item
+            data.push item
+          end
+          break if data.length == 0
+          @sender.send(data)
+        end
+      end
+    end
+  end
+end

data/lib/application_insights/channel/synchronous_sender.rb

@@ -0,0 +1,13 @@
+require_relative 'sender_base'
+
+module ApplicationInsights
+  module Channel
+    # A synchronous sender that works in conjunction with SynchronousQueue.
+    class SynchronousSender < SenderBase
+      # Initializes a new instance of the synchronous sender class.
+      def initialize(service_endpoint_uri='http://dc.services.visualstudio.com/v2/track')
+        super service_endpoint_uri
+      end
+    end
+  end
+end

data/lib/application_insights/channel/telemetry_channel.rb

@@ -0,0 +1,81 @@
+require_relative 'telemetry_context'
+require_relative 'synchronous_queue'
+require_relative 'synchronous_sender'
+require_relative 'contracts/envelope'
+require_relative 'contracts/data'
+require_relative 'contracts/internal'
+
+module ApplicationInsights
+  module Channel
+    # The telemetry channel is responsible for constructing an envelope an sending it.
+    class TelemetryChannel
+      # Initializes a new instance of the telemetry channel class.
+      def initialize(context=nil, queue=nil)
+        @context = context || TelemetryContext.new
+        @queue = queue || SynchronousQueue.new(SynchronousSender.new)
+      end
+
+      # Gets the context associated with this channel.
+      attr_reader :context
+
+      # Gets the queue associated with this channel.
+      attr_reader :queue
+
+      # Gets the sender associated with this channel.
+      def sender
+        @queue.sender
+      end
+
+      # Flushes the current queue.
+      def flush
+        @queue.flush
+      end
+
+      # Writes the passed in data to the sending queue.
+      def write(data, context=nil)
+        local_context = context || @context
+        raise ArgumentError, 'Context was required but not provided' unless local_context
+        data_type = data.class.name.gsub(/^.*::/, '')
+        set_properties data, local_context
+        data_attributes = {
+            :base_type => data_type,
+            :base_data => data
+        }
+        envelope_attributes = {
+          :name => 'Microsoft.ApplicationInsights.' + data_type[0..-5],
+          :time => Time.now.getutc.strftime('%FT%T.%6NZ'),
+          :i_key => local_context.instrumentation_key,
+          :tags => get_tags(local_context),
+          :data => Contracts::Data.new(data_attributes)
+        }
+        envelope = Contracts::Envelope.new envelope_attributes
+        @queue.push(envelope)
+      end
+
+      private
+
+      def get_tags(context)
+        hash = {}
+        internal_context_attributes = {
+          :sdk_version => 'rb:0.1.0'
+        }
+        internal_context = Contracts::Internal.new internal_context_attributes
+        contexts = [ internal_context, context.application, context.device, context.user, context.session, context.location, context.operation ]
+        contexts.each { |c|  hash.merge!(c.to_h) if c }
+        hash
+      end
+
+      def set_properties(data, context)
+        if context.properties
+          properties = data.properties || {}
+          context.properties.each do |key, value|
+            unless properties.key?(key)
+              properties[key] = value
+            end
+          end
+          data.properties = properties
+        end
+      end
+    end
+  end
+end

data/lib/application_insights/channel/telemetry_context.rb

@@ -0,0 +1,49 @@
+require_relative 'contracts/application'
+require_relative 'contracts/device'
+require_relative 'contracts/user'
+require_relative 'contracts/session'
+require_relative 'contracts/operation'
+require_relative 'contracts/location'
+
+module ApplicationInsights
+  module Channel
+    # Represents a context for sending telemetry to the Application Insights service.
+    class TelemetryContext
+      # Initializes a new instance of the TelemetryContext class.
+      def initialize
+        @instrumentation_key = nil
+        @application = Contracts::Application.new
+        @device = Contracts::Device.new
+        @user = Contracts::User.new
+        @session = Contracts::Session.new
+        @operation = Contracts::Operation.new
+        @location = Contracts::Location.new
+        @properties = {}
+      end
+
+      # Gets or sets the instrumentation key.
+      attr_accessor :instrumentation_key
+
+      # Gets or sets the application context.
+      attr_accessor :application
+
+      # Gets or sets the device context.
+      attr_accessor :device
+
+      # Gets or sets the user context.
+      attr_accessor :user
+
+      # Gets or sets the session context.
+      attr_accessor :session
+
+      # Gets or sets the operation context.
+      attr_accessor :operation
+
+      # Gets or sets the location context.
+      attr_accessor :location
+
+      # Gets a dictionary of application-defined property values.
+      attr_reader :properties
+    end
+  end
+end

data/lib/application_insights/telemetry_client.rb

@@ -0,0 +1,111 @@
+require_relative 'channel/telemetry_context'
+require_relative 'channel/telemetry_channel'
+require_relative 'channel/contracts/page_view_data'
+require_relative 'channel/contracts/exception_data'
+require_relative 'channel/contracts/exception_details'
+require_relative 'channel/contracts/event_data'
+require_relative 'channel/contracts/data_point'
+require_relative 'channel/contracts/data_point_type'
+require_relative 'channel/contracts/metric_data'
+require_relative 'channel/contracts/message_data'
+
+module ApplicationInsights
+  # The telemetry client used for sending all types of telemetry.
+  class TelemetryClient
+    # Initializes a new instance of the TelemetryClient class.
+    def initialize(telemetry_channel = nil)
+      @context = Channel::TelemetryContext.new
+      @channel = telemetry_channel || Channel::TelemetryChannel.new
+    end
+
+    # Gets the context associated with this telemetry client.
+    attr_reader :context
+
+    # Gets the channel associated with this telemetry client.
+    attr_reader :channel
+
+    # Send information about the page viewed in the application.
+    def track_page_view(name, url, options={})
+      data_attributes = {
+        :name => name || 'Null',
+        :url => url,
+        :duration => options[:duration],
+        :properties => options.fetch(:properties) { {} },
+        :measurements => options.fetch(:measurements) { {} }
+      }
+      data = Channel::Contracts::PageViewData.new data_attributes
+      self.channel.write(data, self.context)
+    end
+
+    # Send an ExceptionTelemetry object for display in Diagnostic Search.
+    def track_exception(exception, options={})
+      if exception.is_a? Exception
+        details_attributes = {
+          :id => 1,
+          :outer_id => 0,
+          :type_name => exception.class,
+          :message => exception.message,
+          :has_full_stack => true,
+          :stack => exception.backtrace.join("\n")
+        }
+        details = Channel::Contracts::ExceptionDetails.new details_attributes
+
+        data_attributes = {
+          :handled_at => 'UserCode',
+          :exceptions => [ details ],
+          :properties => options.fetch(:properties) { {} },
+          :measurements => options.fetch(:measurements) { {} }
+        }
+        data = Channel::Contracts::ExceptionData.new data_attributes
+        self.channel.write(data, self.context)
+      end
+    end
+
+    # Send an EventTelemetry object for display in Diagnostic Search and aggregation in Metrics Explorer.
+    def track_event(name, options={})
+      data_attributes = {
+        :name => name || 'Null',
+        :properties => options.fetch(:properties) { {} },
+        :measurements => options.fetch(:measurements) { {} }
+      }
+      data = Channel::Contracts::EventData.new data_attributes
+      self.channel.write(data, self.context)
+    end
+
+    # Send a MetricTelemetry object for aggregation in Metric Explorer.
+    def track_metric(name, value, options={})
+      data_point_attributes = {
+        :name => name || 'Null',
+        :value => value || 0,
+        :kind => options.fetch(:type) { Channel::Contracts::DataPointType::AGGREGATION },
+        :count => options[:count],
+        :min => options[:min],
+        :max => options[:max],
+        :std_dev => options[:std_dev]
+      }
+      data_point = Channel::Contracts::DataPoint.new data_point_attributes
+
+      data_attributes = {
+        :metrics => [ data_point ],
+        :properties => options.fetch(:measurements) { {} }
+      }
+      data = Channel::Contracts::MetricData.new data_attributes
+      self.channel.write(data, self.context)
+    end
+
+    # Send a trace message for display in Diagnostic Search.
+    def track_trace(name, options={})
+      data_attributes = {
+        :message => name || 'Null',
+        :properties => options.fetch(:measurements) { {} }
+      }
+      data = Channel::Contracts::MessageData.new data_attributes
+      self.channel.write(data, self.context)
+    end
+
+    # Flushes the current queue.
+    def flush
+      self.channel.flush
+    end
+  end
+end

data/lib/application_insights/version.rb

@@ -0,0 +1,3 @@
+module ApplicationInsights
+  VERSION = '0.1.0'
+end

data/test/application_insights.rb

@@ -0,0 +1,9 @@
+require 'find'
+
+test = File.expand_path('../application_insights', __FILE__)
+Find.find test do |path|
+  if FileTest.file? path
+    require path
+  end
+end
+

data/test/application_insights/channel/contracts/test_application.rb

@@ -0,0 +1,31 @@
+require_relative '../../../../lib/application_insights/channel/contracts/application'
+require 'test/unit'
+
+include ApplicationInsights::Channel
+
+class TestApplication < Test::Unit::TestCase
+  def test_initialize
+    item = Contracts::Application.new
+    assert_not_nil item
+  end
+  
+  def test_ver_works_as_expected
+    expected = 'Test string'
+    item = Contracts::Application.new
+    item.ver = expected
+    actual = item.ver
+    assert_equal expected, actual
+    expected = 'Other string'
+    item.ver = expected
+    actual = item.ver
+    assert_equal expected, actual
+  end
+  
+  def test_to_json_works_as_expected
+    item = Contracts::Application.new
+    item.ver = 'Test string'
+    actual = item.to_json
+    expected = '{"ai.application.ver":"Test string"}'
+    assert_equal expected, actual
+  end
+end

data/test/application_insights/channel/contracts/test_data.rb

@@ -0,0 +1,44 @@
+require_relative '../../../../lib/application_insights/channel/contracts/data'
+require 'test/unit'
+
+include ApplicationInsights::Channel
+
+class TestData < Test::Unit::TestCase
+  def test_initialize
+    item = Contracts::Data.new
+    assert_not_nil item
+  end
+  
+  def test_base_type_works_as_expected
+    expected = 'Test string'
+    item = Contracts::Data.new
+    item.base_type = expected
+    actual = item.base_type
+    assert_equal expected, actual
+    expected = 'Other string'
+    item.base_type = expected
+    actual = item.base_type
+    assert_equal expected, actual
+  end
+  
+  def test_base_data_works_as_expected
+    expected = { 'key' => 'value' }
+    item = Contracts::Data.new
+    item.base_data = expected
+    actual = item.base_data
+    assert_equal expected, actual
+    expected = { 'key' => 'value' }
+    item.base_data = expected
+    actual = item.base_data
+    assert_equal expected, actual
+  end
+  
+  def test_to_json_works_as_expected
+    item = Contracts::Data.new
+    item.base_type = 'Test string'
+    item.base_data = { 'key' => 'value' }
+    actual = item.to_json
+    expected = '{"baseType":"Test string","baseData":{"key":"value"}}'
+    assert_equal expected, actual
+  end
+end

data/test/application_insights/channel/contracts/test_data_point.rb

@@ -0,0 +1,109 @@
+require_relative '../../../../lib/application_insights/channel/contracts/data_point'
+require 'test/unit'
+
+include ApplicationInsights::Channel
+
+class TestDataPoint < Test::Unit::TestCase
+  def test_initialize
+    item = Contracts::DataPoint.new
+    assert_not_nil item
+  end
+  
+  def test_name_works_as_expected
+    expected = 'Test string'
+    item = Contracts::DataPoint.new
+    item.name = expected
+    actual = item.name
+    assert_equal expected, actual
+    expected = 'Other string'
+    item.name = expected
+    actual = item.name
+    assert_equal expected, actual
+  end
+  
+  def test_kind_works_as_expected
+    expected = { 'key' => 'value' }
+    item = Contracts::DataPoint.new
+    item.kind = expected
+    actual = item.kind
+    assert_equal expected, actual
+    expected = { 'key' => 'value' }
+    item.kind = expected
+    actual = item.kind
+    assert_equal expected, actual
+  end
+  
+  def test_value_works_as_expected
+    expected = 1.5
+    item = Contracts::DataPoint.new
+    item.value = expected
+    actual = item.value
+    assert_equal expected, actual
+    expected = 4.8
+    item.value = expected
+    actual = item.value
+    assert_equal expected, actual
+  end
+  
+  def test_count_works_as_expected
+    expected = 42
+    item = Contracts::DataPoint.new
+    item.count = expected
+    actual = item.count
+    assert_equal expected, actual
+    expected = 13
+    item.count = expected
+    actual = item.count
+    assert_equal expected, actual
+  end
+  
+  def test_min_works_as_expected
+    expected = 1.5
+    item = Contracts::DataPoint.new
+    item.min = expected
+    actual = item.min
+    assert_equal expected, actual
+    expected = 4.8
+    item.min = expected
+    actual = item.min
+    assert_equal expected, actual
+  end
+  
+  def test_max_works_as_expected
+    expected = 1.5
+    item = Contracts::DataPoint.new
+    item.max = expected
+    actual = item.max
+    assert_equal expected, actual
+    expected = 4.8
+    item.max = expected
+    actual = item.max
+    assert_equal expected, actual
+  end
+  
+  def test_std_dev_works_as_expected
+    expected = 1.5
+    item = Contracts::DataPoint.new
+    item.std_dev = expected
+    actual = item.std_dev
+    assert_equal expected, actual
+    expected = 4.8
+    item.std_dev = expected
+    actual = item.std_dev
+    assert_equal expected, actual
+  end
+  
+  def test_to_json_works_as_expected
+    item = Contracts::DataPoint.new
+    item.name = 'Test string'
+    item.kind = { 'key' => 'value' }
+    item.value = 1.5
+    item.count = 42
+    item.min = 1.5
+    item.max = 1.5
+    item.std_dev = 1.5
+    actual = item.to_json
+    expected = '{"name":"Test string","kind":{"key":"value"},"value":1.5,"count":42,"min":1.5,"max":1.5,"stdDev":1.5}'
+    assert_equal expected, actual
+  end
+end