sensu-plugins-statful 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 264ccfabcd5eb485366a3357ae094fa8a70c628e
+  data.tar.gz: 6f8f768dd02937ee0da6bbdd41633b0ae25b2583
+SHA512:
+  metadata.gz: c26c6693b53cb1c9c1918cccbc7b8cb68ae347cd4e253493e7faffda2f6a33c34f46d31d485ac12c71d90441a5deb4d8d12ea93051a22a297b3978d5c484a8cd
+  data.tar.gz: e93b020d6b49d5f695d73b75993cdfe707d51419e320fc240eea39b7df555efa2bfc2dd484430b65abfcf15f9fff04621e1f9de54712c7f4ec75feea8a1e848e

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mindera
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+## Sensu-Plugins-Statful
+
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-statful.svg)](http://badge.fury.io/rb/sensu-plugins-statful)
+
+## Functionality
+
+## Files
+ * bin/metrics-statful.rb
+
+## Usage
+
+**metrics-statful**
+```
+{
+  "metrics-statful": {
+      "client": {
+        "transport": "http",
+        "token": "my_token",
+        "dryRun": true
+      },
+      "handler": {
+        "status": true,
+        "logging": true
+      }
+    }
+}
+```
+
+The example above will allow you to test the handler without actually ingest metrics into Statful - it will print the potential metrics to stdout.
+
+### Client
+
+The client section is used to configure the statful client that will ingest metrics into Statful.
+
+The configuration is the same as the statful-ruby-client detailed [here](https://github.com/statful/statful-client-ruby/blob/master/README.md#reference).
+
+Please note that the `flush_size` option will always be overwritten to `1` in order to actually ingest metrics since the sensu handler isn't long lived.
+
+### Handler
+
+The handler section is used to configure the behaviour of the handler itself as described in the table below:
+
+| Option | Description | Type | Default | Required |
+|:---|:---|:---|:---|:---|
+| _status_ | Defines if a metrics with the value of the check status should be sent. | `Boolean` | `false` | **NO** |
+| _logging_ | Defines the handler should log the statful client messages to the log. | `Boolean` | `false` | **NO** |
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Authors
+
+[Mindera - Software Craft](https://github.com/Mindera)
+
+## License
+
+Statful sensu plugins are available under the MIT license. See the [LICENSE](https://raw.githubusercontent.com/statful/sensu-plugins-statful/master/LICENSE) file for more information.

data/bin/metrics-statful.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+#
+#   metrics-statful.rb
+#
+# DESCRIPTION:
+#   Sensu handler to ingest metrics into statful (https://statful.com/).
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: statful-client
+#
+
+require 'sensu-handler'
+require 'statful-client'
+
+require_relative '../lib/logger_mixin.rb'
+
+class SensuMetricsStatful < Sensu::Handler
+  def initialize
+    super
+
+    @client_config = settings['metrics-statful']['client']
+
+    # Always flush on every metric since the sensu's handler isn't long lived
+    @client_config['flush_size'] = 1
+
+    @handler_config = settings['metrics-statful']['handler']
+
+    if logging?
+      # Log to stdout in order to be sent to sensu's log
+      @client_config['logger'] = Logger.new(STDOUT)
+    end
+
+    @statful = StatfulClient.new(@client_config)
+  end
+
+  def filter; end
+
+  def handle
+    check = @event['check']
+
+    check_metric = check['name']
+    check_timestamp = check['timestamp']
+    check_status = check['status']
+
+    if status_unknown?
+      if ingest_status?
+        ingest_status("status.#{check_metric}", check_status, check_timestamp)
+      end
+    else
+      if ingest_status?
+        ingest_status("status.#{check_metric}", check_status, check_timestamp)
+      end
+
+      begin
+        require_relative "../lib/parsers/#{check_metric}.rb"
+        check_value = Statful::Parser.parse(check['output'])
+        ingest_output("output.#{check_metric}", check_value, check_timestamp)
+      rescue LoadError
+        # Do not spam the log with unsupported checks messages
+        # puts "Check #{check_metric} not supported"
+        exit
+      end
+    end
+  end
+
+  private
+
+  def logging?
+    @handler_config['logging'].nil? ? false : @handler_config['logging']
+  end
+
+  def status_unknown?
+    @event['check']['status'] == 3
+  end
+
+  def ingest_status?
+    @handler_config['status'].nil? ? false : @handler_config['status']
+  end
+
+  def ingest_status(metric, status, timestamp)
+    @statful.put(metric, status, { :timestamp => timestamp });
+  end
+
+  def ingest_output(metric, value, timestamp)
+    @statful.put(metric, value, { :timestamp => timestamp });
+  end
+end

data/lib/logger_mixin.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+# Logger mixin to be injected on the statful client
+# This is needed in order to get dryrun to log to stdout
+class Logger
+  def debug(msg)
+    puts msg
+  end
+end

data/lib/parsers/check_cpu.rb

@@ -0,0 +1,17 @@
+
+module Statful
+  class Parser
+    # Parses the check_cpu output and returns the total percentage of cpu in use
+    def self.parse(output)
+      # Output example:
+      # CheckCPU TOTAL OK: total=19.19 user=17.17 nice=0.0 system=1.01 idle=80.81 iowait=0.0 irq=0.0 softirq=1.01 steal=0.0 guest=0.0
+
+      if !output.nil?
+        output.split(' ')[3].split('=')[1]
+      else
+        puts 'Check output is nil'
+        exit
+      end
+    end
+  end
+end

data/lib/parsers/check_keepalive.rb

@@ -0,0 +1,17 @@
+
+module Statful
+  class Parser
+    # Parses the check_keepalive output and returns the number of seconds since the last client keepalive
+    def self.parse(output)
+      # Output example:
+      # Keepalive sent from client -117 seconds ago
+
+      if !output.nil?
+        output.split(' ')[4].to_i.abs
+      else
+        puts 'Check output is nil'
+        exit
+      end
+    end
+  end
+end

data/lib/parsers/check_memory_percent.rb

@@ -0,0 +1,17 @@
+
+module Statful
+  class Parser
+    # Parses the check_memory_percent output and returns the percentage of memory in use
+    def self.parse(output)
+      # Output example:
+      # MEM OK - system memory usage: 6%
+
+      if !output.nil?
+        output.split(' ').last.split('%')[0]
+      else
+        puts 'Check output is nil'
+        exit
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-statful
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miguel Fonseca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: statful-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: Statful plugins for sensu (https://www.statful.com)
+email: miguel.fonseca@mindera.com
+executables:
+- metrics-statful.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/metrics-statful.rb
+- lib/logger_mixin.rb
+- lib/parsers/check_cpu.rb
+- lib/parsers/check_keepalive.rb
+- lib/parsers/check_memory_percent.rb
+homepage: https://github.com/statful/sensu-plugins-statful
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Statful plugins for sensu
+test_files: []