bipbip 0.5.8 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e26b21a257b3d7ef3f83082a9246712761ee2718
-  data.tar.gz: 5f08b5b27ee6a5bde3667f28558ec8d950c9e398
+  metadata.gz: 940f0155867f0e16e1c4a7c0b7ba8b710b0a0191
+  data.tar.gz: ffa66de8788189c9774081d1e8a2fe63d085b071
 SHA512:
-  metadata.gz: 793d41812612faab00f69b869154ebec729be96026d29f1e4d3f0e5df0e70d891a1f71bd764f57b216a732fdd57c5f030f4721df6ea0c4a91d645bd6b507d5f9
-  data.tar.gz: 2e4617cd5412566ce2df94dacf6ca0669973caadb54a2ddf4dcaa07d8e6ff0a07908871c8867e6aaaa23bf2bbae11dc8b67bbf9244e443a53dcad4bb7f60497a
+  metadata.gz: 897fd316611fdd5a84e41299381098b099edb3a1d531a92c950a8ee74aed2352dc3dc96017d127ab700ea75119610fb16e72f79e70ba080584bb8e27b601d10a
+  data.tar.gz: 3258dfbf44197e4d6c49a7094396a64b9d6a826a2e794c93c7954f5ae38c23a48ec727ca9bc460dffe912872012ce004f59050cdc5afd176eacc1804766e40a2

data/README.md

