riemann-bacula 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0499f815167711cba4183d48892adaac79f6e4e85f93afc98bff39d0dbd150a3'
-  data.tar.gz: e3fc084ea69056b5ac40ee69a85688ce22cc41594838092fbcf7e7cedcc0a763
+  metadata.gz: c7c2bdcd4f13414f04163482d874341b8771dbff7ecb84fe2c96d68ec75e8553
+  data.tar.gz: 22a3eb9612eeec5727e800a915dc534d47978baf7b055425efe0f24c13966c7c
 SHA512:
-  metadata.gz: 60ab698e159a288be2417ad6e04e34c144d8865422b9eb841b6691679a232a9e83adaf50539cd70f67d4bfa8f53c9d5b4653f9c866db61d93fae41de3c054622
-  data.tar.gz: 07b689de3b9e91c88ce565adbb3c3ac4f7b4e6d42f9b3fc2b8b963f6a0f277f5ba59f17ff4b5f78cac71a92c0d1d1d56319ca940ad19dac18b3947a89e68bb63
+  metadata.gz: 6cd99cf77b7e0ca07f2d8d4d48f408cdf7a134ff9e2f43ac512e5ddc9b75cc54dda3c120583983a32ca3d1824da2cf68df3ebfd4ded7efd75f6bdb9fbd11d382
+  data.tar.gz: 6929197169f1a28d3bfcf094120f8adde8a289a2e8cc2f89ca07a1b8659e1757c0f935488de75274d72a21fe9418365eb1d676a1a3b395b6e340d7b3334f2ce8

data/.github/CODEOWNERS

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

data/CHANGELOG.md

@@ -1,8 +1,28 @@
 # Changelog
 
-## [1.1.0](https://github.com/opus-codium/riemann-bacula/tree/1.1.0) (2022-10-20)
+## [v2.0.0](https://github.com/opus-codium/riemann-bacula/tree/v2.0.0) (2022-11-14)
 
