Update report processor to add tag function based on Puppet facts. (#641)

Modify report class to manage report tags from facts through datadog
config yaml file.

Author: murdok5

README.md

@@ -65,7 +65,18 @@ Once the `datadog_agent` module is installed on your `puppetserver`/`puppetmaste
     - To support reporting, your Puppet master needs the [dogapi][3] gem installed by running the Puppet Agent on your master with this configuration or installing it manually with `gem`. You may need to restart your `puppetserver` service after installing the `dogapi` gem.
     - `puppetserver_gem` is defined as a module dependency. It is installed automatically when the module is installed.
 
-4. (Optional) Include integrations to use with the Agent, for example:
+4. (Optional) Enable tagging of reports with facts
+    You can add tags to reports that are sent to Datadog as events. These tags can be sourced from Puppet facts for the given node the report is regarding. These should be 1:1 and not involve structured facts (hashes, arrays, etc.) to ensure readability. To enable tagging, set the parameter `datadog_agent::reports::report_fact_tags` to the array value of facts—for example `["virtual","trusted.extensions.pp_role","operatingsystem"]` results in three separate tags per report event.
+
+    NOTE: Changing these settings requires a restart of pe-puppetserver (or puppetserver) to re-read the report processor. Ensure the changes are deployed prior to restarting the service(s).
+
+    Tips:
+    - Use dot index to specify a target fact; otherwise, the entire fact data set becomes the value as a string (not very useful)
+    - Do not duplicate common data from monitoring like hostname, uptime, memory, etc.
+    - Coordinate core facts like role, owner, template, datacenter, etc., that help you build meaningful correlations to the same tags from metrics
+
+
+5. (Optional) Include integrations to use with the Agent, for example:
 
    ```conf
    include 'datadog_agent::integrations::mongo'

lib/puppet/reports/datadog_reports.rb

@@ -13,6 +13,7 @@
   config = YAML.load_file(configfile)
   API_KEY = config[:datadog_api_key]
   API_URL = config[:api_url]
+  REPORT_FACT_TAGS = config[:report_fact_tags] || []
 
   if ENV['DD_PROXY_HTTP'].nil?
     ENV['DD_PROXY_HTTP'] = config[:proxy_http]
@@ -133,13 +134,18 @@ def process
       end
     end
 
+    facts = Puppet::Node::Facts.indirection.find(host).values
+    dog_tags = REPORT_FACT_TAGS.map { |name| "#{name}:#{facts.dig(*name.split('.'))}" }
+
     Puppet.debug "Sending events for #{@msg_host} to Datadog"
     @dog.emit_event(Dogapi::Event.new(event_data,
                                       msg_title: event_title,
                                       event_type: 'config_management.run',
                                       event_object: @msg_host,
                                       alert_type: alert_type,
                                       priority: event_priority,
-                                      source_type_name: 'puppet'), host: @msg_host)
+                                      source_type_name: 'puppet',
+                                      tags: dog_tags),
+                                      host: @msg_host)
   end
 end

manifests/init.pp

@@ -62,6 +62,8 @@
 #       Valid values here are: true or false.
 #   $dogstatsd_port
 #       Set value of the 'dogstatsd_port' variable. Defaultis 8125.
+#   $report_fact_tags
+#       Sets tags for report events sent to Datadog from specified facts
 #   $statsd_forward_host
 #       Set the value of the statsd_forward_host varable. Used to forward all
 #       statsd metrics to another host.
@@ -776,6 +778,7 @@
       hostname_extraction_regex => $hostname_extraction_regex,
       proxy_http                => $proxy_http,
       proxy_https               => $proxy_https,
+      report_fact_tags          => $report_fact_tags,
     }
   }
 

manifests/reports.pp

@@ -21,6 +21,7 @@
   $hostname_extraction_regex = undef,
   $proxy_http = undef,
   $proxy_https = undef,
+  $report_fact_tags = [],
   $datadog_site = 'datadoghq.com',
   $puppet_gem_provider = $datadog_agent::params::gem_provider,
 ) inherits datadog_agent::params {

templates/datadog-reports.yaml.erb

@@ -12,3 +12,9 @@
 <% if @proxy_https -%>
 :proxy_https: <%= @proxy_https %>
 <% end -%>
+<% if @report_fact_tags -%>
+:report_fact_tags:
+<%- @report_fact_tags.each do |tag| -%>
+  - <%= tag %>
+  <%- end -%>
+<% end -%>