Galaxy
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

telegraf

Source Code Build Status License: MIT

Setup Telegraf metrics agent.


Default Variables

telegraf_aggregators

List of default aggregators, combined with extra.

Default value

telegraf_aggregators: []

Example usage

telegraf_aggregators:
  - plugin: foo
    config:
      - option1 = "value1"
      - option2 = "value2"

telegraf_aggregators_extra

Default value

telegraf_aggregators_extra: []

telegraf_collection_jitter

Collection jitter is used to jitter the collection by a random amount.

Default value

telegraf_collection_jitter: 0s

telegraf_debug

Log at debug level.

Default value

telegraf_debug: false

telegraf_docker_group_name

Default value

telegraf_docker_group_name: dockerroot

telegraf_flush_interval

Default flushing interval for all outputs.

Default value

telegraf_flush_interval: 10s

telegraf_flush_jitter

Jitter the flush interval by a random amount.

Default value

telegraf_flush_jitter: 0s

telegraf_global_tags

List of global tags.

Default value

telegraf_global_tags: []

Example usage

telegraf_global_tags:
  - key: rack
    value: r155
  - key: switch
    value: sw5

telegraf_hostname

Override default hostname.

Default value

telegraf_hostname: '{{ inventory_hostname }}'

telegraf_interval

Default data collection interval for all inputs.

Default value

telegraf_interval: 10s

telegraf_logfile

Name of the file to be logged to when using the file logtarget.

telegraf_logfile_rotation_interval

The logfile will be rotated after the time interval specified.

telegraf_logfile_rotation_max_archives

Maximum number of rotated archives to keep, any older logs are deleted.

telegraf_logfile_rotation_max_size

The logfile will be rotated when it becomes larger than the specified size.

telegraf_logtarget

Log target controls the destination for logs.

Default value

telegraf_logtarget: stderr

telegraf_metric_batch_size

Telegraf will send metrics to outputs in batches of this amount.

Default value

telegraf_metric_batch_size: 1000

telegraf_metric_buffer_limit

Maximum number of unwritten metrics per output.

Default value

telegraf_metric_buffer_limit: 10000

telegraf_omit_hostname

If set to True, do no set the host tag in the telegraf agent.

Default value

telegraf_omit_hostname: false

telegraf_packages_extra

Default value

telegraf_packages_extra: []

telegraf_plugins

List of default plugins, combined with extra.

Default value

telegraf_plugins:
  - plugin: net
    config:
      - ignore_protocol_stats = false
      - interfaces = ["eth*"]
  - plugin: cpu
    config:
      - percpu = true
      - totalcpu = true
      - collect_cpu_time = false
      - report_active = false
  - plugin: disk
    config:
      - ignore_fs = ["tmpfs", "devtmpfs", "devfs"]
  - plugin: filestat
    config:
      - files = ["/var/log/**.log"]
  - plugin: procstat
    config:
      - pattern = ".*"
  - plugin: netstat
  - plugin: diskio
  - plugin: kernel
  - plugin: mem
  - plugin: processes
  - plugin: swap
  - plugin: system
  - plugin: kernel_vmstat
  - plugin: linux_sysctl_fs

telegraf_plugins_extra

Default value

telegraf_plugins_extra: []

telegraf_precision

Precision will be set to the same timestamp order as the collection interval.

telegraf_processors

List of default processors, combined with extra.

Default value

telegraf_processors: []

Example usage

telegraf_processors:
  - plugin: foo
    config:
      - option1 = "value1"
      - option2 = "value2"

telegraf_processors_extra

Default value

telegraf_processors_extra: []

telegraf_prometheus_bind_ip

Default value

telegraf_prometheus_bind_ip: 127.0.0.1

telegraf_prometheus_bind_port

Default value

telegraf_prometheus_bind_port: 9273

telegraf_prometheus_password

Password used by Prometheus.

Default value

telegraf_prometheus_password: secure

telegraf_prometheus_tls_cert_path

Default value

telegraf_prometheus_tls_cert_path: /etc/pki/tls/certs/mycert.pem

telegraf_prometheus_tls_cert_source

Default value

telegraf_prometheus_tls_cert_source: mycert.pem

telegraf_prometheus_tls_enabled

Default value

telegraf_prometheus_tls_enabled: false

telegraf_prometheus_tls_key_path

Default value

telegraf_prometheus_tls_key_path: /etc/pki/tls/private/mykey.pem

telegraf_prometheus_tls_key_source

Default value

telegraf_prometheus_tls_key_source: mykey.pem

telegraf_prometheus_username

Username used by Prometheus.

Default value

telegraf_prometheus_username: prometheus

telegraf_quiet

Log only error level messages.

Default value

telegraf_quiet: true

telegraf_requires_docker_group

Optionally disable docker group join.

Default value

telegraf_requires_docker_group: false

telegraf_round_interval

Rounds collection interval to interval.

Default value

telegraf_round_interval: true

telegraf_template_files

Path to templates loaded into telegraf.d directory.

Default value

telegraf_template_files:
  - telegraf/templates/*.conf.j2

Discovered Tags

tls_renewal
 

Dependencies

None.