@@ -2,7 +2,6 @@ bipbip [![Build Status](https://travis-ci.org/cargomedia/bipbip.png)](https://tr
 ======
 Agent to collect server metrics and send them to the [CopperEgg RevealMetrics](http://copperegg.com/) platform.
 Plugins for different metrics available.
-Will spawn a child process for every plugin and server you tell it to monitor.
 
 Installation
 ------------
@@ -10,14 +9,15 @@ Installation
 gem install bipbip
 ```
 
-Configuration
--------------
+There's a [puppet module for Debian](https://github.com/cargomedia/puppet-packages/tree/master/modules/bipbip) available to install *bipbip* as a system daemon.
+
+### Configuration
 Pass the path to your configuration file to `bipbip` using the `-c` command line argument.
 ```sh
 bipbip -c /etc/bipbip/config.yml
 ```
 
-The configuration file should list the services you want to collect data for:
+Example with CopperEgg as a storage and service plugins for *memcached* and *mysql* configured:
 ```yml
 logfile: /var/log/bipbip.log
 loglevel: INFO
@@ -27,7 +27,7 @@ include: services.d/
 storages:
   -
     name: copperegg
-    api_key: YOUR_APIKEY
+    api_key: <YOUR_APIKEY>
 
 services:
   -
@@ -38,132 +38,73 @@ services:
     plugin: mysql
     hostname: localhost
     port: 3306
-    username: root
-    password: root
-  -
-    plugin: mongodb
-    hostname: localhost
-    port: 27017
-    username:
-    password:
-  -
-    plugin: redis
-    hostname: localhost
-    port: 6379
-  - 
-    plugin: resque
-    hostname: localhost
-    port: 6379
-    database: 10
-    namespace: resque-prefix
-    frequency: 60
-  -
-    plugin: gearman
-    hostname: localhost
-    port: 4730
-  -
-    plugin: apache2
-    url: http://localhost:80/server-status?auto
-  -
-    plugin: nginx
-    url: http://localhost:80/server-status
-  -
-    plugin: network
-  -
-    plugin: monit
-    hostname: localhost
-    port: 2888
-    ssl:  true
-    auth: true
-    username: foo
-    password: bar
-  -
-    plugin: php-apc
-    url: http://localhost:80/apc-status
-  -
-    plugin: fastcgi-php-fpm
-    host: localhost
-    port: 9000
-    path: /fpm-status
-  -
-    plugin: fastcgi-php-apc
-    host: localhost
-    port: 9000
-  -
-    plugin: fastcgi-php-opcache
-    host: localhost
-    port: 9000
-  -
-    plugin: log-parser
-    path: /var/log/syslog
-    matchers:
-     -
-      name: oom_killer
-      regexp: 'invoked oom_killer'
-     -
-      name: segfault
-      regexp: segfault
-  -
-    plugin: postfix
-  -
-    plugin: elasticsearch
-      hostname: localhost
-      port: 9200
-  -
-    plugin: puppet
 ```
 
-Optional configuration common to all plugins:
-- `frequency`: Override global frequency per plugin
-- `metric_group`: Use metric group name different from plugin name. Useful when using the same plugin twice.
+Configuration options:
+- **logfile** (optional): Path to log file. If not provided will log to `STDOUT`.
+- **loglevel** (optional): One of [Logger's levels](http://www.ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html). Defaults to `INFO`.
+- **frequency** (optional): How often to measure metrics (in seconds). Defaults to `60`.
+- **include** (optional): Optional directory where to look for *service plugin configurations* (relative to config file).
+- **storage**: List of storages to send data to.
+- **services**: List of service plugins from which to gather metrics.
 
-Include configuration
----------------------
-In your configuration you can specify a directory to include service configurations from:
+The `include` directive allows to set a directory from which to load additional *service plugin* configurations. The above example could also be structured with multiple files:
 ```
-include: services.d/
+.
+|-- config.yml
+`-- services.d
+    |-- memcached.yml
+    `-- mysql.yml
 ```
-This will include files from `/etc/bipbip/services.d/` and load them into the `services` configuration.
-
-You could then add a file `/etc/bipbip/services.d/memcached.yml`:
+Where `memcached.yml` would contain:
 ```yml
 plugin: memcached
 hostname: localhost
 port: 11211
 ```
 
-Plugins
--------
-#### fastcgi-php-fpm
-Requires the `cgi-fcgi` program (debian package: `libfcgi0ldbl`).
-
-#### fastcgi-php-apc
-Requires the `cgi-fcgi` program (debian package: `libfcgi0ldbl`).
-
-#### fastcgi-php-opcache
-Requires the `cgi-fcgi` program (debian package: `libfcgi0ldbl`).
-
-#### php-apc
-To collect `APC` stats of your apache process, please install the following script.
-
-Create file `/usr/local/bin/apc-status.php` with content of `data/apc-status.php`.
-
-Create apache config `/etc/apache2/conf.d/apc-status` with content:
-```
-Alias /apc-status /usr/local/bin/apc-status.php
-
-<Files "/usr/local/bin/apc-status.php">
-	Order deny,allow
-	Deny from all
-	Allow from 127.0.0.1
-</Files>
-```
-
-Then set the `url`-configuration for the plugin to where the script is being served, e.g. `http//localhost:80/apc-status`.
-
-Custom external plugins
------------------------
-Additional plugins can be created as independent gems.
+The configuration for each *service plugin* is described further down.
+The following options are available for all plugins:
+- `frequency`: Override the global measurement frequency.
+- `metric_group`: Use a metric group name different from the plugin's name. Useful when using the same plugin twice.
+
+Storages
+--------
+Currently *bipbip* has only one storage available, but more could be added.
+
+### copperegg
+Send metrics to [CopperEgg](http://copperegg.com/)'s custom metrics API (*RevealMetrics*).
+
+Configuration options:
+- **api_key**: Your API key
+
+Service Plugins
+---------------
+These service plugins ship with bipbip:
+- memcached
+- mysql
+- mongodb
+- redis
+- resque
+- gearman
+- apache2
+- nginx
+- network
+- monit
+- php-apc
+- fastcgi-php-fpm
+- fastcgi-php-apc
+- fastcgi-php-opcache
+- log-parser
+- postfix
+- elasticsearch
+- puppet
+
+Please refer to [/docu/services.md](/docu/services.md) for information about the individual plugins and their configuration options.
+
+Custom Service Plugins
+----------------------
+Additional service plugins can be created as independent gems.
 They should include a class `Plugin::MyPlugin` in the `BipBip` module extending `Plugin`.
 On that class the functions `metrics_schema` and `monitor` should be implemented.
 

data/lib/bipbip/plugin/puppet.rb

@@ -7,11 +7,9 @@ module Bipbip
 
     def metrics_schema
       [
+          {:name => 'report_ok', :type => 'gauge', :unit => 'Boolean'},
           {:name => 'last_run_total_time', :type => 'gauge', :unit => 'Seconds'},
           {:name => 'last_run_age', :type => 'gauge', :unit => 'Seconds'},
-          {:name => 'has_event', :type => 'gauge', :unit => 'Boolean'},
-          {:name => 'has_resources', :type => 'gauge', :unit => 'Boolean'},
-          {:name => 'has_changes', :type => 'gauge', :unit => 'Boolean'},
           {:name => 'events_failure_count', :type => 'gauge', :unit => 'Events'},
           {:name => 'events_success_count', :type => 'gauge', :unit => 'Events'},
           {:name => 'events_total_count', :type => 'gauge', :unit => 'Events'},
@@ -29,20 +27,30 @@ module Bipbip
       has_events = puppet_report.has_key?('events')
       has_resources = puppet_report.has_key?('resources')
       has_changes = puppet_report.has_key?('changes')
-      {
+
+      metrics = {
+          'report_ok' => ((has_events and has_changes and has_resources) ? 1 : 0),
           'last_run_total_time' => puppet_report['time']['total'].to_i,
           'last_run_age' => report_age,
-          'has_events' => has_events,
-          'has_resources' => has_resources,
-          'has_changes' => has_resources,
-          'events_failure_count' => (has_events ? puppet_report['events']['failure'].to_i : 0),
-          'events_success_count' => (has_events ? puppet_report['events']['success'].to_i : 0),
-          'events_total_count' => (has_events ? puppet_report['events']['total'].to_i : 0),
-          'resources_failed_count' => (has_resources ? puppet_report['resources']['failed'].to_i : 0),
-          'resources_skipped_count' => (has_resources ? puppet_report['resources']['skipped'].to_i : 0),
-          'resources_total_count' => (has_resources ? puppet_report['resources']['total'].to_i : 0),
-          'changes_total_count' => (has_changes ? puppet_report['changes']['total'].to_i : 0),
       }
+
+      if has_events
+        metrics['events_failure_count'] = puppet_report['events']['failure'].to_i
+        metrics['events_success_count'] = puppet_report['events']['success'].to_i
+        metrics['events_total_count'] = puppet_report['events']['total'].to_i
+      end
+
+      if has_resources
+        metrics['resources_failed_count'] = puppet_report['resources']['failed'].to_i
+        metrics['resources_skipped_count'] = puppet_report['resources']['skipped'].to_i
+        metrics['resources_total_count'] = puppet_report['resources']['total'].to_i
+      end
+
+      if has_changes
+        metrics['changes_total_count'] = puppet_report['changes']['total'].to_i
+      end
+
+      metrics
     end
 
     private

data/lib/bipbip/storage/copperegg.rb

@@ -40,7 +40,10 @@ module Bipbip
     end
 
     def store_sample(plugin, time, data)
-      CopperEgg::MetricSample.save(plugin.metric_group, plugin.source_identifier, time.to_i, data)
+      response = CopperEgg::MetricSample.save(plugin.metric_group, plugin.source_identifier, time.to_i, data)
+      if response.code != '200'
+        raise("Cannot store copperegg data `#{data}`. Response code `#{response.code}`, message `#{response.message}`, body `#{response.body}`")
+      end
     end
 
     def _load_metric_groups

data/lib/bipbip/version.rb

@@ -1,3 +1,3 @@
 module Bipbip
-  VERSION = '0.5.8'
+  VERSION = '0.5.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bipbip
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.9
 platform: ruby
 authors:
 - Cargo Media
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: copperegg