riemann-nut 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f61ed52eeeb5f1be97e103f3637e2b7a176badd16efbde71431ae3bfce608338
+  data.tar.gz: eb1e03ef41684f4e651c65fe5c66582e6969c72de0d54ede0642968e406b035e
+SHA512:
+  metadata.gz: e4457b8cbd057b69f8f78e760b33843f24804d670ed499afac16ffe6ca21fa465f8c092031b0ffa8ab78ebe024c057e04dee44e9e395fc5607cbc7d411728fc0
+  data.tar.gz: da71e8f350b87e68722f224f20323f102ea1ca668dbd1f6a1e263cb1748ade1096647edcd6e8d96497aedc4d50aa7a3f0411c5609f0938a3c6769ff44b35b72c

data/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+---
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
+  test:
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - 2.6
+          - 2.7
+          - 3.0
+          - 3.1
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run the test suite
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+---
+AllCops:
+  Exclude:
+    - vendor/bundle/**/*
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+Layout/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in riemann-tools.gemspec
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+# riemann-nut
+
+Submits nut information to riemann.
+
+## Get started
+
+```
+gem install riemann-nut
+riemann-nut --ups upsa@192.168.0.5 upsb@192.168.0.5 upsc@192.168.0.6
+```
+
+## Example metrics
+
+Syntax: `<service>: <metric> (<state>)\n<description>\n`
+
+```
+ups@192.168.100.1 battery charge: 100 (ok)
+100 %
+ups@192.168.100.1 battery voltage: 13.5 (ok)
+13.5 V
+ups@192.168.100.1 input voltage: 232.0 (ok)
+232.0 V
+ups@192.168.100.1 ups alarm: (critical)
+Replace battery! No battery installed!
+ups@192.168.100.1 ups load: 13 (ok)
+13 W
+ups@192.168.100.1 ups status: (critical)
+ALARM OL RB
+```

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'riemann/tools/nut/version'
+
+require 'bundler/gem_tasks'
+
+require 'github_changelog_generator/task'
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'opus-codium'
+  config.project = 'riemann-nut'
+  config.exclude_labels = ['skip-changelog']
+  config.future_release = Riemann::Tools::Nut::VERSION
+end

data/bin/riemann-nut

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Process.setproctitle($PROGRAM_NAME)
+
+require 'riemann/tools/nut'
+
+Riemann::Tools::Nut.run

data/lib/riemann/tools/nut/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Riemann
+  module Tools # :nodoc:
+    class Nut
+      VERSION = '1.0.0'
+    end
+  end
+end

