application_insights 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTljZjhhZmU0YjRhZDdkMTlmYWMwODM2ZDUyZWFhZDgyZmQ5Yzk4Ng==
+  data.tar.gz: !binary |-
+    OWNkZTZhNmE3ODAyOGE4N2JkYTEwNzA3MzI3ODM3NGZhNjJiMTc4YQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZGVlMzFlMjE3OTQyNGUyNzY1NWUyNGU5YjljYjY3MmQwN2RiYzNlZTNkMGNm
+    YWQ0MDNmMjUyZDJmNzM0OGJmMjQzNGY5NzMyYTQ2ZWQxOGY1YWUzNDIxYzVk
+    ZTQ4YjUwMWYwMWM1NmNmZjRiMzZmMDkyYTc2OTY1NDAyOTBhNjM=
+  data.tar.gz: !binary |-
+    OGM0MTAwYmUxZGJkN2VjMjFiNWZmNDIzMmU1NTk4YTAyNDc1MzQxZGNiZDYw
+    YjhhYWUzNGZmODA1ZWVmNDk3M2NmZjE3YWJmZjUwMmIzOGNkNjg4YzhiMDYz
+    NmEwOWRmZjkyOTU4MTUyYTg3Y2YyYjFhZWZhZGM5ZWU1Yzk1OWE=

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+*.bundle
+mkmf.log
+/.config
+/coverage/
+/InstalledFiles
+/doc/
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Specific to RubyMine:
+/.idea/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in application_insights.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Microsoft
+
+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.
+

data/README.md

@@ -0,0 +1,106 @@
+# Application Insights SDK for Ruby #
+
+>Ruby is a dynamic, open source programming language with a focus on simplicity and productivity. It has an elegant syntax that is natural to read and easy to write. 
+> -- <cite>[Ruby - Official Site](https://www.ruby-lang.org/en/)</cite>
+
+This project extends the Application Insights API surface to support Ruby. [Application Insights](http://azure.microsoft.com/en-us/services/application-insights/) is a service that allows developers to keep their application available, performing and succeeding. This Ruby gem will allow you to send telemetry of various kinds (event, trace, exception, etc.) to the Application Insights service where they can be visualized in the Azure Portal. 
+
+
+## Requirements ##
+
+Ruby 1.9.3 is currently supported by this gem. 
+
+## Installation ##
+
+To install the latest release you can use *gem*.
+
+```
+$ gem install application_insights
+```
+
+## Usage ##
+
+Once installed, you can send telemetry to Application Insights. Here are a few samples.
+
+>**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**
+```ruby
+require 'application_insights'
+tc = ApplicationInsights::TelemetryClient.new
+tc.context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
+tc.track_event 'My event'
+tc.flush
+```
+
+**Sending an event telemetry item with custom properties and measurements**
+```ruby
+require 'application_insights'
+tc = ApplicationInsights::TelemetryClient.new
+tc.context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
+tc.track_event 'My event', :properties => { 'custom property' => 'some value' }, :measurements => { 'custom metric' => 13 }
+tc.flush
+```
+
+**Sending a trace telemetry item with custom properties**
+```ruby
+require 'application_insights'
+tc = ApplicationInsights::TelemetryClient.new
+tc.context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
+tc.track_trace 'My trace statement', :properties => { 'custom property' => 'some value' }
+tc.flush
+```  
+
+**Sending a metric telemetry item (without and with optional values)**
+```ruby
+require 'application_insights'
+tc = ApplicationInsights::TelemetryClient.new
+tc.context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
+tc.track_metric 'My metric', 42
+# with all optional values set
+tc.track_metric 'My metric', 42, :kind => ApplicationInsights::Channel::Contracts::DataPointType::AGGREGATION, :count => 3, :min => 1, :max => 100, :std_dev => 10, :properties => { 'custom property' => 'some value' }
+tc.flush
+``` 
+
+**Sending an exception telemetry item with custom properties and measurements**
+```ruby
+require 'application_insights'
+tc = ApplicationInsights::TelemetryClient.new
+tc.context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
+begin
+  raise ArgumentError, 'Something has gone wrong!'
+rescue => e
+  tc.track_exception e
+end
+tc.flush
+```  
+
+**Configuring context for a telemetry client instance**
+```ruby
+require 'application_insights'
+tc = ApplicationInsights::TelemetryClient.new
+tc.context.instrumentation_key = '<YOUR INSTRUMENTATION KEY GOES HERE>'
+tc.context.application.id = 'My application'
+tc.context.application.ver = '1.2.3'
+tc.context.device.id = 'My current device'
+tc.context.device.oem_name = 'Asus'
+tc.context.device.model = 'X31A'
+tc.context.device.type = "Other"
+tc.context.user.id = 'santa@northpole.net'
+tc.track_trace 'My trace with context'
+tc.flush
+```  
+
+**Configuring channel related properties**
+```ruby
+require 'application_insights'
+tc = ApplicationInsights::TelemetryClient.new
+# 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
+```
+
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.test_files = FileList['test/application_insights.rb']
+  test.verbose = true
+end
+
+task :default => [ :test, :build ]

data/application_insights.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'application_insights/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'application_insights'
+  spec.version       = ApplicationInsights::VERSION
+  spec.authors       = ['Microsoft']
+  spec.email         = ['aiengdisc@microsoft.com']
+  spec.summary       = %q{Application Insights SDK for Ruby}
+  spec.description   = %q{This project extends the Application Insights API surface to support Ruby.}
+  spec.homepage      = 'https://github.com/Microsoft/AppInsights-Ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/application_insights.rb

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

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

@@ -0,0 +1,35 @@
+require_relative 'json_serializable'
+
+module ApplicationInsights
+  module Channel
+    module Contracts
+      # Data contract class for type Application.
+      class Application < JsonSerializable
+        # Initializes a new instance of the Application class.
+        def initialize(options={})
+          defaults = {
+            'ai.application.ver' => nil
+          }
+          values = {
+          }
+          super defaults, values, options
+        end
+        
+        # Gets the ver property.
+        def ver
+          return @values['ai.application.ver'] if @values.key?('ai.application.ver')
+          @defaults['ai.application.ver']
+        end
+        
+        # Sets the ver property.
+        def ver=(value)
+          if value == @defaults['ai.application.ver']
+            @values.delete 'ai.application.ver' if @values.key? 'ai.application.ver'
+          else
+            @values['ai.application.ver'] = value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require_relative 'json_serializable'
+
+module ApplicationInsights
+  module Channel
+    module Contracts
+      # Data contract class for type Data.
+      class Data < JsonSerializable
+        # Initializes a new instance of the Data class.
+        def initialize(options={})
+          defaults = {
+            'baseType' => nil,
+            'baseData' => nil
+          }
+          values = {
+            'baseData' => nil
+          }
+          super defaults, values, options
+        end
+        
+        # Gets the base_type property.
+        def base_type
+          return @values['baseType'] if @values.key?('baseType')
+          @defaults['baseType']
+        end
+        
+        # Sets the base_type property.
+        def base_type=(value)
+          if value == @defaults['baseType']
+            @values.delete 'baseType' if @values.key? 'baseType'
+          else
+            @values['baseType'] = value
+          end
+        end
+        
+        # Gets the base_data property.
+        def base_data
+          @values['baseData']
+        end
+        
+        # Sets the base_data property.
+        def base_data=(value)
+          @values['baseData'] = value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+require_relative 'json_serializable'
+
+module ApplicationInsights
+  module Channel
+    module Contracts
+      require_relative 'data_point_type'
+      # Data contract class for type DataPoint.
+      class DataPoint < JsonSerializable
+        # Initializes a new instance of the DataPoint class.
+        def initialize(options={})
+          defaults = {
+            'name' => nil,
+            'kind' => DataPointType::MEASUREMENT,
+            'value' => nil,
+            'count' => nil,
+            'min' => nil,
+            'max' => nil,
+            'stdDev' => nil
+          }
+          values = {
+            'name' => nil,
+            'kind' => DataPointType::MEASUREMENT,
+            'value' => nil
+          }
+          super defaults, values, options
+        end
+        
+        # Gets the name property.
+        def name
+          @values['name']
+        end
+        
+        # Sets the name property.
+        def name=(value)
+          @values['name'] = value
+        end
+        
+        # Gets the kind property.
+        def kind
+          return @values['kind'] if @values.key?('kind')
+          @defaults['kind']
+        end
+        
+        # Sets the kind property.
+        def kind=(value)
+          if value == @defaults['kind']
+            @values.delete 'kind' if @values.key? 'kind'
+          else
+            @values['kind'] = value
+          end
+        end
+        
+        # Gets the value property.
+        def value
+          @values['value']
+        end
+        
+        # Sets the value property.
+        def value=(value)
+          @values['value'] = value
+        end
+        
+        # Gets the count property.
+        def count
+          return @values['count'] if @values.key?('count')
+          @defaults['count']
+        end
+        
+        # Sets the count property.
+        def count=(value)
+          if value == @defaults['count']
+            @values.delete 'count' if @values.key? 'count'
+          else
+            @values['count'] = value
+          end
+        end
+        
+        # Gets the min property.
+        def min
+          return @values['min'] if @values.key?('min')
+          @defaults['min']
+        end
+        
+        # Sets the min property.
+        def min=(value)
+          if value == @defaults['min']
+            @values.delete 'min' if @values.key? 'min'
+          else
+            @values['min'] = value
+          end
+        end
+        
+        # Gets the max property.
+        def max
+          return @values['max'] if @values.key?('max')
+          @defaults['max']
+        end
+        
+        # Sets the max property.
+        def max=(value)
+          if value == @defaults['max']
+            @values.delete 'max' if @values.key? 'max'
+          else
+            @values['max'] = value
+          end
+        end
+        
+        # Gets the std_dev property.
+        def std_dev
+          return @values['stdDev'] if @values.key?('stdDev')
+          @defaults['stdDev']
+        end
+        
+        # Sets the std_dev property.
+        def std_dev=(value)
+          if value == @defaults['stdDev']
+            @values.delete 'stdDev' if @values.key? 'stdDev'
+          else
+            @values['stdDev'] = value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_relative 'json_serializable'
+
+module ApplicationInsights
+  module Channel
+    module Contracts
+      # Data contract class for type DataPointType.
+      class DataPointType
+        # Enumeration value MEASUREMENT.
+        MEASUREMENT = 0
+        
+        # Enumeration value AGGREGATION.
+        AGGREGATION = 1
+      end
+    end
+  end
+end