Merge pull request #28 from newrelic/config-fix

Config fix

Author: camdencheek

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.2.1 - 2018-10-23
+### Added
+- Additional descriptions for config parameters
+### Fixed
+- Incorrect YAML in config file
+
 ## 0.2.0 - 2018-10-04
 ### Added
 - Added index regex configuration parameter to allow limiting which indices are collected

elasticsearch-config.yml.sample

@@ -6,15 +6,16 @@ instances:
     arguments:
       config_path: <absolute path to the ElasticSearch configuration .yml file. (default "/etc/elasticsearch/elasticsearch.yml")>
       hostname: <hostname or IP where Elasticsearch Node is running. (default "localhost")>
-      local_hostname: <hostname or IP of the Elasticsearch node from which to collect inventory data. (default "localhost")>
+      local_hostname: <(Optional) Hostname or IP of the Elasticsearch node from which to collect inventory data. (default "localhost"). Should only be set if you do not wish to collect inventory data against localhost>
       username: <username for accessing Elasticsearch Node>
       password: <password for the given user.>
       port: <port on which Elasticsearch Node is listening. (default 9200)>
       timeout: <timeout in seconds for an API call (default 30)>
-      use_ssl <true or false to use SSL. If true Certificate bundle must be supplied>
-      ca_bundle_dir: <directory for certificate authority bundle, must be included if use_ssl is true>
-      ca_bundle_file: <file for certificate authority bundle, must be included if use_ssl is true>
-      collect_indices <true or false to collect indices metrics. If true collect indices, else do not>
-      collect_primaries <true or false to collect primaries metrics. If true collect primaries, else do not>
+      use_ssl: <(Optional) true or false to use SSL. If true Certificate bundle must be supplied. (default false)>
+      ca_bundle_dir: <(Optional) Required if use_ssl is true. Directory for certificate authority bundle, must be included if use_ssl is true>
+      ca_bundle_file: <(Optional) Required if use_ssl is true. File for certificate authority bundle, must be included if use_ssl is true>
+      indices_regex: <(Optional) Can be used to filter which indicies are collected. If left blank it will be ignored>
+      collect_indices: <(Optional) true or false to collect indices metrics. If true collect indices, else do not. (default true)>
+      collect_primaries: <(Optional) true or false to collect primaries metrics. If true collect primaries, else do not. (default true)>
     labels:
       role: elasticsearch

src/elasticsearch.go

@@ -27,7 +27,7 @@ type argumentList struct {
 
 const (
 	integrationName    = "com.newrelic.elasticsearch"
-	integrationVersion = "0.2.0"
+	integrationVersion = "0.2.1"
 )
 
 var (