systemd_mon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71beedd875598eeb882df66a2a2982aad63fffe3
-  data.tar.gz: e08a8386c4489f8f42461ed8aa5bf2a65eb78bf6
+  metadata.gz: d4c77a8241786cc39475f30bd269143c00e9bd0c
+  data.tar.gz: 6769b609787a604d20c9200126630613cf3ec9c8
 SHA512:
-  metadata.gz: 016247aaa8c34f2cb6eaddd14459bc58d52ccd12e32557ca3a5d4e5a30c06e5222db72393f5d630d293ec69533897d7a5d6fdd7d1a161bec2a02ae5acaf43ed2
-  data.tar.gz: ca44541313c92f37e790f15ba07862885288d1d4e026bdb1560f681f1bc3b3cda721ec6b608b18c6507a0b65cf763bc75bd039f010e6818243e020b71f28c29b
+  metadata.gz: dd86b32951f1e8886dee2206ccd74e5099c0c749977f8d23a0141ed97ce0bc7856124672d2eefd047d2333c281f0f99bd5384f6633804782aa45d1fc7a879ec9
+  data.tar.gz: 3f16e8e7123370d584eda98181dc19edd219fcff0e3b26f7f52c24e13ee0c4c90916ee7d6f41a66c0be0d9815f4f8fb7ab09f7826acd3289b19b78aa1bd904b9

data/README.md

@@ -4,6 +4,16 @@ Monitor systemd units and trigger alerts for failed states. The command line too
 
 Built-in notifications include email and slack, but more can be added via the ruby API.
 
+It works by subscribing to DBus notifications from Systemd. This means that there is no polling, and no busy-loops. SystemdMon will sit in the background, happily waiting and using minimal processes.
+
+## Requirements
+
+* A linux server
+* Ruby > 1.9.3
+* Systemd (v204 was used in development)
+* `mail` gem (if email notifier is used)
+* `slack-notifier` gem (if slack notifier is used)
+
 ## Installation
 
 Install the gem using:
@@ -16,33 +26,68 @@ To run the command line tool, you will first need to create a YAML configuration
 
 ```yaml
 ---
+verbose: true # Default is off
 notifiers:
-  # These are options passed to the 'mail' gem
   email:
-    address: smtp.gmail.com
-    port: 587
-    domain: mydomain.com
-    user_name: "user@mydomain.com"
-    password: "supersecr3t"
-    authentication: "plain"
-    enable_starttls_auto: true
+    to: "team@mydomain.com"
+    from: "systemdmon@mydomain.com"
+    # These are options passed to the 'mail' gem
+    smtp:
+        address: smtp.gmail.com
+        port: 587
+        domain: mydomain.com
+        user_name: "user@mydomain.com"
+        password: "supersecr3t"
+        authentication: "plain"
+        enable_starttls_auto: true
   slack:
     team: myteam
     token: supersecr3ttoken
     channel: mychannel
     username: doge
+    icon_emoji: ":computer"
+    icon_url: "http://example.com/icon"
 units:
 - unicorn.service
 - nginx.service
 - sidekiq.service
 ```
 
-Then start the command line tool with:
+Save that somewhere appropriate (e.g. `/etc/systemd_mon.yml`), then start the command line tool with:
+
+    $ systemd_mon /etc/systemd_mon.yml
+
+You'll probably want to run it via systemd, which you can do with this example service file (change file paths as appropriate):
+
+```
+[Unit]
+Description=SystemdMon
+After=network.target
+
+[Service]
+Type=simple
+User=deploy
+StandardInput=null
+StandardOutput=syslog
+StandardError=syslog
+ExecStart=/usr/local/bin/systemd_mon /etc/systemd_mon.yml
+
+[Install]
+WantedBy=multi-user.target
+```
+
+## Behaviour
 
