logstash-input-remote_proc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 035fc8bc3778dcb99b27079eaf0d718d6046d52b
-  data.tar.gz: d33a58ba22ca37ac4de7e80d48714b99278e9b27
+  metadata.gz: 191511d2b37eb1608ff5c138f9fe22fa79c52291
+  data.tar.gz: beaf4d403fdbae4446f33015a6f0ae1e2b50cf4b
 SHA512:
-  metadata.gz: 83b1d89283ba50881e416746011b712bf63926c2397745f6233434f9808d61b5f62b5240921436c251c4d0cf51f6e520d36bb0bf5b4f8c6cd71a11233c0eb4ad
-  data.tar.gz: ec2b4d2a344848df5f17c3880970933e1084b435750c6a6253f2931c2c5aa6baf9ffe53e5fbd87a0eae28da572b7a1d9fe25d5a1b4ebe31c5c45c5ddacedc504
+  metadata.gz: 1a4d2f1d84fe9f45c2ac390089cc5c08f6e1fc332982c1dafaa19029ef09583cbd951be795d79eb83fc1cfb82c2bac153a2a63faa7a8c0c0426ccb1fa5c555ae
+  data.tar.gz: 51d29b71a54673362353ec1bcff7d9f3aa5f9adb39ca11515e97186dc03f292a3c46554cbf865835428a8be4adad88bb9db0fed5dadf44cc4dce885bc38c83af

data/USAGE.md

@@ -3,25 +3,35 @@ This plugin retrieves `/proc/*` metrics remotely via SSH connections.
 
 ## How to use
 
-**Default values**
+**Default values for `servers`**
 
-```ruby
-    SERVER_OPTIONS = {
-        'host' => 'localhost', # :string
-        'port' => 22, # :number
-        'ssh_private_key' => nil, # :path (needed if no 'password')
-        'username' => ENV['USER'] || ENV['USERNAME'] || 'nobody', # :string (default to unix $USER)
-        'password' => nil, # :string (needed if no 'ssh_private_key')
-        'gateway_host' => nil, # :string
-        'gateway_port' => 22, # :number
-        'gateway_username' => ENV['USER'] || ENV['USERNAME'] || 'nobody', # :string (default to unix $USER)
-        'gateway_password' => nil, # :string
-        'gateway_ssh_private_key' => nil # :string
-    }.freeze
+```logstash
+servers => [
+    {
+        host => "localhost"     # :string
+        port => 22              # :number
+        ssh_private_key => ...  # :path (needed if no 'password'), empty by default
+        username => ${USER} || ${USERNAME} || 'nobody' # :string (default to unix $USER)
+        password => ...                            # :string (needed if no 'ssh_private_key'), empty by default
+        gateway_host => ...                        # :string (if set, gateway is used), empty by default
+        gateway_port => 22                         # :number
+        gateway_username => ${USER} || ${USERNAME} || 'nobody' # :string (default to unix $USER)
+        gateway_password => ...                                # :string (needed if gateway_host is set and no 'ssh_private_key' is given), empty by default
+        gateway_ssh_private_key => ...                         # :path (needed if no 'gateway_password'), empty by default
+    }
+]
 ```
 
 When no password is given, the private key path for both `host` and `gateway_host` are : `$HOME/.ssh/id_dsa`, `$HOME/.ssh2/id_dsa`, `$HOME/.ssh/id_rsa`, and `$HOME/.ssh2/id_rsa`.
 
+**Default values for `proc_list`**
+
+```logstash
+proc_list => ["cpuinfo", "meminfo", "loadavg", "vmstat", "diskstats", "netdev", "netwireless", "mounts", "crypto", "sysvipcshm"]
+```
+
+If `proc_list` is not declared all of them are processed. An equivalent declaration is `proc_file => ["_all"]`.
+
 ### SSH server with default values and authenticate by private key
 
 ```javascript

data/lib/logstash/inputs/remote_proc.rb

@@ -78,6 +78,23 @@ module LogStash
       # The default values are specified in `#{SERVER_OPTIONS}` hash.
       config :servers, validate: :hash, list: true, required: true
 
+      # List of PROFS information to retrieve
+      #
+      # Valid values are:
+      #
+      # [source,ruby]
+      # ------------------------------------------------------------------------
+      # %w(
+      #   cpuinfo meminfo loadavg vmstat diskstats
+      #   netdev netwireless mounts crypto sysvipcshm
+      #  )
+      # ------------------------------------------------------------------------
+      #
+      # By default all metrics are retrieved.
+      config :proc_list,
+             validate: :array,
+             default: ['_all']
+
       # Set how frequently messages should be sent.
       #
       # The default, `60`, means send a message every second.
@@ -88,20 +105,19 @@ module LogStash
 
         require 'net/ssh'
         require 'net/ssh/gateway'
-        @ssh_sessions = []
 
-        # Don't forget to close all gateways manually in `stop` method.
+        @ssh_sessions = []
         @ssh_gateways = []
+        @commands = ['_all']
 
-        # Handle server configuration
-        configure_servers
+        configure!
       end # def register
 
       def run(queue)
         # we can abort the loop if stop? becomes true
         until stop?
           @ssh_sessions.each do |ssh|
-            COMMANDS.each do |method, command|
+            @commands.each do |method, command|
               result_data = String.new('')
               error_data = String.new('')
               channel = ssh.open_channel do |chan|
@@ -158,7 +174,7 @@ module LogStash
       end
 
       # Prepare all server configuration
-      def configure_servers
+      def configure!
         @servers.each do |s|
           prepare_servers!(s)
 
@@ -189,6 +205,11 @@ module LogStash
                                             session_options)
           end
         end
+        @commands = if (@proc_list - ['_all']).empty?
+                      COMMANDS
+                    else
+                      COMMANDS.select { |k, _| @proc_list.include?(k.to_s) }
+                    end
       end
 
       # Process SYSVIPCSHM data

data/logstash-input-remote_proc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-input-remote_proc'
-  s.version = '0.1.1'
+  s.version = '0.1.2'
   s.licenses = ['Apache-2.0']
   s.summary = 'This Logstash plugin collects PROCFS metrics through remote SSH servers.'
   s.description = 'This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-remote_proc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Christian Kakesa