Add parameter for extra options to Telegraf inputs

This commit adds a new parameter for passing additional hash elements to
the options parameter of the Telegraf inputs used in this module.

Author: m0dular

manifests/telegraf/agent.pp

@@ -146,6 +146,7 @@
     'sslcert'     => '/etc/telegraf/puppet_cert.pem',
     'sslrootcert' => '/etc/telegraf/puppet_ca.pem',
   },
+  Optional[Hash] $extra_input_options = undef,
   Enum['yaml','toml'] $template_format = $puppet_operational_dashboards::template_format,
 ) {
   unless [$puppetserver_hosts, $puppetdb_hosts, $postgres_hosts, $profiles, $local_services].any |$service| { $service } {
@@ -350,6 +351,7 @@
         http_timeout_seconds => $http_timeout_seconds,
         template_format      => $template_format,
         include_pe_metrics   => $include_pe_metrics,
+        extra_input_options  => $extra_input_options,
       }
     }
 
@@ -360,6 +362,7 @@
         http_timeout_seconds => $http_timeout_seconds,
         template_format      => $template_format,
         include_pe_metrics   => $include_pe_metrics,
+        extra_input_options  => $extra_input_options,
       }
     }
 
@@ -370,6 +373,7 @@
         http_timeout_seconds => $http_timeout_seconds,
         template_format      => $template_format,
         include_pe_metrics   => $include_pe_metrics,
+        extra_input_options  => $extra_input_options,
       }
     }
 
@@ -417,6 +421,7 @@
           http_timeout_seconds => $http_timeout_seconds,
           template_format      => $template_format,
           include_pe_metrics   => $include_pe_metrics,
+          extra_input_options  => $extra_input_options,
         }
       }
     }
@@ -434,6 +439,7 @@
         http_timeout_seconds => $http_timeout_seconds,
         template_format      => $template_format,
         include_pe_metrics   => $include_pe_metrics,
+        extra_input_options  => $extra_input_options,
       }
     }
 
@@ -444,6 +450,7 @@
         http_timeout_seconds => $http_timeout_seconds,
         template_format      => $template_format,
         include_pe_metrics   => $include_pe_metrics,
+        extra_input_options  => $extra_input_options,
       }
       if $include_pe_metrics {
         puppet_operational_dashboards::telegraf::config { 'pcp':
@@ -452,6 +459,7 @@
           http_timeout_seconds => $http_timeout_seconds,
           template_format      => $template_format,
           include_pe_metrics   => $include_pe_metrics,
+          extra_input_options  => $extra_input_options,
         }
       }
     }
@@ -463,6 +471,7 @@
         http_timeout_seconds => $http_timeout_seconds,
         template_format      => $template_format,
         include_pe_metrics   => $include_pe_metrics,
+        extra_input_options  => $extra_input_options,
       }
     }
 

manifests/telegraf/config.pp

@@ -21,6 +21,7 @@
   Enum['present', 'absent'] $ensure = 'present',
   Enum['yaml','toml'] $template_format = 'toml',
   Boolean $include_pe_metrics,
+  Optional[Hash] $extra_input_options = undef,
 ) {
   unless $service in ['puppetserver', 'puppetdb', 'puppetdb_jvm', 'orchestrator', 'pcp'] {
     fail("Unknown service type ${service}")
@@ -56,7 +57,12 @@
 
     telegraf::input { "${service}_metrics":
       plugin_type => 'http',
-      options     => [$_inputs],
+      options     => if $extra_input_options {
+                       [$_inputs + $extra_input_options]
+                     }
+                     else {
+                       [$_inputs]
+                     },
     }
 
     # Create processors.strings.rename entries to rename full url to hostname

spec/defines/puppet_operational_dashboards_telegraf_config_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'json'
+require 'pry'
 
 describe 'puppet_operational_dashboards::telegraf::config' do
   let(:facts) { { os: { family: 'RedHat' } } }
@@ -169,4 +170,36 @@
       )
     }
   end
+
+  context 'when passing extra input options' do
+    let(:title) { 'puppetserver' }
+    let(:puppetserver_epp) do
+      JSON.parse(File.read('./spec/fixtures/defines/puppetserver_metrics.json'))
+    end
+    let(:params) do
+      {
+        ensure: 'present',
+        protocol: 'https',
+        http_timeout_seconds: 5,
+        hosts: ['localhost.foo.com'],
+        include_pe_metrics: true,
+        extra_input_options: {
+          tags: {
+            'foo' => 'bar',
+          }
+        }
+      }
+
+    end
+
+    it {
+      is_expected.to compile
+
+      # Testing that the Telegraf input contains identical Ruby objects was turning out to be difficult
+      # It was returning an error but saying the diffs were identical, so instead we just check the file
+      is_expected.to contain_file('/etc/telegraf/telegraf.d/puppetserver_metrics.conf').with_content(
+        %r{\[inputs\.http\.tags]\nfoo = \"bar\"}
+      )
+    }
+  end
 end