riemann-bacula 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8259d6fb194ccf10cd5acb756a66b2a22e1f310ed75a081f54cadcf8f7e80e99
+  data.tar.gz: 7ea103923b9966074450861224946190f52cdabc766f0dcb2a4fd76f5f3c8de1
+SHA512:
+  metadata.gz: c8dff17ef2cb421f7a799755247190edfdfe39242bd55a0ce9f268109f157b7a94acc138252ea0a3e20c00d7f8b9e9be9f212e5708a0ba5464087e1aa457fb25
+  data.tar.gz: 03b0c38ded3a57c297435ec6f16c1b766303eee451311b3c29c141d81b70d184ac616fe8f91171663a0f1b3cfbe753e439e1044123cf4fd5ee99d76f36a04633

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# DO NOT EDIT THIS FILE!
+# This file is managed by ModuleSync.
+
+* @opus-codium/core

data/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+---
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+      - name: Run static code analysis
+        run: bundle exec rubocop
+  unit:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    strategy:
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests without uploading code coverage
+        if: ${{ matrix.ruby != '3.0' }}
+        run: bundle exec rake
+      - name: Run tests and upload coverage to Code Climate
+        if: ${{ matrix.ruby == '3.0' }}
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE_TOKEN }}
+        with:
+          coverageCommand: bundle exec rake

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,40 @@
+---
+AllCops:
+  TargetRubyVersion: '2.6'
+  AllowSymlinksInCacheRootDirectory: true
+  NewCops: enable
+  Exclude:
+    - vendor/bundle/**/*
+require:
+- rubocop-rake
+- rubocop-rspec
+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
+RSpec/SubjectStub:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.simplecov

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# vim:set syntax=ruby:
+
+SimpleCov.start do
+  add_filter '/spec/'
+end

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,19 @@
+# riemann-bacula
+
+Submits bacula information to riemann.
+
+## Get started
+
+```
+gem install riemann-bacula
+```
+
+In your Bacula Director configuration, add a Message resource like this (the provided e-mail address is not used, we are just hacking around the mail destination which sends a full transcript to the MailCommand standard input):
+
+```
+Messages {
+  Name = Standard
+  MailCommand = "riemann-bacula"
+  Mail = sysadmin@example.com = all, !skipped
+}
+```

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'riemann/tools/bacula/version'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'github_changelog_generator/task'
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'opus-codium'
+  config.project = 'riemann-bacula'
+  config.exclude_labels = ['skip-changelog']
+  config.future_release = Riemann::Tools::Bacula::VERSION
+end

data/bin/riemann-bacula

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

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

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

