application_insights 0.5.3 → 0.5.4

data/lib/application_insights/channel/synchronous_sender.rb

@@ -1,15 +1,17 @@
-require_relative 'sender_base'
-
-module ApplicationInsights
-  module Channel
-    # A synchronous sender that works in conjunction with the {SynchronousQueue}. The queue will call {#send} on the
-    # current instance with the data to send.
-    class SynchronousSender < 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')
-        super service_endpoint_uri
-      end
-    end
-  end
-end
+require_relative 'sender_base'
+
+module ApplicationInsights
+  module Channel
+    # A synchronous sender that works in conjunction with the {SynchronousQueue}.
+    # The queue will call {#send} on the current instance with the data to send.
+    class SynchronousSender < SenderBase
+      SERVICE_ENDPOINT_URI = 'https://dc.services.visualstudio.com/v2/track'
+      # 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 = SERVICE_ENDPOINT_URI)
+        super service_endpoint_uri
+      end
+    end
+  end
+end

data/lib/application_insights/channel/telemetry_channel.rb

@@ -1,102 +1,120 @@
-require 'time'
-require_relative 'asynchronous_queue'
-require_relative 'asynchronous_sender'
-require_relative 'telemetry_context'
-require_relative 'synchronous_queue'
-require_relative 'synchronous_sender'
-require_relative 'contracts/envelope'
-require_relative 'contracts/data'
-require_relative 'contracts/internal'
-require_relative '../../application_insights/version'
-
-module ApplicationInsights
-  module Channel
-    # The telemetry channel is responsible for constructing a {Contracts::Envelope} object from the passed in
-    # data and specified telemetry context.
-    # @example
-    #   require 'application_insights'
-    #   channel = ApplicationInsights::Channel::TelemetryChannel.new
-    #   event = ApplicationInsights::Channel::Contracts::EventData.new :name => 'My event'
-    #   channel.write event
-    class TelemetryChannel
-      # Initializes a new instance of the class.
-      # @param [TelemetryContext] context the telemetry context to use when sending telemetry data.
-      # @param [QueueBase] queue the queue to enqueue the resulting {Contracts::Envelope} to.
-      def initialize(context=nil, queue=nil)
-        @context = context || TelemetryContext.new
-        @queue = queue || SynchronousQueue.new(SynchronousSender.new)
-      end
-
-      # The context associated with this channel. All {Contracts::Envelope} objects created by this channel will use
-      # this value if it's present or if none is specified as part of the {#write} call.
-      # @return [TelemetryContext] the context instance (defaults to: TelemetryContext.new)
-      attr_reader :context
-
-      # The queue associated with this channel. All {Contracts::Envelope} objects created by this channel will be
-      # pushed to this queue.
-      # @return [QueueBase] the queue instance (defaults to: SynchronousQueue.new)
-      attr_reader :queue
-
-      # The sender associated with this channel. This instance will be used to transmit telemetry to the service.
-      # @return [SenderBase] the sender instance (defaults to: SynchronousSender.new)
-      def sender
-        @queue.sender
-      end
-
-      # Flushes the enqueued data by calling {QueueBase#flush}.
-      def flush
-        @queue.flush
-      end
-
-      # Enqueues the passed in data to the {#queue}. If the caller specifies a context as well, it will take precedence
-      # over the instance in {#context}.
-      # @param [Object] data the telemetry data to send. This will be wrapped in an {Contracts::Envelope} before being
-      #   enqueued to the {#queue}.
-      # @param [TelemetryContext] context the override context to use when constructing the {Contracts::Envelope}.
-      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.iso8601(7),
-          :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:' + ApplicationInsights::VERSION
-        }
-        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
+require 'time'
+require_relative 'asynchronous_queue'
+require_relative 'asynchronous_sender'
+require_relative 'telemetry_context'
+require_relative 'synchronous_queue'
+require_relative 'synchronous_sender'
+require_relative 'contracts/envelope'
+require_relative 'contracts/data'
+require_relative 'contracts/internal'
+require_relative '../../application_insights/version'
+
+module ApplicationInsights
+  module Channel
+    # The telemetry channel is responsible for constructing a
+    # {Contracts::Envelope} object from the passed in data and specified
+    # telemetry context.
+    #
+    # @example
+    #   require 'application_insights'
+    #   channel = ApplicationInsights::Channel::TelemetryChannel.new
+    #   event = ApplicationInsights::Channel::Contracts::EventData.new name: 'My event'
+    #   channel.write event
+    class TelemetryChannel
+      # Initializes a new instance of the class.
+      # @param [TelemetryContext] context the telemetry context to use when
+      #   sending telemetry data.
+      # @param [QueueBase] queue the queue to enqueue the resulting
+      #   {Contracts::Envelope} to.
+      def initialize(context=nil, queue=nil)
+        @context = context || TelemetryContext.new
+        @queue = queue || SynchronousQueue.new(SynchronousSender.new)
+      end
+
+      # The context associated with this channel. All {Contracts::Envelope}
+      # objects created by this channel will use this value if it's present or if
+      # none is specified as part of the {#write} call.
+      # @return [TelemetryContext] the context instance
+      #   (defaults to: TelemetryContext.new)
+      attr_reader :context
+
+      # The queue associated with this channel. All {Contracts::Envelope} objects
+      # created by this channel will be pushed to this queue.
+      # @return [QueueBase] the queue instance (defaults to: SynchronousQueue.new)
+      attr_reader :queue
+
+      # The sender associated with this channel. This instance will be used to
+      # transmit telemetry to the service.
+      # @return [SenderBase] the sender instance (defaults to: SynchronousSender.new)
+      def sender
+        @queue.sender
+      end
+
+      # Flushes the enqueued data by calling {QueueBase#flush}.
+      def flush
+        @queue.flush
+      end
+
+      # Enqueues the passed in data to the {#queue}. If the caller specifies a
+      # context as well, it will take precedence over the instance in {#context}.
+      # @param [Object] data the telemetry data to send. This will be wrapped in
+      #   an {Contracts::Envelope} before being enqueued to the {#queue}.
+      # @param [TelemetryContext] context the override context to use when
+      #   constructing the {Contracts::Envelope}.
+      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.iso8601(7),
+          :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:' + ApplicationInsights::VERSION
+        }
+        internal_context = Contracts::Internal.new internal_context_attributes
+
+        [internal_context,
+          context.application,
+          context.cloud,
+          context.device,
+          context.user,
+          context.session,
+          context.location,
+          context.operation].each { |c|  hash.merge!(c.to_h) if c }
+
+        hash.delete_if { |k, v| v.nil? }
+
+        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

