logstash-input-azuretable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1fb69c3c5e9bc8237619c21ccd2e43765d63941
+  data.tar.gz: 13703ef6bf23c484f9432ded4b265ea6b6c6f27c
+SHA512:
+  metadata.gz: ea4e019a1407cc9f13af6d181a84dc8627a5fda888145e272364b30f0d44a63b0758689f8830c0db250df5d565416227ee926143362ccb1b628470ac3618cf62
+  data.tar.gz: c612e0beb5b84b58624428170ac374e567f3fff1e62c6849cc0756b4ab57d31db68ba024f05f867273e5c4f881192136ae33a6456f5b9635cad4035762fe4f74

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+*  - 
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-azuretable
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,11 @@
+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,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/azuretable.rb

@@ -0,0 +1,174 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+require "time"
+require "azure"
+
+class LogStash::Inputs::Azuretable < LogStash::Inputs::Base
+  class Interrupred < StandardError; end
+
+  config_name "azuretable"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  # The message string to use in the event.
+  config :storage_sas_token, :validate => :string
+  config :table_name, :validate => :string
+  config :entity_count_to_process, :validate => :string, :default => 100
+  config :collection_start_time_utc, :validate => :string, :default => Time.now.utc.iso8601
+  config :etw_pretty_print, :validate => :boolean, :default => false
+  config :idle_delay_seconds, :validate => :number, :default => 15
+  config :endpoint, :validate => :string, :default => "core.windows.net"
+
+  # Default 1 minute delay to ensure all data is published to the table before querying.
+  # See issue #23 for more: https://github.com/Azure/azure-diagnostics-tools/issues/23
+  config :data_latency_minutes, :validate => :number, :default => 1
+
+  public
+  def register
+    @host = Socket.gethostname
+
+    Azure.configure do |config|
+      config.storage_sas_token = @account_name
+     end
+    @azure_table_service = Azure::Table::TableService.new
+    @last_timestamp = @collection_start_time_utc
+    @idle_delay = @idle_delay_seconds
+    @continuation_token = nil
+  end # def register
+
+  def run(queue)
+    while !stop?
+      @logger.debug("Starting process method @" + Time.now.to_s);
+      process(output_queue)
+      @logger.debug("Starting delay of: " + @idle_delay.to_s + " seconds @" + Time.now.to_s);
+      sleep @idle_delay
+    end # while
+  end # def run
+
+  def stop
+    # nothing to do in this case so it is not necessary to define stop
+    # examples of common "stop" tasks:
+    #  * close sockets (unblocking blocking reads/accepts)
+    #  * cleanup temporary files
+    #  * terminate spawned threads
+  end
+
+  def build_latent_query
+    @logger.debug("from #{@last_timestamp} to #{@until_timestamp}")
+    query_filter = "(PartitionKey gt '#{partitionkey_from_datetime(@last_timestamp)}' and PartitionKey lt '#{partitionkey_from_datetime(@until_timestamp)}')"
+    for i in 0..99
+      query_filter << " or (PartitionKey gt '#{i.to_s.rjust(19, '0')}___#{partitionkey_from_datetime(@last_timestamp)}' and PartitionKey lt '#{i.to_s.rjust(19, '0')}___#{partitionkey_from_datetime(@until_timestamp)}')"
+    end # for block
+    query_filter = query_filter.gsub('"','')
+    query_filter
+  end
+
+  def build_zero_latency_query
+    @logger.debug("from #{@last_timestamp} to most recent data")
+    # query data using start_from_time
+    query_filter = "(PartitionKey gt '#{partitionkey_from_datetime(@last_timestamp)}')"
+    for i in 0..99
+      query_filter << " or (PartitionKey gt '#{i.to_s.rjust(19, '0')}___#{partitionkey_from_datetime(@last_timestamp)}' and PartitionKey lt '#{i.to_s.rjust(19, '0')}___9999999999999999999')"
+    end # for block
+    query_filter = query_filter.gsub('"','')
+    query_filter
+  end
+
+  def process(output_queue)
+    if @data_latency_minutes > 0
+      @until_timestamp = (Time.now - (60 * @data_latency_minutes)).iso8601 unless @continuation_token
+      query_filter = build_latent_query
+    else
+      query_filter = build_zero_latency_query
+    end
+    @logger.debug("Query filter: " + query_filter)
+    query = { :top => @entity_count_to_process, :filter => query_filter, :continuation_token => @continuation_token }
+    result = @azure_table_service.query_entities(@table_name, query)
+    @continuation_token = result.continuation_token
+
+    if result and result.length > 0
+      @logger.debug("#{result.length} results found.")
+      last_good_timestamp = nil
+      result.each do |entity|
+        event = LogStash::Event.new(entity.properties)
+        event.set("type", @table_name)
+
+        # Help pretty print etw files
+        if (@etw_pretty_print && !event.get("EventMessage").nil? && !event.get("Message").nil?)
+          @logger.debug("event: " + event.to_s)
+          eventMessage = event.get("EventMessage").to_s
+          message = event.get("Message").to_s
+          @logger.debug("EventMessage: " + eventMessage)
+          @logger.debug("Message: " + message)
+          if (eventMessage.include? "%")
+            @logger.debug("starting pretty print")
+            toReplace = eventMessage.scan(/%\d+/)
+            payload = message.scan(/(?<!\\S)([a-zA-Z]+)=(\"[^\"]*\")(?!\\S)/)
+            # Split up the format string to seperate all of the numbers
+            toReplace.each do |key|
+              @logger.debug("Replacing key: " + key.to_s)
+              index = key.scan(/\d+/).join.to_i
+              newValue = payload[index - 1][1]
+              @logger.debug("New Value: " + newValue)
+              eventMessage[key] = newValue
+            end # do block
+            event.set("EventMessage", eventMessage)
+            @logger.debug("pretty print end. result: " + event.get("EventMessage").to_s)
+          end
+        end
+        decorate(event)
+        if event.get('PreciseTimeStamp').is_a?(Time)
+          event.set('PreciseTimeStamp', LogStash::Timestamp.new(event.get('PreciseTimeStamp')))
+        end
+        theTIMESTAMP = event.get('TIMESTAMP')
+        if theTIMESTAMP.is_a?(LogStash::Timestamp)
+          last_good_timestamp = theTIMESTAMP.to_iso8601
+        elsif theTIMESTAMP.is_a?(Time)
+          last_good_timestamp = theTIMESTAMP.iso8601
+          event.set('TIMESTAMP', LogStash::Timestamp.new(theTIMESTAMP))
+        else
+          @logger.warn("Found result with invalid TIMESTAMP. " + event.to_hash.to_s)
+        end
+        output_queue << event
+      end # each block
+      @idle_delay = 0
+      if (!last_good_timestamp.nil?)
+        @last_timestamp = last_good_timestamp unless @continuation_token
+      end
+    else
+      @logger.debug("No new results found.")
+      @idle_delay = @idle_delay_seconds
+    end # if block
+
+  rescue => e
+    @logger.error("Oh My, An error occurred.", :exception => e)
+    raise
+  end # process
+
+  # Windows Azure Diagnostic's algorithm for determining the partition key based on time is as follows:
+  # 1. Take time in UTC without seconds.
+  # 2. Convert it into .net ticks
+  # 3. add a '0' prefix.
+  def partitionkey_from_datetime(time_string)
+    collection_time = Time.parse(time_string)
+    if collection_time
+      @logger.debug("collection time parsed successfully #{collection_time}")
+    else
+      raise(ArgumentError, "Could not parse the time_string")
+    end # if else block
+
+    collection_time -= collection_time.sec
+    ticks = to_ticks(collection_time)
+    "0#{ticks}"
+  end # partitionkey_from_datetime
+
+  # Convert time to ticks
+  def to_ticks(time_to_convert)
+    @logger.debug("Converting time to ticks")
+    time_to_convert.to_i * 10000000 - TICKS_SINCE_EPOCH
+  end # to_ticks
+end # class LogStash::Inputs::Azuretable

data/logstash-input-azuretable.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-azuretable'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache License (2.0)']
+  s.summary       = 'WADLogsTable Logging'
+  s.description   = 'WADLogsTable Logging'
+  s.homepage      = ''
+  s.authors       = ['']
+  s.email         = ''
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # 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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_runtime_dependency 'azure', '~> 0.7.3'
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
+end

data/spec/inputs/azuretable_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/azuretable"
+
+describe LogStash::Inputs::Azuretable do
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "interval" => 100 } }
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-azuretable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ''
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-06-29 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-plugin-api
+  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'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  name: azure
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.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: WADLogsTable Logging
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/azuretable.rb
+- logstash-input-azuretable.gemspec
+- spec/inputs/azuretable_spec.rb
+homepage: ''
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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.6.4
+signing_key:
+specification_version: 4
+summary: WADLogsTable Logging
+test_files:
+- spec/inputs/azuretable_spec.rb