alerty 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37200c7df937b8b93002b2ef0e988b49f0704482
-  data.tar.gz: 02a87bf6ae0a11ad405f2a9e9c518cdaa3b613d8
+  metadata.gz: 3aebfe7ba5184735ab0d413628384502ce41b3a1
+  data.tar.gz: 47c6100062890783cd3c95cd2a1bb3ea9554396b
 SHA512:
-  metadata.gz: 3970c46b9de3142aa6d459de8657a8ffc86c3d1e5bd9219d47700e8918e27b1b3252a5ade20b149217b047fb81ea3fea5d2f15eb5ae75a18ec625c7ef0e688f3
-  data.tar.gz: 6c90bdd66aa9714bfbc48cc80c7d54750e7666b4d2df64942225aa6600e15664db6e29dde59f34149e9ed9f25732f4afb05f4da929f060092b3f6d9b2d46a411
+  metadata.gz: 427b8bca35c0e644daf46e7dd23cbb0d0bb2d3430dd25aae3608bc1e0780817840d4716b77b04a2441441509631a74fa4c44fc9383204dac829e770394e860dc
+  data.tar.gz: 05f4cf1c8cd05d20926d58943f06fa7464c1197679b41fb77710c8adfefe528ded0ea0762073c3d120e43cad282f2f5748a73ed97669cf90688672697233a48a

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-# 0.0.3 (2015/08/14)
+# 0.0.5 (2015/08/14)
+
+Changes:
+
+* Change default conf path from /etc/sysconfig/alerty to /etc/alerty/alerty.yml
+
+# 0.0.4 (2015/08/14)
 
 Enchancements:
 

data/README.md

@@ -7,7 +7,7 @@ A CLI utility to send an alert if a given command failed.
 I use `alerty` to run commands in cron to send alerts if cron commands fail.
 
 ```
-0 * * * * alerty -c /etc/sysconfig/alerty -- /path/to/script --foo FOO --bar
+0 * * * * alerty -c /etc/alerty/alerty.yml -- /path/to/script --foo FOO --bar
 ```
 
 ## Installation
@@ -18,7 +18,7 @@ gem install alerty
 
 ## Configuration
 
-You can write a configuration file located at `/etc/sysconfig/alerty` (You can configure this path by `ALERTY_CONFIG_FILE` environment variable, or `-c` option):
+You can write a configuration file located at `/etc/alerty/alerty.yml` (You can configure this path by `ALERTY_CONFIG_FILE` environment variable, or `-c` option):
 
 ```
 log_path: STDOUT
@@ -29,7 +29,7 @@ plugins:
   - type: stdout
 ```
 
-[example/alerty.yml](./example/alerty.yml)
+[example.yml](./example.yml)
 
 ### CLI Example
 
@@ -41,7 +41,7 @@ $ alerty -c example.yml -- ls -l /something_not_exist
 
 ```
 $ bin/alerty -h
-    -c, --config CONFIG_FILE         config file path (default: /etc/sysconfig/alerty)
+    -c, --config CONFIG_FILE         config file path (default: /etc/alerty/alerty.yml)
         --log LOG_FILE               log file path (default: STDOUT)
         --log-level LOG_LEVEL        log level (default: warn
     -t, --timeout SECONDS            timeout the command (default: no timeout)
@@ -56,6 +56,66 @@ Following plugins are available:
 * [file](./lib/alerty/plugin/file.rb)
 * [exec](./lib/alerty/plugin/exec.rb)
 * [alerty-plugin-ikachan](https://github.com/sonots/alerty-plugin-ikachan)
+* [alerty-plugin-amazon_sns](https://github.com/sonots/alerty-plugin-amazon_sns)
+
+## Plugin Architecture
+
+### Naming Convention
+
+You must follow the below naming conventions:
+
+* gem name: alerty-plugin-xxx (xxx_yyy)
+* file name: lib/alerty/plugin/xxx.rb (xxx_yyy.rb)
+* class name: Alerty::Plugin:Xxx (XxxYyy)
+
+### Interface
+
+What you have to implement is `#initialize` and `#alert` methods. Here is an example of `file` plugin:
+
+```ruby
+require 'json'
+
+class Alerty
+  class Plugin
+    class File
+      def initialize(config)
+        raise ConfigError.new('file: path is not configured') unless config.path
+        @path = config.path
+      end
+
+      def alert(record)
+        ::File.open(@path, 'a') do |io|
+          io.puts record.to_json
+        end
+      end
+    end
+  end
+end
+```
+
+### config
+
+`config` is created from the configuration file: 
+
+```
+plugins:
+  - type: foobar
+    key1: val1
+    key2: val2
+```
+
+`config.key1` and `config.key2` are availabe in the above config. 
+
+### record
+
+`record` is a hash whose keys are
+
+* hostname: hostname
+* command: the executed command
+* exitstatus: the exit status of the executed command
+* output: the output of the exectued command
+* started_at: the time when command executed in epoch time.
+* duration: the duration which the command execution has taken in seconds. 
 
 ## ChangeLog
 

data/alerty.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "alerty"
-  gem.version       = '0.0.4'
+  gem.version       = '0.0.5'
   gem.author        = ['Naotoshi Seo']
   gem.email         = ['sonots@gmail.com']
   gem.homepage      = 'https://github.com/sonots/alerty'

data/lib/alerty/cli.rb

@@ -16,7 +16,7 @@ class Alerty
       end
 
       opts = {}
-      op.on('-c', '--config CONFIG_FILE', "config file path (default: /etc/sysconfig/alerty)") {|v|
+      op.on('-c', '--config CONFIG_FILE', "config file path (default: /etc/alerty/alerty.yml)") {|v|
         opts[:config_path] = v
       }
       op.on('--log LOG_FILE', "log file path (default: STDOUT)") {|v|

data/lib/alerty/config.rb

@@ -11,7 +11,7 @@ class Alerty
       end
 
       def config_path
-        @config_path ||= opts[:config_path] || ENV['ALERTY_CONFIG_PATH'] || '/etc/sysconfig/alerty'
+        @config_path ||= opts[:config_path] || ENV['ALERTY_CONFIG_PATH'] || '/etc/alerty/alerty.yml'
       end
 
       def config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alerty
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Naotoshi Seo