Additional Readme edits, add deprecation warning

Author: suckatrash

README.md

@@ -20,7 +20,8 @@ These services can all run on a single server by applying the base class.  You a
 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.
+instance, the later option is recommended. See [Determining where telegraf runs](#determining-where-telegraf-runs) for further
+details.
 
 You have the option of collecting metrics using any or all of these methods:
 
@@ -30,14 +31,26 @@ You have the option of collecting metrics using any or all of these methods:
 
 ## Setup
 
-### Upgrade note
+### Upgrade notes, breaking changes in v2
+
+The `puppet_metrics_dashboard::profile::postgres` class is now deprecated and you should use the `puppet_metrics_dashboard::profile::Master::postgres_access` class instead.
+
+Parameters `telegraf_agent_interval` and `http_response_timeout` were previously integers but are now strings.  The value should match a time interval, such as `5s`, `10m`, or `1h`.
+
+`influxdb_urls` was previously a string, it should now be an array.
 
 Previous versions of this module put several `[[inputs.httpjson]]` entries in
 `/etc/telegraf/telegraf.conf`. These entries should be removed now as all
 module-specific settings now reside in individual files within
 `/etc/telegraf/telegraf.d/`. Telegraf will continue to work if you do not remove them, however, the old
 `[[inputs.httpjson]]` will not be updated going forward.
 
+### Determining where telegraf runs
+
+Telegraf can run on the grafana server or on each Puppet infrastructure node.  To configure telegraf to run on the same host that
+grafana runs on, use the `puppet_metrics_dashboard` class and the parameters: `master_list`, `puppetdb_list` and `postgres_host_list`.  These parameters determine which hosts that telegraf polls.
+
+To configure telegraf to run on each Puppet infrastructure node, use the corresponding profiles for those hosts.  See [Profile defined types](#profile-defined-types).  The `puppet_metrics_dashboard` class is still applied to a separate host to setup grafana and influxdb and the profile classes configure telegraf when applied to your Puppet infrastructure hosts.
 
 ### Beginning with puppet_metrics_dashboard
 
@@ -92,7 +105,7 @@ class { 'puppet_metrics_dashboard':
 }
 ```
 
-* This method requires enabling on the master side as described [here](https://puppet.com/docs/pe/2017.3/puppet_server_metrics/getting_started_with_graphite.html#enabling-puppet-server-graphite-support).  The hostname(s) that you use in `master_list` should match the value(s) that you used for `metrics_server_id` in the `puppet_enterprise::profile::master` class.
+* This method requires enabling on the master side as described [here](https://puppet.com/docs/pe/latest/puppet_server_metrics/getting_started_with_graphite.html#enabling-puppet-server-graphite-support).  The hostname(s) that you use in `master_list` should match the value(s) that you used for `metrics_server_id` in the `puppet_enterprise::profile::master` class.
 
 ### Enable Telegraf, Graphite, and Archive (puppet_metrics)
 
@@ -123,12 +136,12 @@ _Note:_ Enabling SSL on Grafana will not allow for running on privileged ports s
 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',
+class { 'puppet_metrics_dashboard::profile::master::postgres_access':
+  telegraf_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.
+`telegraf_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 `telegraf_host` then the class outputs a warning.
 
 ### Profile defined types
 
@@ -164,7 +177,7 @@ puppet_metrics_dashboard::profile::master::postgres{ $facts['networking']['fqdn'
 }
 ```
 
-#### Note on using defined the types
+#### Note on using the defined types
 
 Because of the way that the telegraf module works, these examples will overwrite any configuration in telegraf.config if it is *not* already puppet-managed.  See the [puppet-telegraf documentation](https://forge.puppet.com/puppet/telegraf#usage) on how to manage this file and add important settings.
 

manifests/init.pp

@@ -32,7 +32,7 @@
 # @param consume_graphite
 #   Whether to enable the InfluxDB Graphite plugin.
 #   Valid values are `true`, `false`. Defaults to `false`
-#   This parameter enables the Graphite plugin for InfluxDB to allow for injesting Graphite metrics. Ensure `influxdb_database_name` 
+#   This parameter enables the Graphite plugin for InfluxDB to allow for injesting Graphite metrics. Ensure `influxdb_database_name`
 #   contains `graphite` when using this parameter.
 #   _Note:_ If using Graphite metrics from the Puppet Master, this needs to be set to `true`.
 #
@@ -52,8 +52,8 @@
 # @param influxdb_database_name
 #   An array of databases that should be created in InfluxDB.
 #   Valid values are 'puppet_metrics','telegraf', 'graphite', and any other string. Defaults to `['puppet_metrics']`
-#   Each database in the array will be created in InfluxDB. 'puppet_metrics','telegraf', and 'graphite' are specially named and will 
-#   be used with their associated metric collection method. Any other database name will be created, but not utilized with 
+#   Each database in the array will be created in InfluxDB. 'puppet_metrics','telegraf', and 'graphite' are specially named and will
+#   be used with their associated metric collection method. Any other database name will be created, but not utilized with
 #   components in this module.
 #
 # @param influx_db_password
@@ -116,7 +116,7 @@
 #       integer that specifies the port number.
 #   Defaults to `[$trusted['certname']]`
 #
-# @param puppetdb_list
+# @param postgres_host_list
 #   A list of PostgreSQL servers that Telegraf will be configured to
 #   collect metrics from. Entries in the list may be:
 #     - A single string that contains a hostname or IP address.

manifests/profile/postgres.pp

@@ -0,0 +1,13 @@
+# @summary This class is deprecated.  Please use the Puppet_metrics_dashboard::Profile::Master::Postgres_access class.
+#
+# @param grafana_host
+#   The FQDN of the host where telegraf runs.
+#   Defaults to an empty string.  You can explicitly set this parameter or the class attempts to lookup which host has the puppet_metrics_dashboard class applied in PuppetDB.  If the parameter is not set and the lookup does not return anything we issue a warning.
+#
+class puppet_metrics_dashboard::profile::postgres (
+  String $grafana_host = ''
+){
+
+  fail('The Puppet_metrics_dashboard::Profile::Postgres class is deprecated.  Please use the Puppet_metrics_dashboard::Profile::Master::Postgres_access instead.')
+
+}

manifests/profile/puppetdb.pp

@@ -1,4 +1,4 @@
-# @summary Apply this class to an agent running puppetdb to collect puppetdb metrics
+# @summary Apply this class to a node running puppetdb to collect puppetdb metrics
 #
 # @param timeout
 #   Default timeout of http calls.  Defaults to 5 seconds

manifests/telegraf/config.pp

@@ -20,14 +20,17 @@
           {
             'urls'              => $puppet_metrics_dashboard::influxdb_urls,
             'database'          => $puppet_metrics_dashboard::telegraf_db_name,
-            'retention_policy'  => '',
             'write_consistency' => 'any',
             'timeout'           => '5s',
           },
         ],
       },
     }
 
+    file {'/etc/telegraf/telegraf.d/puppet_metrics_dashboard.conf':
+      ensure => absent,
+    }
+
     # Transform the host lists into arrays of "hostname:port", using a
     # service's default port if no alternate was specified.
     $_master_list = $puppet_metrics_dashboard::master_list.map |$entry| {