newrelic_plugins_hive 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c55f9dec6d89f1b0fce66210319f964b359b40a
-  data.tar.gz: a455ca4005482944454c831e96f521b5a59b946a
+  metadata.gz: f713204fa0d65bfdd45124412214e76addff851c
+  data.tar.gz: 4a7e0d8fe83fa0d4e8b93ecb2180a689a9abf078
 SHA512:
-  metadata.gz: ba7eaf1c1d07c7b7449bf40a09537e42c13741c83dc5e219c04aaadad081f916e239e359f126455280216c4f0d570752d94acaed5e04193c1b4877551209dfbc
-  data.tar.gz: 0c695ea6c60111803ffb2368ea75cd0069b4f90b43659dd66736e321192e32cd2f6eb0eb6a096e1b29020ad9665c500004cf90a01a2090fed6ccadaf6df193ad
+  metadata.gz: fc40238f67b09e77d5a93eb47f5d7062a6f46f60a1086092677b08bae30eabc44188f1e3aa10d77342ef43f43c5521e5860de485cc5627a50f44029ecf66f636
+  data.tar.gz: e61a046241fae01c2398b1a61ac67e47663df68313f718c519bd57de8a2420ab3ccc60061721ce5bde71fe597547f59f559692177a04a9a9149603b94ffbb53b

data/README.md

@@ -1 +1,90 @@
-Make sure to add plugins dependencies to your Gemfile
+# NewRelic Plugins Hive
+
+Without this gem, if you're using more then one plugin for NewRelic you need to download each plugin, configure it in different files and repositories, deploy it separately and run different process for each plugin (including monitor those processes etc...)
+NewRelic Plugins Hive allow you to easily download, configure and deploy multiple NewRelic plugins and run them all in one process!
+
+## Installation
+
+Install the gem:
+
+    $ gem install newrelic_plugins_hive
+    
+Create a new hive application (this will create a new folder with the name you specified and the default folder structure and files):
+
+	$ hive new <APP_NAME>
+    
+## Configure the hive
+
+First, you need to configure which New Relic plugins you want to use in the hive.
+To do that open the file `config/newrelic_hive.yml` and add for each plugin its github repository and a path to the agent file in the repository.
+
+Example structure of the file:
+
+	plugins:
+	  sidekiq:
+	    github: https://github.com/eksoverzero/newrelic_sidekiq_agent
+	    agent_path: newrelic_sidekiq_agent
+	  rabbitmq:
+	    github: https://github.com/gopivotal/newrelic_pivotal_agent
+	    agent_path: plugins/pivotal_rabbitmq_plugin/pivotal_rabbitmq_plugin.rb
+	  redis:
+	    github: https://github.com/gopivotal/newrelic_pivotal_agent
+	    agent_path: plugins/pivotal_redis_plugin/pivotal_redis_plugin.rb
+
+It is enough that `agent_path` attribute will specify a unique filname in the repository. So in the example above you can just use this `agent_path` for redis:
+
+	agent_path: pivotal_redis_plugin.rb
+
+#### Install the plugins in the hive
+
+This will download and extract the plugin agents that specified in `config/newrelic_hive.yml`:
+
+	$ hive install
+	
+## Configure each plugin
+
+Configuring the plugins in the hive requires 3 simple steps:
+
+1. Add your New Relic license key to `config/newrelic_plugin.yml`
+2. For each plugin, add the plugin specific configuration to `config/newrelic_plugin.yml` under the section `agents`
+3. Add additional gems to your Gemfile, if the plugins in the hive require it.
+
+__Example:__ The RabbitMQ plugin has a configuration to specify the rabbitmq url, as well as the Sidekiq plugins that requires the Redis uri, so example `config/newrelic_plugin.yml` will look like:
+
+	newrelic:
+	  license_key: 'YOUR_LICENSE_KEY_HERE'
+	
+	  # Set to '1' for verbose output, remove for normal output.
+	  verbose: 1
+	
+	agents:
+	  rabbitmq:
+	    management_api_url: http://user:password@hostname:55672
+	
+	  sidekiq_status_agent:
+	    -
+	      instance_name: "Name"
+	      uri: "redis://localhost:6379"
+	      namespace: "namespace"
+
+This example combine in the same `config/newrelic_plugin.yml` configurations from two different plugins (rabbitMQ and Sidekiq).
+You must look at your plugin documentation and follow the instructions how to configure it.
+
+## Usage
+
+Run the agent:
+
+	$ hive run
+	
+Or, as a maemon:
+
+	$ hive run -d start # Start the daemon
+	$ hive run -d stop # Stop the daemon
+	
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/hive_daemon_wrapper

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'bundler/setup'
 require 'newrelic_plugins_hive'
 
+Dir.chdir(ENV['PWD'])
 NewRelicPluginsHive.run

data/lib/newrelic_plugins_hive/version.rb

@@ -1,3 +1,3 @@
 module NewRelicPluginsHive
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_plugins_hive
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Elad Maimon