-[Full Changelog](https://github.com/opus-codium/riemann-bacula/compare/v1.0.0...1.1.0)
+[Full Changelog](https://github.com/opus-codium/riemann-bacula/compare/v1.2.0...v2.0.0)
+
+**Breaking changes:**
+
+- Add parameters and make them mandatory [\#7](https://github.com/opus-codium/riemann-bacula/pull/7) ([smortex](https://github.com/smortex))
+
+**Merged pull requests:**
+
+- Fix how we set the host of bacula events [\#8](https://github.com/opus-codium/riemann-bacula/pull/8) ([smortex](https://github.com/smortex))
+
+## [v1.2.0](https://github.com/opus-codium/riemann-bacula/tree/v1.2.0) (2022-10-27)
+
+[Full Changelog](https://github.com/opus-codium/riemann-bacula/compare/v1.1.0...v1.2.0)
+
+**Implemented enhancements:**
+
+- Embed more metadata in events [\#5](https://github.com/opus-codium/riemann-bacula/pull/5) ([smortex](https://github.com/smortex))
+
+## [v1.1.0](https://github.com/opus-codium/riemann-bacula/tree/v1.1.0) (2022-10-20)
+
+[Full Changelog](https://github.com/opus-codium/riemann-bacula/compare/v1.0.0...v1.1.0)
 
 **Implemented enhancements:**
 

data/README.md

@@ -17,7 +17,7 @@ In your Bacula Director configuration, add a Message resource like this (the pro
 ```
 Messages {
   Name = Standard
-  MailCommand = "riemann-bacula"
+  MailCommand = "riemann-bacula --event-host \"%h\" --job-name \"%n\" --backup-level \"%l\" --status \"%e\" --bytes \"%b\" --files \"%F\""
   Mail = sysadmin@example.com = all, !skipped
 }
 ```

data/Rakefile

@@ -15,6 +15,6 @@ 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
+  config.future_release = "v#{Riemann::Tools::Bacula::VERSION}"
   config.since_tag = 'v1.0.0'
 end

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

@@ -3,7 +3,7 @@
 module Riemann
   module Tools # :nodoc:
     class Bacula
-      VERSION = '1.1.0'
+      VERSION = '2.0.0'
     end
   end
 end

data/lib/riemann/tools/bacula.rb

@@ -9,16 +9,54 @@ module Riemann
     class Bacula
       include Riemann::Tools
 
-      opt :details, 'Send detailed metrics beyond overall status', default: true
+      opt :job_name,     'Job name (%n)',        short: :none, type: :string
+      opt :backup_level, 'Job Level (%l)',       short: :none, type: :string
+      opt :status,       'Job Exit Status (%e)', short: :none, type: :string
+
+      opt :bytes, 'Job Bytes (%b)', short: :none, type: :integer
+      opt :files, 'Job Files (%F)', short: :none, type: :integer
+
+      opt :details, 'Send detailed metrics beyond overall status', short: :none, default: true
 
       def self.process_stdin
         new.process_stdin
       end
 
       def run
-        options
+        %i[job_name backup_level status].each do |name|
+          raise("Parameter #{name} is required") unless opts[name]
+        end
+
         data = parse($stdin.read)
-        send_events(data) if data
+
+        report({
+                 service: "bacula backup #{opts[:job_name]}",
+                 state: bacula_backup_state,
+                 job_name: opts[:job_name],
+                 backup_level: opts[:backup_level],
+                 description: data['Termination'],
+               })
+
+        %i[bytes files].each do |metric|
+          next unless opts[metric]
+
+          report({
+                   service: "bacula backup #{opts[:job_name]} #{opts[:backup_level].downcase} #{metric}",
+                   metric: opts[metric],
+                   job_name: opts[:job_name],
+                   backup_level: opts[:backup_level],
+                 })
+        end
+
+        send_details(data) if options[:details]
+      end
+
+      def bacula_backup_state
+        case opts[:status]
+        when 'OK' then 'ok'
+        else
+          'critical'
+        end
       end
 
       def parse(text)
@@ -43,19 +81,14 @@ module Riemann
           line_continuation = (key if line.length == 998)
         end
 
-        return nil unless valid?(data)
-
         enhance(data)
       end
 
-      def valid?(data)
-        %w[
-          Job
-          Termination
-        ].all? { |key| data.key?(key) }
-      end
-
       def enhance(data)
+        # If the message on stdin was trucated, the last item might not make
+        # sense.
+        data.delete(data.keys.last) if data.keys.last != 'Termination'
+
         {
           parse_size: [
             'FD Bytes Written',
@@ -103,7 +136,6 @@ module Riemann
 
         extract_client_info(data)
         extract_backup_level_info(data)
-        extract_job_name(data)
 
         data
       end
@@ -126,10 +158,6 @@ module Riemann
         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)
         return unless /\A"([^"]+)" \(From (Client|Job|Pool) resource\)\z/.match(data[item])
 
@@ -189,20 +217,7 @@ module Riemann
         value.split('|')
       end
 
-      def send_events(data)
-        event = {}
-        event[:service] = "bacula backup #{data['Job Name']}"
-        event[:state] = case data['Termination']
-                        when /\A(Backup|Restore) OK\z/ then 'ok'
-                        when 'Backup OK -- with warnings' then 'warning'
-                        else
-                          'critical'
-                        end
-        event[:description] = data['Termination']
-        report(event)
-
-        return unless options[:details]
-
+      def send_details(data)
         [
           'Elapsed time',
           'FD Files Written',
@@ -215,10 +230,14 @@ module Riemann
           '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)
+          next unless data[metric]
+
+          report({
+                   service: "bacula backup #{opts[:job_name]} #{opts[:backup_level].downcase} #{metric.downcase}",
+                   metric: data[metric],
+                   job_name: opts[:job_name],
+                   backup_level: opts[:backup_level],
+                 })
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riemann-bacula
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Romain Tartière
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riemann-tools
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - romain@blogreen.org
 executables:
@@ -153,7 +153,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.23
+signing_key:
 specification_version: 4
 summary: Submits bacula information to riemann
 test_files: []