data/lib/riemann/tools/bacula.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require 'strscan'
+
+require 'riemann/tools'
+
+module Riemann
+  module Tools
+    class Bacula
+      include Riemann::Tools
+
+      opt :details, 'Send detailed metrics beyond overall status', default: true
+
+      def self.process_stdin
+        new.process_stdin
+      end
+
+      def run
+        options
+        data = parse($stdin.read)
+        send_events(data) if data
+      end
+
+      def parse(text)
+        data = {}
+
+        text.each_line do |line|
+          line.chomp!
+
+          next unless line =~ /\A  ([^:]+):[[:blank:]]+(.*)/
+
+          key = Regexp.last_match(1)
+          raw_value = Regexp.last_match(2)
+
+          data[key] = raw_value
+        end
+
+        return nil unless valid?(data)
+
+        enhance(data)
+      end
+
+      def valid?(data)
+        %w[
+          Job
+          Termination
+        ].all? { |key| data.key?(key) }
+      end
+
+      def enhance(data)
+        {
+          parse_size: [
+            'FD Bytes Written',
+            'SD Bytes Written',
+            'Last Volume Bytes',
+          ],
+          parse_integer: [
+            'JobId',
+            'Priority',
+            'Non-fatal FD errors',
+            'FD Files Written',
+            'SD Files Written',
+            'SD Errors',
+            'Volume Session Id',
+            'Volume Session Time',
+          ],
+          parse_duration: [
+            'Elapsed time',
+          ],
+          parse_volumes: [
+            'Volume name(s)',
+          ],
+          parse_rate: [
+            'Rate',
+          ],
+          parse_ratio: [
+            'Software Compression',
+            'Comm Line Compression',
+          ],
+        }.each do |parser, keys|
+          keys.each do |key|
+            data[key] = send(parser, data[key]) if data[key]
+          end
+        end
+
+        extract_source('Pool', data)
+        extract_source('Catalog', data)
+        extract_source('Storage', data)
+
+        extract_time('FileSet', data)
+
+        extract_client_info(data)
+        extract_backup_level_info(data)
+        extract_job_name(data)
+
+        data
+      end
+
+      def extract_backup_level_info(data)
+        case data['Backup Level']
+        when /\A(Differential|Incremental), since=(.*)\z/
+          data['Backup Level'] = Regexp.last_match(1)
+          data['Backup Level Since'] = Regexp.last_match(2)
+        when /\A(Full) \(upgraded from (Differential|Incremental)\)\z/
+          data['Backup Level'] = Regexp.last_match(1)
+          data['Backup Level upgraded from'] = Regexp.last_match(2)
+        end
+      end
+
+      def extract_client_info(data)
+        /\A"([^"]+)" ([^ ]+)/.match(data['Client'])
+
+        data['Client'] = Regexp.last_match(1)
+        data['Client Version'] = Regexp.last_match(2)
+      end
+
+      def extract_job_name(data)
+        data['Job Name'] = data['Job'].sub(/\.\d{4}-\d{2}-\d{2}_\d{2}\.\d{2}\.\d{2}_\d{2}\z/, '')
+      end
+
+      def extract_source(item, data)
+        /\A"([^"]+)" \(From (Client|Job|Pool) resource\)\z/.match(data[item])
+
+        data[item] = Regexp.last_match(1)
+        data["#{item} Source"] = Regexp.last_match(2)
+      end
+
+      def extract_time(item, data)
+        /\A"([^"]+)" (.*)\z/.match(data[item])
+
+        data[item] = Regexp.last_match(1)
+        data["#{item} time"] = Regexp.last_match(2)
+      end
+
+      def parse_duration(duration)
+        s = StringScanner.new(duration)
+        res = 0
+
+        until s.eos?
+          case
+          when s.scan(/\s+/)
+            # ignore spaces
+          when s.scan(/(\d+) hours?/) then res += s[0].to_i * 3600
+          when s.scan(/(\d+) mins?/)  then res += s[0].to_i * 60
+          when s.scan(/(\d+) secs?/)  then res += s[0].to_i
+          else
+            return -1
+          end
+        end
+
+        res
+      end
+
+      def parse_integer(value)
+        value.gsub(',', '').to_i
+      end
+
+      def parse_rate(value)
+        %r{\A(\d+\.\d+) KB/s\z}.match(value)
+        Regexp.last_match(1).to_f
+      end
+
+      def parse_ratio(value)
+        return 0.0 if value == 'None'
+
+        /\A(\d+\.\d+)% \d+\.\d+:\d+\z/.match(value)
+        Regexp.last_match(1).to_f / 100
+      end
+
+      def parse_size(value)
+        /\A([\d,]+) \([\d.]+ [KMG]?B\)\z/.match(value)
+        parse_integer(Regexp.last_match(1))
+      end
+
+      def parse_volumes(value)
+        value.split('|')
+      end
+
+      def send_events(data)
+        event = {}
+        event[:service] = "bacula backup #{data['Job Name']}"
+        event[:state] = case data['Termination']
+                        when 'Backup OK' then 'ok'
+                        when 'Backup OK -- with warnings' then 'warning'
+                        else
+                          'critical'
+                        end
+        event[:description] = data['Termination']
+        report(event)
+
+        return unless options[:details]
+
+        [
+          'Elapsed time',
+          'FD Files Written',
+          'SD Files Written',
+          'FD Bytes Written',
+          'SD Bytes Written',
+          'SD Errors',
+          'Rate',
+          'Software Compression',
+          'Comm Line Compression',
+          'Non-fatal FD errors',
+        ].each do |metric|
+          event = {}
+          event[:service] = "bacula backup #{data['Job Name']} #{data['Backup Level'].downcase} #{metric.downcase}"
+          event[:metric] = data[metric]
+          report(event)
+        end
+      end
+    end
+  end
+end

data/riemann-bacula.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/riemann/tools/bacula/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'riemann-bacula'
+  spec.version       = Riemann::Tools::Bacula::VERSION
+  spec.authors       = ['Romain Tartière']
+  spec.email         = ['romain@blogreen.org']
+
+  spec.summary       = 'Submits bacula information to riemann'
+  spec.homepage      = 'https://github.com/opus-codium/riemann-bacula'
+  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
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # 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'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: riemann-bacula
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Romain Tartière
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-14 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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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-bacula
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- Gemfile
+- README.md
+- Rakefile
+- bin/riemann-bacula
+- lib/riemann/tools/bacula.rb
+- lib/riemann/tools/bacula/version.rb
+- riemann-bacula.gemspec
+homepage: https://github.com/opus-codium/riemann-bacula
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/opus-codium/riemann-bacula
+  source_code_uri: https://github.com/opus-codium/riemann-bacula
+  changelog_uri: https://github.com/opus-codium/riemann-bacula
+  rubygems_mfa_required: 'true'
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Submits bacula information to riemann
+test_files: []