Ansible Role telegraf

This role installs and configures Telegraf.

Mandatory Requirements

Enable the official InfluxDB repository. This can be done using the linuxfabrik.lfops.repo_influxdb role.

If you use the telegraf playbook, this is automatically done for you.

Tags

Tag	What it does	Reload / Restart
`telegraf`	Installs and configures telegraf server	Restarts telegraf.service
`telegraf:state`	Manages the state of the telegraf server	-

Optional Role Variables

Variable	Description	Default Value
`telegraf__agent_interval`	String. Default data collection interval for all inputs.	`'10s'`
`telegraf__conf__host_var` / `telegraf__conf__group_var`	List of dictionaries. Configurations to deploy to `/etc/telegraf/telegraf.d/`. Subkeys: `filename`: Mandatory, string. Destination filename. Normally equal to the name of the source `template` used. Will be suffixed with `.conf`. `raw`: Optional, string. Raw content that should be part of the config. Only used when `template: 'raw'`. `state`: Optional, string. Either `present` or `absent`. Defaults to `present`. `template`: Mandatory, string. Which template to use for the config. Possible options: `raw` or `graylog`. `username`: Optional, string. Username. Set this to the Graylog access token when using `template: 'graylog'`. `by_role`: Optional, string. Name of the role that generated this config (for documentation purposes in the generated file).	`[]`
`telegraf__inputs_cpu_enable`	Boolean. Read metrics about cpu usage.	`true`
`telegraf__inputs_disk_enable`	Boolean. Read metrics about disk usage by mount point.	`true`
`telegraf__inputs_diskio_enable`	Boolean. Read metrics about disk IO by device.	`true`
`telegraf__inputs_kernel_enable`	Boolean. Get kernel statistics from `/proc/stat`.	`true`
`telegraf__inputs_mem_enable`	Boolean. Read metrics about memory usage.	`true`
`telegraf__inputs_net_enable`	Boolean. Gather metrics about network interfaces.	`false`
`telegraf__inputs_processes_enable`	Boolean. Get the number of processes and group them by status.	`true`
`telegraf__inputs_swap_enable`	Boolean. Read metrics about swap memory usage.	`true`
`telegraf__inputs_system_enable`	Boolean. Read metrics about system load & uptime.	`true`
`telegraf__inputs_vsphere_enable`	Boolean. Read metrics from one or many vCenters.	`false`
`telegraf__inputs_vsphere_password`	String. Password for vSphere authentication.	`''`
`telegraf__inputs_vsphere_username`	String. Username for vSphere authentication.	`''`
`telegraf__inputs_vsphere_vcenters`	List of strings. vCenter URLs to be monitored.	`[]`
`telegraf__outputs_influxdb_database`	String. The target database for metrics; will be created as needed. For UDP url endpoint database needs to be configured on server side.	`''`
`telegraf__outputs_influxdb_password`	String. Password for HTTP Basic Auth to InfluxDB.	`''`
`telegraf__outputs_influxdb_skip_database_creation`	Boolean. Skip database creation (we assume the InfluxDB role creates the database).	`true`
`telegraf__outputs_influxdb_urls`	List of strings. The full HTTP or UDP URL for your InfluxDB instance. Multiple URLs can be specified for a single cluster, only ONE of the urls will be written to each interval.	`['http://127.0.0.1:8086']`
`telegraf__outputs_influxdb_username`	String. Username for HTTP Basic Auth to InfluxDB.	`''`
`telegraf__service_enabled`	Boolean. Enables or disables the telegraf service, analogous to `systemctl enable/disable`.	`true`
`telegraf__service_state`	String. Changes the state of the service, analogous to `systemctl start/stop/restart/reload`. Possible options: * `started` * `stopped` * `restarted` * `reloaded`	`'started'`

Example:

# optional
telegraf__agent_interval: '30s'
telegraf__conf__host_var:
  - filename: 'graylog'
    state: 'present'
    template: 'graylog'
    username: 'linuxfabrik' # graylog access token (needs to be sent as the username)
  - filename: 'custom-input'
    state: 'present'
    template: 'raw'
    raw: |
      [[inputs.exec]]
        commands = ["/usr/local/bin/my-custom-script.sh"]
        data_format = "influx"
telegraf__inputs_cpu_enable: false
telegraf__inputs_disk_enable: false
telegraf__inputs_diskio_enable: false
telegraf__inputs_kernel_enable: false
telegraf__inputs_mem_enable: false
telegraf__inputs_net_enable: false
telegraf__inputs_processes_enable: false
telegraf__inputs_swap_enable: false
telegraf__inputs_system_enable: false
telegraf__inputs_vsphere_enable: true
telegraf__inputs_vsphere_password: 'password'
telegraf__inputs_vsphere_username: 'username'
telegraf__inputs_vsphere_vcenters:
  - 'https://vsphere/sdk'
telegraf__outputs_influxdb_database: 'telegraf'
telegraf__outputs_influxdb_password: 'password'
telegraf__outputs_influxdb_skip_database_creation: true
telegraf__outputs_influxdb_urls:
  - 'http://127.0.0.1:8086'
telegraf__outputs_influxdb_username: 'telegraf'
telegraf__service_enabled: true
telegraf__service_state: 'started'

License

The Unlicense

Author Information

Linuxfabrik GmbH, Zurich