logstash-input-remote_proc 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dc453c833ce8e78a7d021ed114a74a8fd38aa8f
-  data.tar.gz: 879f625f49a7ae91399abadc6849ef696e785a04
+  metadata.gz: 7c02140e9d9c51731875a6506a1bdd0186c50b5d
+  data.tar.gz: fcd1d2f715390bba9b4bb71fed8c065d968e5b94
 SHA512:
-  metadata.gz: c38eea99b74cefcc1020f61d1790551b8f3f082e0d08d1aaaf864ada05b856ac83862ad17851318918bf48c0c5af3733ccb26e613414b4b74d872d4a40068e63
-  data.tar.gz: 298988574d97df4e0b2f48619d9b401c8c6d9777409a2f44973b33bfbd0dd6fa4f04c279d23794591fd4fb1423c3023332b620ad27ffe5f6968da84d4246df50
+  metadata.gz: f36c5471a1bf132ae0ef534c931c241e29e7ac1af2ead1f21a24d1233f8f12d14506cf686fa89349d47c111c86c0af03274e78fac23c75c6e88f913a0df81157
+  data.tar.gz: d27e517f6d4fbf25c20ece9eb6d8e42978c3c9c8305827593565b376c032013f2edba659b222bce91cd57fd810270a9deb82b173968c813ad4f6d6ca25b2ac92

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.8
+ - Add 'proc_prefix_path' for each server.
+
 ## 0.1.7
  - Update CHANGELOG.md.
 

data/USAGE.md

@@ -18,6 +18,8 @@ servers => [
         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
+        system_reader => "cat"                                 # :string
+        proc_prefix_path => "/proc"                            # :string
     }
 ]
 ```
@@ -27,7 +29,7 @@ When no password is given, the private key path for both `host` and `gateway_hos
 **Default values for `proc_list`**
 
 ```logstash
-proc_list => ["cpuinfo", "meminfo", "loadavg", "vmstat", "diskstats", "netdev", "netwireless", "mounts", "crypto", "sysvipcshm"]
+proc_list => ["cpuinfo", "stat", "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"]`.
@@ -35,75 +37,75 @@ If `proc_list` is not declared all of them are processed. An equivalent declarat
 ### SSH server with default values and authenticate by private key
 
 ```javascript
-    input { remote_proc { servers => [{}] } }
+input { remote_proc { servers => [{}] } }
 ```
 
 ### SSH server with default values and authenticate by private key for `cpuinfo` and `meminfo`
 
 ```javascript
-    input { remote_proc { servers => [{}] proc_list => ["cpuinfo", "meminfo"] } }
+input { remote_proc { servers => [{}] proc_list => ["cpuinfo", "meminfo"] } }
 ```
 
 ### With SSH server `host`, `port` and `username` and authenticate by private key
 
 ```javascript
-    input {
-        remote_proc {
-            servers => [
-                { host => "domain.com" port => 22 username => "fenicks" }
-            ]
-        }
+input {
+    remote_proc {
+        servers => [
+            { host => "domain.com" port => 22 username => "fenicks" }
+        ]
     }
+}
 ```
 
 ### With SSH server `host`, `port` and `username` and authenticate by a specific private key file
 
 ```javascript
-    input {
-        remote_proc {
-            servers => [
-                {
-                    host => "domain.com"
-                    port => 22
-                    username => "fenicks"
-                    ssh_private_key => "${HOME}/.ssh/id_rsa_domain.com"
-                }
-            ]
-        }
+input {
+    remote_proc {
+        servers => [
+            {
+                host => "domain.com"
+                port => 22
+                username => "fenicks"
+                ssh_private_key => "${HOME}/.ssh/id_rsa_domain.com"
+            }
+        ]
     }
+}
 ```
 
 ### With SSH server `host`, `port` and `username` and authenticate by password
 ```javascript
-    input {
-        remote_proc {
-            servers => [
-                {
-                    host => "domain.com"
-                    port => 22
-                    username => "fenicks"
-                    password => "my_password!"
-                }
-            ]
-        }
+input {
+    remote_proc {
+        servers => [
+            {
+                host => "domain.com"
+                port => 22
+                username => "fenicks"
+                password => "my_password!"
+            }
+        ]
     }
+}
 ```
 ### With SSH Gateway by with private key file and SSH `host` and `password`
 ```javascript
-    input {
-        remote_proc {
-            servers => [
-                {
-                    host => "domain.com"
-                    port => 22
-                    username => "fenicks"
-                    password => "my_password!"
-                    gateway_host => "gateway.com"
-                    gateway_username => "username_passemuraille"
-                    gateway_port => 4242
-                    gateway_ssh_private_key => "/path/to/private/key"
-                }
-            ]
-        }
+input {
+    remote_proc {
+        servers => [
+            {
+                host => "domain.com"
+                port => 22
+                username => "fenicks"
+                password => "my_password!"
+                gateway_host => "gateway.com"
+                gateway_username => "username_passemuraille"
+                gateway_port => 4242
+                gateway_ssh_private_key => "/path/to/private/key"
+            }
+        ]
     }
+}
 ```

data/lib/logstash/inputs/remote_proc.rb

@@ -63,24 +63,29 @@ module LogStash
         '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