@@ -1,68 +1,85 @@
-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 the context for sending telemetry to the Application Insights service.
-    # @example
-    #   require 'application_insights'
-    #   context = ApplicationInsights::Channel::TelemetryContext.new
-    #   context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
-    #   context.application.id = 'My application'
-    #   context.application.ver = '1.2.3'
-    #   context.device.id = 'My current device'
-    #   context.device.oem_name = 'Asus'
-    #   context.device.model = 'X31A'
-    #   context.device.type = "Other"
-    #   context.user.id = 'santa@northpole.net'
-    class TelemetryContext
-      # Initializes a new instance of the 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
-
-      # The instrumentation key that is used to identify which Application Insights application this data is for.
-      # @return [String] the instrumentation key.
-      attr_accessor :instrumentation_key
-
-      # The application context. This contains properties of the application you are running.
-      # @return [Contracts::Application] the context object.
-      attr_accessor :application
-
-      # The device context. This contains properties of the device you are running on.
-      # @return [Contracts::Device] the context object.
-      attr_accessor :device
-
-      # The user context. This contains properties of the user you are generating telemetry for.
-      # @return [Contracts::User] the context object.
-      attr_accessor :user
-
-      # The session context. This contains properties of the session you are generating telemetry for.
-      # @return [Contracts::Session] the context object.
-      attr_accessor :session
-
-      # The operation context. This contains properties of the operation you are generating telemetry for.
-      # @return [Contracts::Operation] the context object.
-      attr_accessor :operation
-
-      # The location context. This contains properties of the location you are generating telemetry from.
-      # @return [Contracts::Location] the context object.
-      attr_accessor :location
-
-      # The property context. This contains free-form properties that you can add to your telemetry.
-      # @return [Hash<String, String>] the context object.
-      attr_accessor :properties
-    end
-  end
-end
+require_relative 'contracts/application'
+require_relative 'contracts/cloud'
+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 the context for sending telemetry to the
+    # Application Insights service.
+    #
+    # @example
+    #   require 'application_insights'
+    #   context = ApplicationInsights::Channel::TelemetryContext.new
+    #   context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
+    #   context.application.id = 'My application'
+    #   context.application.ver = '1.2.3'
+    #   context.device.id = 'My current device'
+    #   context.device.oem_name = 'Asus'
+    #   context.device.model = 'X31A'
+    #   context.device.type = "Other"
+    #   context.user.id = 'santa@northpole.net'
+    class TelemetryContext
+      # Initializes a new instance of the class.
+      def initialize
+        @instrumentation_key = nil
+        @application = Contracts::Application.new
+        @cloud = Contracts::Cloud.new
+        @device = Contracts::Device.new
+        @user = Contracts::User.new
+        @session = Contracts::Session.new
+        @operation = Contracts::Operation.new
+        @location = Contracts::Location.new
+        @properties = {}
+      end
+
+      # The instrumentation key that is used to identify which
+      # Application Insights application this data is for.
+      # @return [String] the instrumentation key.
+      attr_accessor :instrumentation_key
+
+      # The application context. This contains properties of the
+      # application you are running.
+      # @return [Contracts::Application] the context object.
+      attr_accessor :application
+
+      # The cloud context. This contains properties of the
+      # cloud role you are generating telemetry for.
+      # @return [Contracts::Cloud] the context object.
+      attr_accessor :cloud
+
+      # The device context. This contains properties of the
+      # device you are running on.
+      # @return [Contracts::Device] the context object.
+      attr_accessor :device
+
+      # The user context. This contains properties of the
+      # user you are generating telemetry for.
+      # @return [Contracts::User] the context object.
+      attr_accessor :user
+
+      # The session context. This contains properties of the
+      # session you are generating telemetry for.
+      # @return [Contracts::Session] the context object.
+      attr_accessor :session
+
+      # The operation context. This contains properties of the
+      # operation you are generating telemetry for.
+      # @return [Contracts::Operation] the context object.
+      attr_accessor :operation
+
+      # The location context. This contains properties of the
+      # location you are generating telemetry from.
+      # @return [Contracts::Location] the context object.
+      attr_accessor :location
+
+      # The property context. This contains free-form properties
+      # that you can add to your telemetry.
+      # @return [Hash<String, String>] the context object.
+      attr_accessor :properties
+    end
+  end
+end

