badsf

Author: suckatrash

README.md

@@ -13,9 +13,16 @@
 
 ## Description
 
-This module is used to configure grafana, telegraf, and influxdb to consume metrics from Puppet services.
+This module is used to configure grafana and influxdb to consume metrics from Puppet services.
+By default the metrics collection is done by another service called telegraf.
 
-You have the option of getting metrics from any or all of three of these methods:
+These services can all run on a single server by applying the base class.  You also have the option
+to use the [included defined types](#profile-defined-types) to configure telegraf on each of your Puppet infrastructure components
+(master,compilers, puppetdb, postgres server) and the metrics will be stored on another server
+running grafana and influxdb.  In environments where there is an existing grafana / influxdb
+instance, the later option probably makes the most sense.
+
+You have the option of collecting metrics using any or all of these methods:
 
 * Through telegraf, which polls several of Puppet's metrics endpoints (recommended)
 * Through Archive files from the [puppetlabs/puppet_metrics_collector](https://forge.puppet.com/puppetlabs/puppet_metrics_collector) module
@@ -74,18 +81,6 @@ class { 'puppet_metrics_dashboard':
 }
 ```
 
-### Allow access to PE-managed postgres nodes with the following class:
-
-This is required for collection of postgres metrics.  The class should be applied to the master (or postgres server if using external postgres).
-
-```
-class { 'puppet_metrics_dashboard::profile::postgres':
-  grafana_host => 'grafana-server.example.com',
-}
-```
-
-`grafana_host` is optional.  If you do not specify it, the class will look for a node with the `puppet_metrics_dashboard` class applied in PuppetDB and use the `certname` of the first host returned.  If the PuppetDB lookup fails and you do not specify `grafana_host` then the class outputs a warning.
-
 ### Enable Graphite support
 
 ```
@@ -123,6 +118,18 @@ By default, this will create a set of certificates in `/etc/grafana` that are ba
 
 _Note:_ Enabling SSL on Grafana will not allow for running on privileged ports such as `443`. To enable this capability you can use the suggestions documented in [this Grafana documentation](http://docs.grafana.org/installation/configuration/#http-port)
 
+### Allow access to PE-managed postgres nodes with the following class:
+
+This is required for collection of postgres metrics.  The class should be applied to the master (or postgres server if using external postgres).
+
+```
+class { 'puppet_metrics_dashboard::profile::postgres':
+  grafana_host => 'grafana-server.example.com',
+}
+```
+
+`grafana_host` is optional.  If you do not specify it, the class will look for a node with the `puppet_metrics_dashboard` class applied in PuppetDB and use the `certname` of the first host returned.  If the PuppetDB lookup fails and you do not specify `grafana_host` then the class outputs a warning.
+
 ### Profile defined types
 
 The module includes defined types that you can use with an existing grafana implementation.  For example: