``profile::telegraf``
=====================

This profile configures the `telegraf
<https://www.influxdata.com/time-series-platform/telegraf/>`_ metrics collection
agent.


Parameters
----------

===============================  ========  ================================================
**Name**                         **Type**  **Default**
-------------------------------  --------  ------------------------------------------------
enable_service                   bool
agent                            hash      hiera_hash('telegraf::agent')
metrics                          hash      lookup('telegraf::metrics', {merge => 'deep'})
===============================  ========  ================================================


``enable_service``
~~~~~~~~~~~~~~~~~~

Determines whether or not Puppet will start or stop the service.


``agent``
~~~~~~~~~

This hash can be used to set the following configuration options in
``/etc/telegraf/telegraf.conf``:

  - ``metric_buffer_limit``
  - ``collection_jitter``
  - ``flush_interval``
  - ``flush_jitter``
  - ``urls``


``metrics``
~~~~~~~~~~~

This hash defines the metrics which the telegraf agent will collect. The keys
are the names of the metrics and the values are hashes describing the metric.
Every key/value pair in these hashes will be added to the configuration files
directly without any checks.

Examples::

  'cpu':
    enable: true
  'disk':
    enable: true
    interval: '30m'
    ignore_fs:
      - 'aufs'
      - 'auristorfs'
      - 'devfs'