logstash-output-applicationinsights 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ee4596c361e88edab65f8aa680efe054dc22661
+  data.tar.gz: 6453ed63749c76d8d19411453dacdec2481f952f
+SHA512:
+  metadata.gz: 39b0079c0ee0add3155ec296a38fb56555595138feaddf997440ce2eb7f19e0ce304778aedb5d980d29ef3f994c805c10838cbd239877c24d9d3233d8f93935c
+  data.tar.gz: 6861932fb600a9bcb92b13030ff870af483b66776cccecc397a14385e253df0adca3dfe8f09ac6527b96b89230c0a7c51c9e40b60fb6ad0d06d211cf9f875561

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 2016.06.03
+* First version.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) Microsoft.  All rights reserved.
+Microsoft would like to thank its contributors, a list
+of whom are at http://aka.ms/entlib-contributors
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions
+and limitations under the License.

data/README.md

@@ -0,0 +1,61 @@
+# Logstash output plugin for Application Insights 
+
+## Summary
+
+
+## Installation
+You can install this plugin using the Logstash "plugin" or "logstash-plugin" (for newer versions of Logstash) command:
+```sh
+logstash-plugin install logstash-output-applicationinsights
+```
+For more information, see Logstash reference [Working with plugins](https://www.elastic.co/guide/en/logstash/current/working-with-plugins.html).
+
+## Configuration
+### Required Parameters
+__*ikey*__
+
+The Application Insights Instrumentation key.
+
+### Optional Parameters
+__*ai_message_field*__
+
+Specifies the name of the event field to be used as the Message field of the Application Insights trace. If not specified, Message in Application Insights will be "Null".
+
+__*ai_properties_field*__
+
+Specifies the name of the event field to be used as the Properties field of the Application Insights trace. The type of the field needs to be Hash. If not specified, all fields in event will be used.
+
+__*ai_severity_level_field*__
+
+Specifies the name of the event field to be used as the Severity level of the Application Insights trace. If not specified, all traces will be "Informational".
+
+__*ai_severity_level_mapping*__
+
+Specifies how to map the values read from *ai_severity_level_field* to Application Insights severity level. This is a hash containing the possible values from event as keys and corresponding Application Insights Severity Level constants as values.
+
+See example below for how to map [Azure diagnostics log level values](https://msdn.microsoft.com/en-us/library/azure/microsoft.windowsazure.diagnostics.loglevel.aspx) to [Application Insights severity values](https://github.com/Microsoft/ApplicationInsights-Ruby/blob/master/lib/application_insights/channel/contracts/severity_level.rb).
+
+__*dev_mode*__
+
+If this is set to True, the plugin sends telemetry to Application Insights immediately; otherwise the plugin respects production sending policies defined by other properties.
+
+### Examples
+```
+output
+{
+    applicationinsights
+    {
+        ikey => "00000000-0000-0000-0000-000000000000"
+        dev_mode => true
+        ai_message_field => "EventMessage"
+        ai_properties_field => "EventProperties"
+        ai_severity_level_field => "level"
+        ai_severity_level_mapping => { 5 => 0 4 => 1 3 => 2 2 => 3 1 => 4 0 => 4 }
+    }
+}
+```
+
+## More information
+The source code of this plugin is hosted in GitHub repo [Microsoft Azure Diagnostics with ELK](https://github.com/Azure/azure-diagnostics-tools). We welcome you to provide feedback and/or contribute to the project.
+
+Please also see [Analyze Diagnostics Data with ELK template](https://github.com/Azure/azure-quickstart-templates/tree/master/diagnostics-with-elk) for quick deployment of ELK to Azure.   

data/lib/logstash/outputs/applicationinsights.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "application_insights"
+
+include ApplicationInsights
+include ApplicationInsights::Channel
+
+class LogStash::Outputs::ApplicationInsights < LogStash::Outputs::Base
+  config_name "applicationinsights"
+
+  config :ikey, :validate => :string, :required => true
+  config :dev_mode, :validate => :boolean, :required => false, :default => false
+  config :ai_message_field, :validate => :string, :required => false, :default => nil
+  config :ai_properties_field, :validate => :string, :required => false, :default => nil
+  config :ai_severity_level_field, :validate => :string, :required => false, :default => nil
+  config :ai_severity_level_mapping, :validate => :hash, :required => false, :default => nil
+
+  public
+  def register
+     create_client
+  end # def register
+
+  public
+  def multi_receive(events)
+    events.each do |event|
+      begin
+        ai_message = get_ai_message(event)
+        ai_properties = get_ai_properties(event)
+        ai_severity = get_ai_severity(event)
+
+        @client.track_trace(ai_message, ai_severity, { :properties => ai_properties })
+        @client.flush if @dev_mode
+
+      rescue => e
+        @logger.error("Error occurred sending data to AI.", :exception => e)
+      end # begin
+    end # do 
+  end # def multi_receive
+  
+  def close
+    @client.flush
+  end # def close
+
+  def create_client
+    telemetry_context = TelemetryContext.new
+    async_queue = AsynchronousQueue.new(AsynchronousSender.new)
+    telemetry_channel = TelemetryChannel.new(telemetry_context, async_queue)
+    @client = TelemetryClient.new(@ikey, telemetry_channel)
+  end # def create_client
+  
+  def get_ai_message(event)
+    return nil if @ai_message_field.nil?
+    
+    ai_message = event[@ai_message_field] # Extracts specified field value as the AI Message.
+    @logger.warn("#{@ai_message_field} specified in ai_message_field not found in event data. AI Message will be null.") if ai_message.nil?
+    event.remove(@ai_message_field) unless ai_message.nil?  # Removes the duplicated AI Message field.
+    ai_message
+  end # def get_ai_message
+  
+  def get_ai_properties(event)
+    ai_properties = event.to_hash.fetch(@ai_properties_field, nil)
+    if !@ai_properties_field.nil? && ai_properties.nil?
+      @logger.warn("#{@ai_properties_field} specified in ai_properties_field not found in event data. Will use all fields in event as AI properties.")
+    end # if
+
+    ai_properties || event.to_hash
+  end # def get_ai_properties
+  
+  def get_ai_severity(event)
+    return nil if @ai_severity_level_field.nil? 
+
+    severity_value = event[@ai_severity_level_field]
+
+    if !@ai_severity_level_mapping.nil? && @ai_severity_level_mapping.any?
+      ai_severity_level = @ai_severity_level_mapping.fetch(severity_value, nil)
+    else
+      ai_severity_level = severity_value
+    end # unless
+
+    if ai_severity_level.nil?
+      @logger.warn("Cannot map value '#{severity_value}' from '#{@ai_severity_level_field}' to AI severity level. Will use default value.")
+    else
+      event.remove(@ai_severity_level_field)  # Removes the duplicated severity field.
+    end # if
+    
+    ai_severity_level
+  end # def get_ai_severity
+
+end # LogStash::Outputs::ApplicationInsights

data/logstash-output-applicationinsights.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-output-applicationinsights'
+  s.version         = '0.9.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This plugin sends data to Application Insights."
+  s.description     = "This gem is a Logstash plugin. It sends data to Application Insights."
+  s.authors         = ["Microsoft Corporation"]
+  s.email           = 'azdiag@microsoft.com'
+  s.homepage        = "https://github.com/Azure/azure-diagnostics-tools"
+  s.require_paths   = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash-core', '~> 2.0'
+  s.add_runtime_dependency 'application_insights', '~> 0.5.3'
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
+end

data/spec/outputs/applicationinsights_spec.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-applicationinsights
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Microsoft Corporation
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  name: application_insights
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+description: This gem is a Logstash plugin. It sends data to Application Insights.
+email: azdiag@microsoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/applicationinsights.rb
+- logstash-output-applicationinsights.gemspec
+- spec/outputs/applicationinsights_spec.rb
+homepage: https://github.com/Azure/azure-diagnostics-tools
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: This plugin sends data to Application Insights.
+test_files:
+- spec/outputs/applicationinsights_spec.rb