+        'gateway_ssh_private_key' => nil, # :string
+        'system_reader' => 'cat', # :string
+        'proc_prefix_path' => '/proc' # :string
       }.freeze
 
       # Liste of commands for each `/proc` endpoints.
       COMMANDS = {
-        cpuinfo: 'cat /proc/cpuinfo',
-        stat: 'cat /proc/stat',
-        meminfo: 'cat /proc/meminfo',
-        loadavg: 'cat /proc/loadavg',
-        vmstat: 'cat /proc/vmstat',
-        diskstats: 'cat /proc/diskstats',
-        netdev: 'cat /proc/net/dev',
-        netwireless: 'cat /proc/net/wireless',
-        mounts: 'cat /proc/mounts',
-        crypto: 'cat /proc/crypto',
-        sysvipcshm: 'cat /proc/sysvipc/shm'
+        cpuinfo: '%{system_reader} %{proc_prefix_path}/cpuinfo',
+        stat: '%{system_reader} %{proc_prefix_path}/stat',
+        meminfo: '%{system_reader} %{proc_prefix_path}/meminfo',
+        loadavg: '%{system_reader} %{proc_prefix_path}/loadavg',
+        vmstat: '%{system_reader} %{proc_prefix_path}/vmstat',
+        diskstats: '%{system_reader} %{proc_prefix_path}/diskstats',
+        netdev: '%{system_reader} %{proc_prefix_path}/net/dev',
+        netwireless: '%{system_reader} %{proc_prefix_path}/net/wireless',
+        mounts: '%{system_reader} %{proc_prefix_path}/mounts',
+        crypto: '%{system_reader} %{proc_prefix_path}/crypto',
+        sysvipcshm: '%{system_reader} %{proc_prefix_path}/sysvipc/shm'
       }.freeze
 
+      # By default call all procfs method
+      DEFAULT_PROC_LIST = ['_all'].freeze
+
       config_name 'remote_proc'
 
       # If undefined, Logstash will complain, even if codec is unused.
@@ -121,7 +126,6 @@ module LogStash
 
         @ssh_sessions = []
         @ssh_gateways = []
-        @commands = ['_all']
 
         configure!
       end # def register
@@ -130,10 +134,10 @@ module LogStash
         # we can abort the loop if stop? becomes true
         until stop?
           @ssh_sessions.each do |ssh|
-            @commands.each do |method, command|
-              result_data = String.new('')
-              error_data = String.new('')
-              channel = ssh.open_channel do |chan|
+            ssh.open_channel do |chan|
+              chan.connection.options[:properties]['_commands'].each do |method, command|
+                result_data = String.new('')
+                error_data = String.new('')
                 chan.exec(command) do |ch, success|
                   next unless success
                   # "on_data" called when the process writes to stdout
@@ -142,30 +146,30 @@ module LogStash
                   ch.on_extended_data { |_ch, _type, data| error_data << data }
                   ch.on_close(&:close)
                 end
+                chan.wait
+                unless error_data.empty?
+                  error_data.chomp!
+                  error_data = error_data.force_encoding('UTF-8')
+                  @logger.warn(error_data)
+                  next
+                end
+                next if result_data.empty?
+                result = send("proc_#{method}",
+                              result_data.force_encoding('UTF-8'))
+                next if result.empty?
+                event = LogStash::Event.new(
+                  method => result,
+                  host: @host,
+                  type: @type || "system-#{method}",
+                  metric_name: "system-#{method}",
+                  remote_host: chan.connection.options[:properties]['host'],
+                  remote_port: chan.connection.options[:properties]['port'],
+                  command: command,
+                  message: result_data
+                )
+                decorate(event)
+                queue << event
               end
-              channel.wait
-              unless error_data.empty?
-                error_data.chomp!
-                error_data = error_data.force_encoding('UTF-8')
-                @logger.warn(error_data)
-                next
-              end
-              next if result_data.empty?
-              result = send("proc_#{method}",
-                            result_data.force_encoding('UTF-8'))
-              next if result.empty?
-              event = LogStash::Event.new(
-                method => result,
-                host: @host,
-                type: @type || "system-#{method}",
-                metric_name: "system-#{method}",
-                remote_host: channel.connection.options[:properties]['host'],
-                remote_port: channel.connection.options[:properties]['port'],
-                command: command,
-                message: result_data
-              )
-              decorate(event)
-              queue << event
             end
             ssh.loop
           end # @ssh_sessions block
@@ -181,16 +185,25 @@ module LogStash
       private
 
       # Return only valide property keys.
-      def prepare_servers!(data)
-        data.select! { |k| SERVER_OPTIONS.include?(k) }
-        data.merge!(SERVER_OPTIONS) { |_key_, old, _new_| old }
+      def prepare_servers!(server)
+        server.select! { |k| SERVER_OPTIONS.include?(k) }
+        server.merge!(SERVER_OPTIONS) { |_key_, old, _new_| old }
+        cmds = if (@proc_list - ['_all']).empty?
+                 COMMANDS.dup
+               else
+                 COMMANDS.select { |k, _| @proc_list.include?(k.to_s) }
+               end
+        # Replace 'system_reader' and 'proc_prefix_path' in all commands
+        server['_commands'] = cmds.each do |k, v|
+          cmds[k] = v % { system_reader: server['system_reader'],
+                          proc_prefix_path: server['proc_prefix_path'] }
+        end.freeze
       end
 
       # Prepare all server configuration
       def configure!
         @servers.each do |s|
           prepare_servers!(s)
-
           session_options = { properties: s }
           session_options[:port] = s['port'] if s['port']
           session_options[:password] = s['password'] if s['password']
@@ -218,11 +231,6 @@ 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.7'
+  s.version = '0.1.8'
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-remote_proc
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Christian Kakesa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-27 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement