logstash-input-perfmon 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 912cecdb5d9d7caa1b6010d2c5d544bbb258ca52
+  data.tar.gz: 180877863382a2cc1f719e08f53ef5b6e9b8d67e
+SHA512:
+  metadata.gz: a38105130ea4f3e34ef586b88274febc153e95590996d0c096ea35bc25888e84d638c3428c611934acea4e0ae7673c6df9012b29311b950a57cf57c4f6963d80
+  data.tar.gz: 8dc370b3de33743434a8c80d9f01ac9913b61b2b007e83a7f06bf7e3bd21d2c432e6f6d46fb319c371822ab588dd7fff2b673a748a357aca742c0f2c11a29083

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+Gemfile.bak
+.bundle
+vendor

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+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,76 @@
+# Perfmon Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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
+
+On Windows, performance metrics can be collected using [Windows Performance Monitor](https://technet.microsoft.com/en-us/library/cc749249.aspx).
+This plugin collects the same sort of counters by using the command-line tool [Typeperf](https://technet.microsoft.com/en-us/library/bb490960.aspx).
+
+To run the tests (be sure that JRuby is installed prior):
+```
+git clone https://github.com/NickMRamirez/logstash-input-perfmon.git
+cd logstash-input-perfmon
+jruby -S bundle install
+jruby -S bundle exec rspec spec
+```
+
+To build the gem:
+```
+git clone https://github.com/NickMRamirez/logstash-input-perfmon.git
+cd logstash-input-perfmon
+gem build logstash-input-perfmon.gemspec
+```
+
+To install the gem to logstash:
+```
+cd path\to\logstash\bin
+plugin install path\to\gem
+```
+	
+Create a configuration file. The following collects three metrics every ten seconds:
+```ruby
+input {
+  perfmon {
+	interval => 10 
+	  counters => [
+		"\Processor(_Total)\% Privileged Time",
+		"\Processor(_Total)\% Processor Time", 
+		"\Processor(_Total)\% User Time"]
+  }
+}
+
+filter {
+  grok {
+	match => {
+	  "message" => "%{DATESTAMP:Occurred},%{NUMBER:PrivilegedTime:float},%{NUMBER:ProcessorTime:float},%{NUMBER:UserTime:float}"
+	}
+  }
+}
+
+output {
+  file {
+	path => "C:\perfmon_output.txt"
+  }
+}
+```
+
+This configuration will produce output like:
+```json
+{
+  "message":"06/05/2015 15:40:46.999,0.781236,7.032877,6.249891",
+  "@version":"1",
+  "@timestamp":"2015-06-05T19:40:48.468Z",
+  "Occurred":"06/05/2015 15:40:46.999",
+  "PrivilegedTime":0.781236,
+  "ProcessorTime":7.032877,
+  "UserTime":6.249891
+}
+```
+
+Run logstash:
+```
+    logstash -f C:\path\to\conf
+```

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash/inputs/perfmon.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "socket" # for Socket.gethostname
+require_relative "typeperf_wrapper"
+
+# This input will pull metrics from https://technet.microsoft.com/en-us/library/cc749249.aspx[Windows Performance Monitor].
+# Under the covers, it uses https://technet.microsoft.com/en-us/library/bb490960.aspx[Typeperf].
+#
+# To collect performance measurements, use a config like:
+# [source,ruby]
+#     input {
+#       perfmon {
+#         interval => 10
+#         counters => [
+#           "\Processor(_Total)\% Privileged Time",
+#           "\Processor(_Total)\% Processor Time", 
+#           "\Processor(_Total)\% User Time"]
+#       }
+#     }
+
+#     filter {
+#       grok {
+#         match => {
+#           "message" => "%{DATESTAMP:Occurred},%{NUMBER:PrivilegedTime:float},%{NUMBER:ProcessorTime:float},%{NUMBER:UserTime:float}"
+#       }
+#     }
+#   }
+class LogStash::Inputs::Perfmon < LogStash::Inputs::Base
+  attr_reader :counters, :interval
+  
+  config_name "perfmon"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain" 
+  
+  # Sets which perfmon counters to collect
+  config :counters, :validate => :array, :required => false, :default => [
+    "\\Processor(_Total)\\% Processor Time",
+    "\\Processor Information(_Total)\\% User Time", 
+    "\\Process(_Total)\\% Privileged Time"]
+
+  # Sets the frequency, in seconds, at which to collect perfmon metrics
+  config :interval, :validate => :number, :required => false, :default => 10
+  
+  #------------Public Methods--------------------
+  public
+  
+  # Registers the plugin with logstash
+  def register
+    @host = Socket.gethostname
+    @typeperf = TypeperfWrapper.new(PerfmonProcGetter.new, @interval)
+    @counters.each { |counter| @typeperf.add_counter(counter) }
+  end
+
+  # Runs the perf monitor and monitors its output
+  def run(queue)
+    @typeperf.start_monitor
+	
+    @logger.debug("Started perfmon monitor")
+
+    while @typeperf.alive?
+      data = @typeperf.get_next
+
+      @codec.decode(data) do |event|
+        decorate(event)
+        queue << event
+        @logger.debug("Added event to queue: #{event}")
+      end
+    end
+  end 
+
+  # Cleans up any resources
+  def teardown
+    @typeperf.stop_monitor
+    @logger.debug("Stopped the perfmon monitor")
+    finished
+  end
+
+end

data/lib/logstash/inputs/perfmon_proc_getter.rb

@@ -0,0 +1,72 @@
+class PerfmonProcGetter
+  attr_reader :pid
+  
+  # Initializes the PerfmonProcGetter class
+  def initialize
+    @all_counters = `#{get_all_counters_command}`
+  end
+  
+  # Creates a new process that runs typeperf to collect perfmon metrics
+  # [counters] Array of counter names, such as ["\\Processor(_Total)\\% Processor Time"]
+  # [interval] The number, in seconds, to wait between each round of collecting metrics
+  # [output_queue] The queue to add each new message to
+  def start_process(counters, interval, output_queue)
+    cmd = get_typeperf_command(counters, interval)
+	  
+    IO.popen(cmd) do |f|
+      @pid = f.pid
+
+      f.each do |line| 
+        next if counters.any? { |counter| line.include? counter } # don't show lines that contain headers
+		line.gsub!('"', '') # remove quotes
+		line.strip!
+        output_queue << line
+      end
+    end
+  end
+  
+  # Kills the typeperf process
+  def stop_process
+    Process.kill(9, @pid) 
+    @pid = nil
+  end
+  
+  # Gets a value indicating whether the typeperf
+  # process is currently running
+  def proc_is_running?
+    if @pid.nil?
+      return false
+    else
+      return true
+    end
+  end
+  
+  # Gets a value indicating whether the given counter 
+  # exists on the system
+  # [counter_name] The name of the counter, such as "\\Processor(_Total)\\% Processor Time"
+  def counter_exists?(counter_name)
+    counter_name = counter_name.gsub(/\(.+\)/, '(*)')
+    return @all_counters.downcase.include?(counter_name.downcase)
+  end
+  
+  # Gets the typeperf command line
+  # [counters] Array of counter names, such as ["\\Processor(_Total)\\% Processor Time"]
+  # [interval] The number, in seconds, to wait between each round of collecting metrics
+  def get_typeperf_command(counters, interval)
+    cmd = "typeperf "
+    counters.each { |counter| cmd << "\"#{counter}\" " }
+    cmd << "-si #{interval.to_s} "
+    return cmd.strip!
+  end
+  
+  # Gets the command line that lists all available 
+  # perf counters on the system
+  def get_all_counters_command
+    "typeperf -q"
+  end
+  
+  # Waits until the typeperf process is running
+  def wait_for_process_to_start
+    sleep 0.5 until proc_is_running?
+  end
+end

data/lib/logstash/inputs/typeperf_wrapper.rb

@@ -0,0 +1,62 @@
+require 'win32/process'
+require_relative 'perfmon_proc_getter'
+
+# Wraps the typeperf command-line tool, used to get 
+# Windows performance metrics
+class TypeperfWrapper
+  attr_reader :counters
+  
+  # Initializes the TypeperfWrapper class
+  # [perfmon_proc_getter] Gets the proc for opening the perfmon process and getting messages
+  # [interval] The time between samples, defaults to ten seconds
+  def initialize(perfmon_proc_getter, interval = 10)
+    @interval = interval
+    @perfmon_proc_getter = perfmon_proc_getter
+    @counters = []
+    @msg_queue = Queue.new
+  end
+  
+  # Adds a counter to the list of counters watched
+  # [counter_name] The path to the counter, such as "\\processor(_total)\\% processor time"
+  def add_counter(counter_name)
+    raise 'Perfmon counter could not be found.' unless @perfmon_proc_getter.counter_exists?(counter_name)
+    @counters << counter_name.downcase
+  end
+  
+  # Begins monitoring, using the counters in the @counters array
+  # [interval] The time between samples, defaults to ten seconds
+  def start_monitor
+    raise "No perfmon counters defined" if @counters.compact.empty?
+    open_thread_and_do_work()
+  end
+  
+  # Stops monitoring
+  def stop_monitor
+    @perfmon_proc_getter.stop_process
+  end
+  
+  # Gets a value indicating whether the typeperf process is running
+  def alive?
+    @perfmon_proc_getter.proc_is_running?
+  end
+  
+  # Waits until a new message is put onto the queue, then returns it
+  def get_next
+    while @msg_queue.empty?
+      sleep 0.5 
+    end
+	
+    @msg_queue.pop
+  end
+  
+  #-------------Private methods----------------
+  private
+  
+  def open_thread_and_do_work
+    @t1 = Thread.new do
+	  @perfmon_proc_getter.start_process(@counters, @interval, @msg_queue)
+    end
+	
+    @perfmon_proc_getter.wait_for_process_to_start
+  end
+end

data/logstash-input-perfmon.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-input-perfmon'
+  s.version = '0.1.1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "Logstash input for Windows Performance Monitor"
+  s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program. Logstash input for Windows Performance Monitor metrics."
+  s.authors = ["Nick Ramirez"]
+  s.email = 'nickram44@hotmail.com'
+  s.homepage = "https://github.com/NickMRamirez/logstash-input-perfmon"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+  
+  # 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", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'win32-process'
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/inputs/perfmon_proc_getter_spec.rb

@@ -0,0 +1,25 @@
+# To run: jruby -S bundle exec rspec -fd spec
+require "logstash/devutils/rspec/spec_helper"
+require_relative '../../lib/logstash/inputs/perfmon_proc_getter.rb'
+
+describe 'UnitTests' do
+  describe 'PerfmonProcGetter' do
+    
+	subject(:getter) { PerfmonProcGetter.new }
+	
+	describe 'get_typeperf_command' do
+	  it 'should be expected command' do
+	    result = getter.get_typeperf_command(["test_counter", "test_counter_2"], 1)
+		expect(result).to eq 'typeperf "test_counter" "test_counter_2" -si 1'
+	  end
+	end
+	
+	describe 'get_all_counters_command' do
+	  it 'should be expected command' do
+	    result = getter.get_all_counters_command
+		expect(result).to eq 'typeperf -q'
+	  end
+	end
+	
+  end
+end

data/spec/inputs/perfmon_spec.rb

@@ -0,0 +1,45 @@
+require "logstash/devutils/rspec/spec_helper"
+require_relative '../../lib/logstash/inputs/perfmon'
+
+describe 'IntegrationTests' do
+  describe 'Perfmon' do
+  
+    subject(:plugin) do
+	  LogStash::Inputs::Perfmon.new(
+		  "interval" => 1,
+		  "counters" => ["\\processor(_total)\\% processor time"]
+		)
+	end
+  
+    describe 'initialize' do
+      it 'assigns counters and interval' do
+		expect(plugin.counters).to eq ["\\processor(_total)\\% processor time"]
+		expect(plugin.interval).to eq 1
+	  end
+    end
+	
+	describe 'run' do
+	  it 'starts listening for perf metrics' do
+	    my_queue = Queue.new
+		
+		plugin.register
+		
+		Thread.new do
+		  plugin.run(my_queue)
+		end
+		
+		# It can take a few seconds for it to start collecting metrics
+		# Wait up to 60 seconds
+		60.times do
+		  break unless my_queue.empty?
+		  sleep 1
+		end
+		
+		expect(my_queue).not_to be_empty
+		
+		plugin.teardown
+	  end
+	end
+	
+  end
+end

data/spec/inputs/typeperf_wrapper_spec.rb

@@ -0,0 +1,128 @@
+# To run: jruby -S bundle exec rspec -fd spec
+require "logstash/devutils/rspec/spec_helper"
+require_relative '../../lib/logstash/inputs/typeperf_wrapper.rb'
+
+class MockPerfmonProcGetter
+  def start_process(counters, interval, output_queue)
+	output_queue << "Test msg 1" 
+	output_queue << "Test msg 2" 
+	output_queue << "Test msg 3" 
+  end
+  
+  def wait_for_process_to_start
+    sleep 1
+  end
+  
+  def counter_exists?(counter_name)
+    true
+  end
+end
+
+describe 'UnitTests' do
+  describe 'TypeperfWrapper' do
+    subject(:perfmon_proc_getter) do 
+      MockPerfmonProcGetter.new
+    end
+  
+    subject(:wrapper) { TypeperfWrapper.new(perfmon_proc_getter) }
+  
+    describe 'initialize' do
+      it 'should initialize the counters array to empty' do
+	    expect(wrapper.counters).to be_empty
+      end
+    end
+  
+    describe 'add_counter' do
+      it 'should add a counter to the array' do
+        wrapper.add_counter '\\processor(_total)\\% processor time'
+	    expect(wrapper.counters.count).to eq 1
+      end
+	
+	  it 'should convert the counter name to lowercase' do
+	    wrapper.add_counter '\\Processor(_total)\\% Processor Time'
+	    expect(wrapper.counters[0]).to eq '\\processor(_total)\\% processor time'
+	  end
+    end
+	
+	describe 'start_monitor' do
+	  it 'should add messages to the message queue' do
+	    wrapper.add_counter '\\Processor(_total)\\% Processor Time'
+		wrapper.start_monitor
+		msg1 = wrapper.get_next
+		msg2 = wrapper.get_next
+		msg3 = wrapper.get_next
+		
+		expect(msg1).to eq "Test msg 1"
+		expect(msg2).to eq "Test msg 2"
+		expect(msg3).to eq "Test msg 3"
+	  end
+	end
+	
+	describe 'get_next' do
+	  it 'waits for message and then returns it' do
+	    # Start waiting for messages now, before any are available
+		msg = nil
+		Thread.new do
+		  msg = wrapper.get_next
+		end
+		
+		# Now add a message
+		wrapper.add_counter '\\Processor(_total)\\% Processor Time'
+		wrapper.start_monitor
+		
+		# Should be seen by get_next
+		sleep 2
+		expect(msg).to eq "Test msg 1"
+	  end
+	end
+
+  end
+end
+
+
+
+
+
+describe 'IntegrationTests' do
+  describe 'TypeperfWrapper' do
+    subject(:perfmon_proc_getter) do 
+      PerfmonProcGetter.new
+    end
+  
+    subject(:wrapper) { TypeperfWrapper.new(perfmon_proc_getter) }
+	
+	describe 'start_monitor' do
+      it 'should raise error if no counters are defined' do
+	    expect { wrapper.start_monitor }.to raise_error('No perfmon counters defined')
+	  end
+	
+	  it 'should start the process running' do
+	    wrapper.add_counter '\\Processor(_total)\\% Processor Time'
+	    wrapper.start_monitor
+	    expect(wrapper.alive?).to eq true
+	    wrapper.stop_monitor
+	  end
+    end
+  
+    describe 'stop_monitor' do
+      it 'should stop the monitor thread' do
+	    wrapper.add_counter '\\Processor(_total)\\% Processor Time'
+	    wrapper.start_monitor
+	    wrapper.stop_monitor
+	    expect(wrapper.alive?).to eq false
+	  end
+    end
+  
+    describe 'alive?' do
+      it 'is false when monitor has not been started' do
+	    expect(wrapper.alive?).to eq false
+	  end
+    end
+	
+	describe 'add_counter' do
+	  it 'raises error when counter is not found' do
+	    expect { wrapper.add_counter('\\Nada(_total)\\% DoesntExist') }.to raise_error 'Perfmon counter could not be found.'
+	  end
+	end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-perfmon
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nick Ramirez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: win32-process
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
+  a stand-alone program. Logstash input for Windows Performance Monitor metrics.
+email: nickram44@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/inputs/perfmon.rb
+- lib/logstash/inputs/perfmon_proc_getter.rb
+- lib/logstash/inputs/typeperf_wrapper.rb
+- logstash-input-perfmon.gemspec
+- spec/inputs/perfmon_proc_getter_spec.rb
+- spec/inputs/perfmon_spec.rb
+- spec/inputs/typeperf_wrapper_spec.rb
+homepage: https://github.com/NickMRamirez/logstash-input-perfmon
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Logstash input for Windows Performance Monitor
+test_files:
+- spec/inputs/perfmon_proc_getter_spec.rb
+- spec/inputs/perfmon_spec.rb
+- spec/inputs/typeperf_wrapper_spec.rb