livestatus-client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee718d293c12df414dd19bfc044acad024e2c084
+  data.tar.gz: fef5cab8aae86823270f487ae5e5e7b98e7e50d9
+SHA512:
+  metadata.gz: 70845d3b93ee369510be5b1ebf219768cd7cb16d17f2f34bd37044d89446775cdf28600d301d04b94692a4f86af99b4473c564f606f75cae15750c4df2c70b2b
+  data.tar.gz: 857a0fe3c730df07bb5cafe777bd77a6e87313d0170f8440902a3f37f0c80c4d43733d894f24d99cbdd9dfcc544298926fca862b505ddaec0bce8e7bd8d37ddf

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+LATEST_CHANGELOG.md

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eric Herot
+
+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,80 @@
+# LivestatusClient
+
+This is a very "lightweight" command line client (written in Ruby) for the [MK Livestatus](http://mathias-kettner.de/checkmk_livestatus.html) Nagios module.
+
+It makes simple queries and commands against the Livestatus API and returns slightly parsed JSON responses. Filters and complex queries (beyond just requesting particular data types and columns) are not yet supported.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install livestatus-client
+
+## Usage
+
+Run the `livestatus` executable:
+
+```bash
+$ livestatus --help
+Options:
+  -h, --host=<s>         Livestatus host
+  -p, --port=<s>         Livestatus port
+  -q, --query=<s>        The query string
+  -l, --columns=<s>      Which columns to display (comma separated)
+  -i, --list             List available columns
+  -c, --command=<s>      Command to send
+  -a, --arguments=<s>    Command argumenets (comma separated)
+  -e, --help             Show this message
+```
+
+### Listing hosts with any configured downtimes
+
+```bash
+$ livestatus -h 10.99.0.1 -p 50000 -q hosts -l downtimes
+```
+
+This should return something like this:
+```json
+{
+  "default-ubuntu-1404": {
+    "downtimes": [
+
+    ]
+  },
+  "stage-api": {
+    "downtimes": [
+
+    ]
+  },
+  "test-dns": {
+    "downtimes": [
+      1483559124159689
+    ]
+  }
+}
+```
+
+### Configuring a service downtime
+
+```bash
+$ livestatus \
+    -h 10.99.0.1 -p 50000 \
+    -c SCHEDULE_HOST_DOWNTIME \
+    -a 'server-ubuntu-1404,1483644522,1483644523,1,0,0,yourname,Some downtime coment'
+```
+
+[Valid Nagios external commands](https://old.nagios.org/developerinfo/externalcommands/commandlist.php) (Click on individual commands for the argument syntax. Note that the script replaces `,` with `;` to prevent conflicts with the shell)
+
+### To get a list of valid columns for a data type
+
+```bash
+$ livestatus -h 10.99.0.1 -p 50000 -q hosts --list
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evertrue/livestatus-client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "livestatus/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/livestatus

@@ -0,0 +1,4 @@
+require 'livestatus-client/version'
+require 'livestatus-client'
+
+LivestatusClient.new.run

data/lib/livestatus-client.rb

@@ -0,0 +1,147 @@
+require 'livestatus-client/version'
+require 'trollop'
+require 'yaml'
+require 'socket'
+require 'byebug'
+require 'json'
+
+class LivestatusClient
+  def run
+    if opts[:query]
+      if opts[:list]
+        display_columns
+      else
+        puts JSON.pretty_generate query opts[:query]
+      end
+    elsif opts[:command]
+      command
+    end
+  end
+
+  def display_columns
+    printf "%-30s %-9s %s\n", 'column', '(type)', 'description'
+    120.times { print '-' }
+    puts
+    query('columns').select { |col| col[2] == opts[:query] }.each do |col|
+      printf "%-30s %-9s %s\n", col[1], "(#{col[3]})", col[0]
+    end
+  end
+
+  def command
+    args = [opts[:command]] + opts[:arguments].split(',')
+    cmd_string = "COMMAND [#{Time.now.to_i}] #{args.join(';')}\n" \
+      "ResponseHeader: fixed16\n" \
+      "OutputFormat: json\n"
+
+    socket.write cmd_string + "\n"
+    response = read
+    socket.close
+    puts response
+  end
+
+  def key
+    key_map = {
+      'downtimes' => 'id',
+      'services' => 'description',
+      'servicesbygroup' => 'description',
+      'servicesbyhostgroup' => 'description',
+      'comments' => 'service_description'
+    }
+
+    key_map[opts[:query]] || 'name'
+  end
+
+  def query(keyword)
+    query_string = "GET #{keyword}\n" \
+      "ResponseHeader: fixed16\n" \
+      "OutputFormat: json\n"
+    query_string += "Columns: #{columns.join ' '}\n" unless opts[:list]
+
+    socket.write query_string + "\n"
+    response = read
+    socket.close
+    return response unless opts[:columns]
+    parse response
+  end
+
+  def parse(data)
+    # Outputs a somewhat more useful data structure that looks like this:
+    #
+    # {
+    #   "item1": {
+    #     "column1": [
+    #       "value1",
+    #       "value2"
+    #     ],
+    #     "column2": [
+    #       "value1",
+    #       "value2"
+    #     ]
+    #   },
+    #   "item2": {
+    #     "column1": [
+    #     ],
+    #     "column2": [
+    #       "value1"
+    #     ]
+    #   }
+    # }
+
+    data.each_with_object({}) do |item, memo|
+      item_name = item.shift
+      # columns[1..-1] because we assume the first value is a name or id tag
+      memo[item_name] = columns[1..-1].each_with_object({}) do |col, cols_memo|
+        cols_memo[col] = item.shift
+      end
+    end
+  end
+
+  def read
+    header = socket.read 16
+
+    response = {
+      code: header[0..2].to_i,
+      length: header[4..14].chomp.to_i
+    }
+
+    fail "Received error response #{response[:code]}" unless response[:code] == 200
+
+    JSON.parse socket.read response[:length]
+  end
+
+  def socket
+    return @socket unless !@socket || @socket.closed?
+    @socket = TCPSocket.open opts[:host], opts[:port]
+  end
+
+  # def conf
+  #   @conf ||= begin
+  #     return {} unless File.exist? '/etc/livestatus-client.yaml'
+  #     YAML.load_file '/etc/livestatus-client.yaml'
+  #   end
+  # end
+
+  def columns
+    return [key] unless opts[:columns]
+    [key] + opts[:columns].split(',')
+  end
+
+  def opts
+    @opts ||= begin
+      opts = Trollop.options do
+        version "livestatus-client #{LivestatusClient::VERSION} (c) 2017 Evertrue"
+        opt :host, 'Livestatus host', short: 'h', type: String
+        opt :port, 'Livestatus port', short: 'p', type: String
+        opt :query, 'The query string', short: 'q', type: String
+        opt :columns, 'Which columns to display (comma separated)', short: 'l', type: String
+        opt :list, 'List available columns'
+        opt :command, 'Command to send', short: 'c', type: String
+        opt :arguments, 'Command argumenets (comma separated)', short: 'a', type: String
+      end
+
+      fail 'Either a query or a command must be specified' unless opts[:query] || opts[:command]
+
+      opts
+    end
+  end
+end

data/lib/livestatus-client/version.rb

@@ -0,0 +1,3 @@
+class LivestatusClient
+  VERSION = '1.0.1'.freeze
+end

data/livestatus-client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'livestatus-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "livestatus-client"
+  spec.version       = LivestatusClient::VERSION
+  spec.authors       = ["Eric Herot"]
+  spec.email         = ["eric.github@herot.com"]
+
+  spec.summary       = 'This is a very "lightweight" command line client ' \
+    '(written in Ruby) for the MK Livestatus Nagios module.'
+  spec.homepage      = "https://github.com/evertrue/livestatus-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'trollop'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: livestatus-client
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Eric Herot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- eric.github@herot.com
+executables:
+- livestatus
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/livestatus
+- lib/livestatus-client.rb
+- lib/livestatus-client/version.rb
+- livestatus-client.gemspec
+homepage: https://github.com/evertrue/livestatus-client
+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: This is a very "lightweight" command line client (written in Ruby) for the
+  MK Livestatus Nagios module.
+test_files: []