bosh-monitor 1.2865.0 → 1.2881.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f9f55a4cafda4c885516166da7af5159d473467
-  data.tar.gz: c58029e306d0c1ea7d87cf38ed8dfba78da261d6
+  metadata.gz: e44cc68a8009e216ec79aece78f1a22927fa0007
+  data.tar.gz: 5e88e52fed0c515c880d7f540be6d4a22f05b984
 SHA512:
-  metadata.gz: 7b02fbf180a9e100c77210173ba198259d7835a90f49b5e6e7db9915d268a51cd9bb1052ea2a8cd8f0ed158bac03b52c2bc793a50dafb48d4f88a703c9a2a56a
-  data.tar.gz: 39a839f66fc3273e79dc8481f1380a37a7cb91d9f239298e8a0042dfcf64f180bc392f73fc1d0fd73717799309372f94c584e0fb5996bb113febe01e9a21ec4c
+  metadata.gz: 570959d21dd5070d2acb688ef919e139808173769c87b68209826302b154c97b22d6ab212fc8ba2dc149972b3c536014f56be0cfc3e01d5b56e697fc92a1603f
+  data.tar.gz: 4255c42046e5243f3a12b8ffa8da5985f2d1db5d574b86b15baf7f4b07fca51d7e727c7201224baadc55475b6b8a867f45ba8c3239195ff735e4a63039b08bee

data/README.md

@@ -1,6 +1,6 @@
 ## Synopsis
 
-BOSH Monitor is a component that listens to and responds to events (Heartbeats & Alerts) on the message bus (NATS). 
+BOSH Monitor is a component that listens to and responds to events (Heartbeats & Alerts) on the message bus (NATS).
 
 The Monitor also includes a few primary components:
 - The Agent Monitor maintains a record of known agents (by heartbeat event subscription)
@@ -22,7 +22,7 @@ The message syntax is as follows:
 
 ## Alert Events
 
-A BOSH Alert is a specific type of event sent by BOSH components via the message bus. 
+A BOSH Alert is a specific type of event sent by BOSH components via the message bus.
 
 Alerts includes the following data:
 
@@ -62,8 +62,8 @@ Plugins are notified in the order that they were registered (based on configurat
 
 The Agent Monitor listens for heartbeat events on the message bus and handles them in the following way:
 
-- If the Agent is known to the Monitor then the last heartbeat timestamp gets updated. 
-- If the Agent is unknown to the Monitor then it is recorded with a flag that marks it as a "rogue agent". 
+- If the Agent is known to the Monitor then the last heartbeat timestamp gets updated.
+- If the Agent is unknown to the Monitor then it is recorded with a flag that marks it as a "rogue agent".
 
 No analysis is performed when a heatbeat is received. The Agent Analyzer process and Director Monitor polling are asynchronous to heartbeat event processing by the Agent Monitor.
 
@@ -77,14 +77,14 @@ The message syntax is as follows:
 |----------|------------|------------|
 | /deployments/\<deployment_name\>/vms | GET | JSON including agent ids, job names and indices for all managed VMs |
 
-- If a new agent is discovered via polling then it is recorded by the Monitor as part of the managed deployment. 
+- If a new agent is discovered via polling then it is recorded by the Monitor as part of the managed deployment.
 - If a "rogue agent" is discovered via polling then its "rogue agent" flag is cleared.
 
 The Director Monitor does not actively poll the agents themselves, just the Director. The Director Monitor simply remembers the state of the world as reported by polling and event processing so that the difference can be analyzed.
 
 ## Agent Analyzer
 
-The Agent Analyzer is a periodic process that generates "Agent Missing" alerts. 
+The Agent Analyzer is a periodic process that generates "Agent Missing" alerts.
 
 If an agent's heartbeat timestamp is not updated within the configured time period, the Agent Analyzer process will generate an "Agent Missing" alert.
 
@@ -103,3 +103,55 @@ BOSH Agent is responsible for mapping any underlying supervisor alert format to
 The Monitor is responsible for interpreting the JSON payload and mapping it to a sequence of Monitor & Plugin actions, possibly generating new alerts that bypass the message bus. Malformed payloads are ignored.
 
 Job name and index are not part of alerts from the Agent, those are looked up in the Director. If heartbeat came from a rogue agent and we have no job name and/or index then we note that fact in the alert description but don't try to be too worried about that (service name and agent id should be enough). We might consider including agent IP address as a part of heartbeat so we can track down rogue agents.
+
+## Authoring new health monitoring plugins
+
+There are many existing ways to communicate health alerts to the external world. If you need an additional method then you can create new `bosh-monitor` plugins.
+
+The following instructures are for developing/testing your new plugin into a new single-server BOSH:
+
+1. Clone bosh repo and install dependencies
+
+    ```
+    git clone https://github.com/cloudfoundry/bosh.git
+    cd bosh
+    bundle install
+    ```
+
+2. Run the current `bosh-monitor` tests to ensure they currently all pass
+
+    ```
+    cd bosh-monitor
+    rspec
+    ```
+
+2. Create a `plugin.rb` for your plugin extension https://github.com/cloudfoundry/bosh/tree/master/bosh-monitor/lib/bosh/monitor/plugins
+3. Create a matching test file for your plugin extension `spec.rb` https://github.com/cloudfoundry/bosh/tree/master/bosh-monitor/spec/unit/bosh/monitor/plugins
+4. Write tests and make them pass
+
+    ```
+    rspec
+    ```
+
+5. Allow configuration to be passed into the `health_monitor` job template to activate and configure your plugin https://github.com/cloudfoundry/bosh/blob/master/release/jobs/health_monitor/spec and https://github.com/cloudfoundry/bosh/blob/master/release/jobs/health_monitor/templates/health_monitor.yml.erb
+6. Run the rake task to create a bosh release of your modified `bosh`
+
+    ```
+    rake release:create_dev_release
+    ```
+
+7. Upload to your microbosh
+
+    ```
+    rake release:upload_dev_release
+    ```
+
+8. Construct a deployment manifest to deploy a new bosh https://github.com/cloudfoundry/bosh/blob/master/release/examples/bosh-openstack-solo.yml
+9. Deploy
+
+    ```
+    bosh deployment path/to/manifest.yml
+    bosh deploy
+    ```
+
+10. Externally test your plugin -> external thing

data/lib/bosh/monitor/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Monitor
-    VERSION = '1.2865.0'
+    VERSION = '1.2881.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bosh-monitor
 version: !ruby/object:Gem::Version
-  version: 1.2865.0
+  version: 1.2881.0
 platform: ruby
 authors:
 - VMware
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -136,9 +136,51 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.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: rspec-its
+  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: |-
   BOSH Health Monitor
-  14ebaf
+  756fc2
 email: support@cloudfoundry.com
 executables:
 - bosh-monitor-console