-    $ systemd_mon path/to/systemd_mon.yml
+Systemd provides information about state changes in very fine detail. For example, if you start a service, it may go through the following states: activating (start-pre), activiating (start) and finally active (running). This will likely happen in less than a second, and you probably don't want 3 notifications. Therefore, SystemdMon queues up states until it comes across one that you think you should know about. In this case, it will notify you when the state reaches active (running), but the notification can show the history of how the state changed so you get the full picture.
+
+SystemdMon does simple analysis on the history of state changes, so it can summarise with statuses like "recovered", "automatically restarted", "still failed", etc. It will also report with the host name of the server.
+
+You'll also want to know if SystemdMon itself falls over, and when it starts back up again. It will attempt to send a final notification before it exits, and one to say it's starting. However, be aware that it might not send a notification in some conditions (e.g. in the case of a SIGKILL), or a network failure. The age-old question: who will watch the watcher?
 
 ## Contributing
 
+I'd love more contributions, particulary new notifiers. Follow the example of the slack and email notifiers and either package as a new gem or submit a pull request if you think it should be part of the main project.
+
 1. Fork it ( https://github.com/joonty/systemd_mon/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/systemd_mon/cli.rb

@@ -22,8 +22,13 @@ module SystemdMon
     rescue SystemdMon::Error => e
       err_string = e.message
       if verbose
-        err_string << " - #{e.original.message} (#{e.original.class})"
-        err_string << "\n\t#{e.original.backtrace.join("\n\t")}"
+        if e.original
+          err_string << " - #{e.original.message} (#{e.original.class})"
+          err_string << "\n\t#{e.original.backtrace.join("\n\t")}"
+        else
+          err_string << " (#{e.class})"
+          err_string << "\n\t#{e.backtrace.join("\n\t")}"
+        end
       end
       fatal_error(err_string)
     rescue => e

data/lib/systemd_mon/dbus_manager.rb

@@ -9,7 +9,11 @@ module SystemdMon
       self.systemd_service = dbus.service("org.freedesktop.systemd1")
       self.systemd_object  = systemd_service.object("/org/freedesktop/systemd1")
       systemd_object.introspect
-      systemd_object.Subscribe
+      if systemd_object.respond_to?("Subscribe")
+        systemd_object.Subscribe
+      else
+        raise SystemdMon::SystemdError, "Systemd is not installed, or is an incompatible version. It must provide the Subscribe dbus method: version 204 is the minimum recommended version."
+      end
     end
 
     def fetch_unit(unit_name)

data/lib/systemd_mon/error.rb

@@ -10,8 +10,10 @@ module SystemdMon
     end
   end
 
+  class SystemdError < Error; end
   class MonitorError < Error; end
   class UnknownUnitError < Error; end
   class NotificationError < Error; end
+  class NotifierDependencyError < Error; end
   class NotifierError < Error; end
 end

data/lib/systemd_mon/notification.rb

@@ -9,7 +9,11 @@ module SystemdMon
     end
 
     def self.types
-      [:alert, :info, :ok]
+      [:alert, :warning, :info, :ok]
+    end
+
+    def type_text
+      type.to_s.capitalize
     end
 
   protected

data/lib/systemd_mon/notifiers/email.rb

@@ -1,8 +1,13 @@
-require 'mail'
+require 'systemd_mon/error'
 require 'systemd_mon/notifiers/base'
-require 'systemd_mon/logger'
 require 'systemd_mon/formatters/state_table_formatter'
 
+begin
+  require 'mail'
+rescue LoadError
+  raise SystemdMon::NotifierDependencyError, "The 'mail' gem is required by the email notifier"
+end
+
 module SystemdMon::Notifiers
   class Email < Base
     def initialize(*)
@@ -19,7 +24,7 @@ module SystemdMon::Notifiers
 
     def notify!(notification)
       unit = notification.unit
-      subject = "#{unit.name} on #{notification.hostname}: #{unit.state_change.status_text}"
+      subject = "#{notification.type_text}: #{unit.name} on #{notification.hostname}: #{unit.state_change.status_text}"
       message = "Systemd unit #{unit.name} on #{notification.hostname} #{unit.state_change.status_text}: #{unit.state.active} (#{unit.state.sub})\n\n"
       if unit.state_change.length > 1
         message << SystemdMon::Formatters::StateTableFormatter.new(unit).as_text

data/lib/systemd_mon/notifiers/slack.rb

@@ -1,6 +1,12 @@
-require 'slack-notifier'
+require 'systemd_mon/error'
 require 'systemd_mon/notifiers/base'
 
+begin
+  require 'slack-notifier'
+rescue LoadError
+  raise SystemdMon::NotifierDependencyError, "The 'slack-notifier' gem is required by the slack notifier"
+end
+
 module SystemdMon::Notifiers
   class Slack < Base
     def initialize(*)
@@ -15,32 +21,32 @@ module SystemdMon::Notifiers
     end
 
     def notify_start!(hostname)
-      message = "Startup notification for SystemdMon"
+      message = "SystemdMon is starting on #{hostname}"
 
       attach = {
         fallback: message,
-        text: "SystemdMon is starting on #{hostname}",
+        text: message,
         color: "good"
       }
 
-      notifier.ping message, attachments: [attach]
+      notifier.ping "", attachments: [attach]
     end
 
     def notify_stop!(hostname)
-      message = "Shutdown alert for SystemdMon"
+      message = "SystemdMon is stopping on #{hostname}"
 
       attach = {
         fallback: message,
-        text: "SystemdMon is stopping on #{hostname}",
+        text: message,
         color: "danger"
       }
 
-      notifier.ping message, attachments: [attach]
+      notifier.ping "", attachments: [attach]
     end
 
     def notify!(notification)
       unit = notification.unit
-      message = "Systemd unit #{unit.name} on #{notification.hostname} #{unit.state_change.status_text}"
+      message = "#{notification.type_text}: systemd unit #{unit.name} on #{notification.hostname} #{unit.state_change.status_text}"
 
       attach = {
         fallback: "#{message}: #{unit.state.active} (#{unit.state.sub})",
@@ -82,6 +88,8 @@ module SystemdMon::Notifiers
       case type
       when :alert
         'danger'
+      when :warning
+        '#FF9900'
       when :info
         '#0099CC'
       else

data/lib/systemd_mon/state.rb

@@ -8,7 +8,7 @@ module SystemdMon
 
     def initialize(active, sub, loaded, unit_file)
       timestamp   = Time.now
-      @active     = StateValue.new("active", active, timestamp, %w(active), %w(inactive))
+      @active     = StateValue.new("active", active, timestamp, %w(active), %w(inactive failed))
       @sub        = StateValue.new("status", sub, timestamp)
       @loaded     = StateValue.new("loaded", loaded, timestamp, %w(loaded))
       @unit_file  = StateValue.new("file", unit_file, timestamp, %w(enabled), %w(disabled))

data/lib/systemd_mon/state_change.rb

@@ -48,6 +48,10 @@ module SystemdMon
       first.ok? && last.ok? && changes.any? { |s| s.active == "deactivating" }
     end
 
+    def auto_restart?
+      first.ok? && last.ok? && changes.any? { |s| s.sub == "auto-restart" }
+    end
+
     def reload?
       first.ok? && last.ok? && changes.any? { |s| s.active == "reloading" }
     end
@@ -59,6 +63,8 @@ module SystemdMon
     def status_text
       if recovery?
         "recovered"
+      elsif auto_restart?
+        "automatically restarted"
       elsif restart?
         "restarted"
       elsif reload?

data/lib/systemd_mon/version.rb

@@ -1,3 +1,3 @@
 module SystemdMon
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/systemd_mon.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "ruby-dbus"
+  spec.add_dependency "ruby-dbus", "~> 0.11.0"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: systemd_mon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jon Cairns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-dbus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement