observium-agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81d722138539283adf3e5e292761d3d2d6a9aa08
+  data.tar.gz: 2dda368805a064fa459b367886b6e0643a56574e
+SHA512:
+  metadata.gz: a959cd3319e53dd9c257e7c06b9b0aee9afeb67c1da70e63f854b421e7137fdcef504d37e8ed6c180b2982c91cce25de9ab050486cc0ef4be37cd65cc1763f0b
+  data.tar.gz: 2a54d0faa54f87ca47cbb55945f9fd5cf9a17742cf30319e5d5e2db0e6999d3dc089d03022d0b1e8de7b735701f8d0a492b68214f39a2bc230465e57c257a460

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in observium-agent.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Robert McLeod
+
+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,51 @@
+# Observium::Agent
+
+This gem provides a way to get data from an Observium or Check_MK agent using ruby.  
+It polls the information, and parses the output allowing you to use the information
+wherever you need it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'observium-agent'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install observium-agent
+
+## Usage
+
+Here's how to use the gem in your code, it's pretty simple:
+
+```ruby
+# Poll and parse
+output = Observium::Agent::Poller.new("host.example.com").poll
+parser = Observium::Agent::Parser.new(output)
+
+# See what sections are available
+parser.sections # ["dmi", "dpkg", "kernel", "ps", "uptime"]
+
+# or check if a section is available
+parser.has_section? "dmi" # we will be using :symbols soon
+
+# Get the section and dump a field
+dmi = parser.section "dmi"
+puts dmi[:processor_version] # outputs Genuine Intel(R) CPU N270 @ 1.60GHz
+```
+
+## Future plans
+
+We want to make it so you can keep your agent ports closed but still access the agent securely.  We hope to do this through the use of an optional SSH proxy.
+
+## Contributing
+
+1. Fork it ( http://github.com/AutogrowSystems/observium-agent/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/observium/agent.rb

@@ -0,0 +1,18 @@
+require "observium/agent/version"
+require "observium/agent/errors"
+require "observium/agent/poller"
+require "observium/agent/parser"
+
+module Observium
+  module Agent
+    extend self
+
+    def defaults
+      {
+        port: 6556,
+        timeout: 5
+      }
+    end
+
+  end
+end

data/lib/observium/agent/errors.rb

@@ -0,0 +1,8 @@
+module Observium
+  module Agent
+    module Errors
+      class PollingFailed < StandardError; end
+      class ParsingFailed < StandardError; end
+    end
+  end
+end

data/lib/observium/agent/parser.rb

@@ -0,0 +1,65 @@
+module Observium
+  module Agent
+    class Parser
+      attr_reader :sections
+
+      def initialize(text)
+        @text = text
+
+        validate!
+        preprocess
+      end
+
+      def section(title, postprocess=true)
+        return {} unless has_section?(title)
+        
+        index = @lines.index("<<<#{title}>>>")
+
+        array = []
+        @lines[(index+1)..@lines.size].each do |line|
+          break if line.include? "<<<"
+          array << line
+        end
+
+        return array.join("\n") unless postprocess
+
+        hash = Hash.new
+        array.each do |line|
+          if m = line.match(/^(\S+)=(.*)$/)
+            hash[ symbolize_field( m[1] ) ] = m[2]
+          end
+        end
+
+        hash
+      end
+
+      def has_section?(title)
+        @sections.include? title
+      end
+
+      def symbolize_field(field)
+        field.downcase!
+        field.tr! "-", "_"
+        field.to_sym
+      end
+
+      private
+
+      def validate!
+        valid_text? or raise Errors::ParsingFailed, "Invalid text passed to the parser"
+      end
+
+      def valid_text?
+        !@text.nil? and
+        !@text.strip.empty? and
+        !@text.lines.count.zero? and
+        @text.lines.count != 1
+      end
+
+      def preprocess
+        @lines = @text.split("\n")
+        @sections = @text.scan(/<<<([^>]*)>>>/).map {|s| s.first }
+      end
+    end
+  end
+end

data/lib/observium/agent/poller.rb

@@ -0,0 +1,39 @@
+module Observium
+  module Agent
+    class Poller
+      def initialize(host, **args)
+        @host    = host
+        @port    = args[:port]    || Observium::Agent.defaults[:port]
+        @timeout = args[:timeout] || Observium::Agent.defaults[:timeout]
+      end
+
+      # Connects to the given host on the agent port to get the agent
+      # output.  Connection times out after 5 seconds.
+      # 
+      # Raises a PollingFailed error if no data was output, or the command failed
+      #
+      # Returns the raw output returned by the agent as a multiline string
+      def poll
+        @output = %x(nc -w #{@timeout} #{@host} #{@port} 2>&1)
+        
+        $?.success? or raise Errors::PollingFailed, "Agent check failed: #{error_msg}"
+        has_data?   or raise Errors::PollingFailed, "Agent didn't return any data"
+
+        @output
+      end
+
+      private
+
+      # Checks if the agent returned any data, usually signified by more than a
+      # single line being present in the output
+      def has_data?
+        @output.lines.count > 1
+      end
+
+      # Parses the error message from the netcat error output to stderr
+      def error_msg
+        @output.split(":").last.strip
+      end
+    end
+  end
+end

data/lib/observium/agent/version.rb

@@ -0,0 +1,5 @@
+module Observium
+  module Agent
+    VERSION = "0.1"
+  end
+end

data/observium-agent.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'observium/agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "observium-agent"
+  spec.version       = Observium::Agent::VERSION
+  spec.authors       = ["Robert McLeod"]
+  spec.email         = ["robert@autogrow.com"]
+  spec.summary       = %q{Ruby gem to interface with Observium Agents}
+  spec.description   = %q{Interface with Observium Agents using ruby to gather system information}
+  spec.homepage      = "https://github.com/AutogrowSystems/observium-agent-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: observium-agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Robert McLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Interface with Observium Agents using ruby to gather system information
+email:
+- robert@autogrow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/observium/agent.rb
+- lib/observium/agent/errors.rb
+- lib/observium/agent/parser.rb
+- lib/observium/agent/poller.rb
+- lib/observium/agent/version.rb
+- observium-agent.gemspec
+homepage: https://github.com/AutogrowSystems/observium-agent-gem
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem to interface with Observium Agents
+test_files: []