From b23441adc20cda96882b08f6c18c8509c66f6f9d Mon Sep 17 00:00:00 2001 From: Clay Gregory Date: Thu, 1 Jun 2017 21:31:18 -0500 Subject: [PATCH] add missing license file and installation instructions --- LICENSE.md | 21 +++++++++++++++++++++ README.md | 16 ++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..b01e692 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2013 Clay Gregory + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 6aeb640..9fa7d1b 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,20 @@ A simple Munin plugin for monitoring elasticsearch nodes in Ruby. Depends on [JS `elasticsearch_store` - Size of index on disk + +## Installation + +See the [Munin documentation](http://guide.munin-monitoring.org/) for complete instructions on [plugin usage](http://guide.munin-monitoring.org/en/latest/plugin/use.html). In short, once `elasticsearch_` is in your plugin directory, create symlinks for each desired mode in your Munin service dir (usually `/etc/munin/plugins/`). For example, to enable JVM monitoring: + +```bash +ln -s /usr/local/munin/lib/plugins/elasticsearch_ /etc/munin/plugins/elasticsearch_jvm +``` + + ## Configuration +You'll also need to create a configuration file for the plugin, usually this would be `/etc/munin/plugin-conf.d/elasticsearch`. + ### Variables * host - a elasticsearch node capable of providing stats interface (default localhost) * port - elasticsearch HTTP API port (default 9200) @@ -54,3 +66,7 @@ env.port 9200 env.node pinky rat ``` +## License + +See the included [LICENSE](LICENSE.md) for rights and limitations under the terms of the MIT license. +