data/lib/application_insights/rack/track_request.rb

@@ -1,84 +1,87 @@
-require 'rack'
-require_relative '../channel/contracts/request_data'
-require_relative '../telemetry_client'
-
-module ApplicationInsights
-  module Rack
-    # Track every request and sends the request data to Application Insights.
-    class TrackRequest
-      # Initializes a new instance of the class.
-      # @param [Object] app the inner rack application.
-      # @param [String] instrumentation_key to identify which Application Insights application this data is for.
-      # @param [Fixnum] buffer_size the buffer size and the buffered requests would send to Application Insights
-      #   when buffer is full.
-      # @param [Fixnum] send_interval the frequency (in seconds) to check buffer and send buffered requests to Application
-      #   Insights if any.
-      def initialize(app, instrumentation_key, buffer_size=500, send_interval=60)
-        @app = app
-        @instrumentation_key = instrumentation_key
-        @buffer_size = buffer_size
-        @send_interval = send_interval
-      end
-
-      # Track requests and send data to Application Insights asynchronously.
-      # @param [Hash] env the rack environment.
-      def call(env)
-        start = Time.now
-        begin
-          status, headers, response = @app.call(env)
-        rescue Exception => ex
-          status = 500
-          exception = ex
-        end
-        stop = Time.now
-
-        if !@client
-          sender = @sender || Channel::AsynchronousSender.new
-          sender.send_interval = @send_interval
-          queue = Channel::AsynchronousQueue.new sender
-          queue.max_queue_length = @buffer_size
-          channel = Channel::TelemetryChannel.new nil, queue
-          @client = TelemetryClient.new  @instrumentation_key, channel
-        end
-
-        request = ::Rack::Request.new env
-        id = rand(16**32).to_s(16)
-        start_time = start.iso8601(7)
-        duration = format_request_duration(stop - start)
-        success = status.to_i < 400
-        options = {
-            :name => "#{request.request_method} #{request.path}",
-            :http_method => request.request_method,
-            :url => request.url
-        }
-        @client.track_request id, start_time, duration, status, success, options
-
-        if exception != nil
-          @client.track_exception exception, handled_at: 'Unhandled'
-          raise exception
-        end
-
-        [status, headers, response]
-      end
-
-      private
-
-      def sender=(sender)
-        @sender = sender if sender.is_a? Channel::AsynchronousSender
-      end
-
-      def client
-        @client
-      end
-
-      def format_request_duration(duration_seconds)
-        if duration_seconds >= 86400
-          # just return 1 day when it takes more than 1 day which should not happen for requests.
-          return "%d:%02d:%02d:%02d.%07d" % [1, 0, 0, 0, 0]
-        end
-
-        Time.at(duration_seconds).gmtime.strftime("0:%H:%M:%S.%7N")
-      end
-    end
-  end
-end
+require 'rack'
+require_relative '../channel/contracts/request_data'
+require_relative '../telemetry_client'
+
+module ApplicationInsights
+  module Rack
+    # Track every request and sends the request data to Application Insights.
+    class TrackRequest
+      # Initializes a new instance of the class.
+      # @param [Object] app the inner rack application.
+      # @param [String] instrumentation_key to identify which Application Insights
+      #   application this data is for.
+      # @param [Fixnum] buffer_size the buffer size and the buffered requests would
+      #   send to Application Insights when buffer is full.
+      # @param [Fixnum] send_interval the frequency (in seconds) to check buffer
+      #   and send buffered requests to Application Insights if any.
+      def initialize(app, instrumentation_key, buffer_size = 500, send_interval = 60)
+        @app = app
+        @instrumentation_key = instrumentation_key
+        @buffer_size = buffer_size
+        @send_interval = send_interval
+      end
+
+      # Track requests and send data to Application Insights asynchronously.
+      # @param [Hash] env the rack environment.
+      def call(env)
+        start = Time.now
+        begin
+          status, headers, response = @app.call(env)
+        rescue Exception => ex
+          status = 500
+          exception = ex
+        end
+        stop = Time.now
+
+        unless @client
+          sender = @sender || Channel::AsynchronousSender.new
+          sender.send_interval = @send_interval
+          queue = Channel::AsynchronousQueue.new sender
+          queue.max_queue_length = @buffer_size
+          channel = Channel::TelemetryChannel.new nil, queue
+
+          @client = TelemetryClient.new @instrumentation_key, channel
+        end
+
+        request = ::Rack::Request.new env
+        id = rand(16**32).to_s(16)
+        start_time = start.iso8601(7)
+        duration = format_request_duration(stop - start)
+        success = status.to_i < 400
+        options = {
+          :name => "#{request.request_method} #{request.path}",
+          :http_method => request.request_method,
+          :url => request.url
+        }
+
+        @client.track_request id, start_time, duration, status, success, options
+
+        if exception
+          @client.track_exception exception, handled_at: 'Unhandled'
+          raise exception
+        end
+
+        [status, headers, response]
+      end
+
+      private
+
+      def sender=(sender)
+        @sender = sender if sender.is_a? Channel::AsynchronousSender
+      end
+
+      def client
+        @client
+      end
+
+      def format_request_duration(duration_seconds)
+        if duration_seconds >= 86400
+          # just return 1 day when it takes more than 1 day which should not happen for requests.
+          return "%02d.%02d:%02d:%02d.%07d" % [1, 0, 0, 0, 0]
+        end
+
+        Time.at(duration_seconds).gmtime.strftime("00.%H:%M:%S.%7N")
+      end
+    end
+  end
+end