/ansible-role-telegraf

Ansible role to deploy telegraf

Primary LanguageJinjaGNU General Public License v3.0GPL-3.0

ansible-role-telegraf

An Ansible role to deploy InfluxData's Telegraf agent.

Requirements

none

Role Variables

Name Description Default Value
telegraf_influxdb_repo_url Repository URL to use https://repos.influxdata.com/rhel/$releasever/$basearch/stable
telegraf_influxdb_repo_key URL of the package signing key for the above repository https://repos.influxdata.com/influxdata-archive_compat.key
telegraf_agent_global_tags Tags applied to all metrics none
telegraf_agent_interval Default data collection interval for all inputs as Go duration expression 10s
telegraf_agent_flush_interval Default flushing interval for all outputs. You shouldn't set this belowtelegraf_agent_interval. Go duration expression 10s
telegraf_agent_flush_jitter Jitter the flush interval by a random amount 0s < value < telegraf_agent_flush_jitter. Go duration expression 0s
telegraf_agent_round_interval Rounds collection interval to telegraf_agent_interval, ie, if telegraf_agent_interval is "10s" then always collect on :00, :10, :20, etc. false
telegraf_agent_collection_jitter Collection jitter is used to jitter the collection by a random amount. Go duration expression. Must be < than telegraf_agent_interval 0s
telegraf_agent_metric.batch_size Telegraf will send metrics to outputs in batches of at most telegraf_agent_metric_batch_size. 1000
telegraf_agent_metric.buffer_limit For failed writes, telegraf will cache metric_buffer_limit metrics for each output, and will flush this buffer on a successful write. 100000
telegraf_agent_debug Run telegraf with debug log messages. false
telegraf_agent_quiet Run telegraf in quiet mode (error log messages only). false
telegraf_agent_hostname Override default hostname, if empty the hostname will be automatically determined. none
telegraf_agent_omit_hostname If set to true, do no set the "host" tag in the telegraf agent. Do not change unless you really know what you are doing. false
telegraf_agent_logfile Logfile for telegraf, e.g. /var/log/telegraf/telegraf.log, will log to stderr if omitted. ``
telegraf_agent_log_rotation_interval Log rotation of the log-file, if logfile is given. 0h
telegraf_agent_log_max_size Max size of the log file, if logfile is given. 0MB
telegraf_agent_log_timezone Timezone for the log-entry in the log file, if logfile is given. local
telegraf_outputs_health_endpoint The health endpoint of the Telegraf instance as the only default output-plugin. http://127.0.0.1:8081

Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

    - hosts: servers
      roles:
        - role: telegraf
          vars:
            telegraf_agent_global_tags:
              foo: bar

License

ansible-role-telegraf - Role to deploy InfluxData's telegraf Copyright (C) 2020 Markus W Mahlberg

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.