data/lib/riemann/tools/nut.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require 'riemann/tools'
+
+require 'open3'
+
+module Riemann
+  module Tools
+    class Nut
+      include Riemann::Tools
+
+      opt :ups, 'UPS to connect to', type: :strings, default: ['ups@localhost']
+      opt :load_warning, 'Load warning threshold', default: 0.0
+      opt :load_critical, 'Load critical threshold', default: 0.0
+
+      def tick
+        invalidate_cache
+
+        report_battery_charge
+        report_battery_voltage
+        report_input_voltage
+        report_ups_alarm
+        report_ups_load
+        report_ups_status
+      end
+
+      def invalidate_cache
+        @cached_data = {}
+      end
+
+      def upsc
+        return @cached_data[:upsc] if @cached_data[:upsc]
+
+        @cached_data[:upsc] = {}
+
+        opts[:ups].each do |ups|
+          output, _status = Open3.capture2('upsc', ups)
+
+          data = {}
+          output.lines.each do |line|
+            next unless line.chomp =~ /\A([^:]+): (.*)\z/
+
+            key = Regexp.last_match[1]
+            value = Regexp.last_match[2].strip
+
+            data[key] = value
+          end
+
+          @cached_data[:upsc][ups] = data
+        rescue Errno::ENOENT
+          @cached_data[:upsc][ups] = {}
+        end
+
+        @cached_data[:upsc]
+      end
+
+      def report_battery_charge
+        opts[:ups].each do |ups|
+          service = "#{ups} battery charge"
+          battery_charge = Integer(upsc[ups]['battery.charge'])
+          battery_state = if battery_charge < Integer(upsc[ups]['battery.charge.low'])
+                            'critical'
+                          elsif battery_charge < Integer(upsc[ups]['battery.charge.warning'])
+                            'warning'
+                          else
+                            'ok'
+                          end
+
+          report(
+            service: service,
+            metric: battery_charge,
+            state: battery_state,
+            description: "#{battery_charge} %",
+          )
+        rescue TypeError
+          report(
+            service: service,
+            state: 'critical',
+          )
+        end
+      end
+
+      def report_battery_voltage
+        opts[:ups].each do |ups|
+          service = "#{ups} battery voltage"
+          battery_voltage = Float(upsc[ups]['battery.voltage'])
+
+          report(
+            service: service,
+            metric: battery_voltage,
+            state: 'ok',
+            description: "#{battery_voltage} V",
+          )
+        rescue TypeError
+          report(
+            service: service,
+            state: 'critical',
+          )
+        end
+      end
+
+      def report_input_voltage
+        opts[:ups].each do |ups|
+          service = "#{ups} input voltage"
+          input_voltage = Float(upsc[ups]['input.voltage'])
+
+          report(
+            service: service,
+            metric: input_voltage,
+            state: 'ok',
+            description: "#{input_voltage} V",
+          )
+        rescue TypeError
+          report(
+            service: service,
+            state: 'critical',
+          )
+        end
+      end
+
+      def report_ups_alarm
+        opts[:ups].each do |ups|
+          report(
+            service: "#{ups} ups alarm",
+            state: 'critical',
+            description: upsc[ups]['ups.alarm'],
+          )
+        end
+      end
+
+      def report_ups_load
+        opts[:ups].each do |ups|
+          service = "#{ups} ups load"
+          ups_load = Float(upsc[ups]['ups.load'])
+          ups_state = if opts[:load_critical].positive? && ups_load > opts[:load_critical]
+                        'critical'
+                      elsif opts[:load_warning].positive? && ups_load > opts[:load_warning]
+                        'warning'
+                      else
+                        'ok'
+                      end
+
+          report(
+            service: service,
+            metric: ups_load,
+            state: ups_state,
+            description: "#{ups_load} W",
+          )
+        rescue TypeError
+          report(
+            service: service,
+            state: 'critical',
+          )
+        end
+      end
+
+      def report_ups_status
+        opts[:ups].each do |ups|
+          # https://github.com/influxdata/telegraf/issues/6316#issuecomment-787008263
+          ups_state = 'ok' if upsc[ups]['ups.status'] =~ /\b(OL)\b/
+          ups_state = 'warning' if upsc[ups]['ups.status'] =~ /\b(OB|DISCHRG|BYPASS)\b/
+          ups_state = 'critical' if upsc[ups]['ups.status'] =~ /\b(ALARM|OVER)\b/
+
+          ups_state ||= 'critical'
+
+          report(
+            service: "#{ups} ups status",
+            state: ups_state,
+            description: upsc[ups]['ups.status'],
+          )
+        end
+      end
+    end
+  end
+end

data/riemann-nut.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/riemann/tools/nut/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'riemann-nut'
+  spec.version       = Riemann::Tools::Nut::VERSION
+  spec.authors       = ['Romain Tartière']
+  spec.email         = ['romain@blogreen.org']
+
+  spec.summary       = 'Submits nut information to riemann'
+  spec.homepage      = 'https://github.com/opus-codium/riemann-nut'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri']   = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'riemann-tools', '~> 1.0'
+
+  spec.add_development_dependency 'github_changelog_generator'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: riemann-nut
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Romain Tartière
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riemann-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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:
+email:
+- romain@blogreen.org
+executables:
+- riemann-nut
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/riemann-nut
+- lib/riemann/tools/nut.rb
+- lib/riemann/tools/nut/version.rb
+- riemann-nut.gemspec
+homepage: https://github.com/opus-codium/riemann-nut
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/opus-codium/riemann-nut
+  source_code_uri: https://github.com/opus-codium/riemann-nut
+  changelog_uri: https://github.com/opus-codium/riemann-nut
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.17
+signing_key:
+specification_version: 4
+summary: Submits nut information to riemann
+test_files: []