collect_iptables_metrics | boolean

Enable the collection of iptables metrics, using the iptables telegraf input plugin. Collecting these metrics requires sudo access - enabling this option will install an appropriate, locked-down sudoers file.

collect_smart_metrics | boolean

Enable the collection of S.M.A.R.T. metrics, using the "smart" telegraf input plugin. Collecting these metrics requires sudo access - enabling this option will install an appropriate, locked-down sudoers file.

collection_jitter | string

Default: 5s

Collection jitter is used to jitter the collection by a random amount. Each plugin will sleep for a random time within jitter before collecting. This can be used to avoid many plugins querying things like sysfs at the same time, which can have a measurable effect on the system.

cpu_idle | int

Default: 10

Percent of idle CPU at which to generate a Prometheus alert. Default 10%, i.e. alert if the CPU has less than 10% CPU running idle therefore 90% used by us+sy+wa+st.

debug | boolean

Run telegraf in debug mode

disabled_plugins | string

Colon(:) separated plugins names to disable, including builtin input plugins and custom exec metrics in `files/telegraf_exec_metrics.py`, e.g.: cpu:mem:buddyinfo:zoneinfo

extra_options | string

YAML with extra options for out|inputs managed by relations or in the default config. example: inputs: cpu: percpu: false fielddrop: ["time_*"] disk: mount_points: ["/"] ignore_fs: ["tmpfs", "devtmpfs"] elasticsearch: local: false cluster_health: true postgresql: databases: ["foo", "bar"] tagpass: db: ["template", "postgres"] outputs: influxdb: precision: ms

extra_packages | string

Space separated list of extra deb packages to install.

extra_plugins | string

Extra plugins, manually configured. This is expected to be a string and will be saved "as is" in telegraf.d/extra_plugins.conf

flush_interval | string

Default: 10s

Default data flushing interval for all outputs. You should not set this below interval. Maximum flush_interval will be flush_interval + flush_jitter

flush_jitter | string

Default: 5s

Jitter the flush interval by a random amount. This is primarily to avoid large write spikes for users running a large number of telegraf instances. ie, a jitter of 5s and interval 10s means flushes will happen every 10-15s

hostname | string

Default: {model}:{unit}

Override default hostname. {model} is replaced with the Juju model name and {unit} is replaced with the sanitized unit name (eg. service_name-0). {uuid} is replaced by the model UUID, for sites without unique model names. {host} is replaced by the machine hostname

inputs_config | string

[inputs.xxx] sections as a string, this override default input plugins.

install_keys | string

Default: - null

List of signing keys for install_sources package sources, per charmhelpers standard format (a yaml list of strings encoded as a string). The keys should be the full ASCII armoured GPG public keys. While GPG key ids are also supported and looked up on a keyserver, operators should be aware that this mechanism is insecure. null can be used if a standard package signing key is used that will already be installed on the machine, and for PPA sources where the package signing key is securely retrieved from Launchpad.

install_method | string

Default: deb

Installation method. Valid values are "deb" or "snap".

install_sources | string

Default: - ppa:telegraf-devs/ppa

List of extra apt sources, per charm-helpers standard format (a yaml list of strings encoded as a string). Each source may be either a line that can be added directly to sources.list(5), or in the form ppa:<user>/<ppa-name> for adding Personal Package Archives, or a distribution component to enable.

interval | string

Default: 10s

Default data collection interval for all plugins

lead_time | string

Default: 14d

Time period to use when alerting on predictive Prometheus rules, e.g a disk might run low on space in $lead_time, based on the previous usage over lead_time. Default 14d, i.e. based on the previous 14 days, alert if we have 14 days disk left. String, e.g. 14d, 4w.

logfile | string

Default: /var/log/telegraf/telegraf.log

Name of the file to be logged to when using the file logtarget. If set to the empty string then logs are written to stderr.

metric_buffer_limit | int

Default: 10000

Telegraf will cache metric_buffer_limit metrics for each output, and will flush this buffer on a successful write.

nagios_context | string

Default: juju

A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.

nagios_servicegroups | string

Default: juju

Comma separated list of nagios servicegroups for the telegraf check

outputs_config | string

[outputs.xxx] sections as a string

package_status | string

Default: install

The status of service-affecting packages will be set to this value in the dpkg database. Valid values are "install" and "hold".

prometheus_context | string

Default: juju

A string that will be used to identify this site in the 'cloud_name' label in Prometheus. If you're running multiple environments with the same services in them this allows you to differentiate between them.

prometheus_datasource | string

Default: prometheus

Specifies the datasource for Grafana dashboards. This usually corresponds to the application name of the related Prometheus. Defaults to "prometheus". Note: The complete datasource inserted into dashboard will be "$prometheus_datasource - Juju generated source" This matches how the Prometheus2/Grafana charms format the datasource.

prometheus_ip_range | string

If set, the comma-separated list of IP Ranges which are allowed to access metrics. ex: prometheus_ip_range = "192.168.0.0/24,192.168.1.0/30"

prometheus_output_port | string

Default: 9103

If set prometheus output plugin will be configured to listen on the provided port. If set to string "default" the charm will use default port (9103)

promreg_authtoken | string

The Prometheus Registration authtoken.

promreg_url | string

The http(s) url and port where the Prometheus Registration service is listening.

quiet | boolean

Run telegraf in quiet mode

round_interval | boolean

Default: True

Rounds collection interval to 'interval' ie, if interval="10s" then always collect on :00, :10, :20, etc.

snap_channel | string

Default: stable

Snap Store channel from which to install the telegraf snap.

snapd_refresh | string

How often snapd handles updates for installed snaps. The default (an empty string) is 4x per day. Set to "max" to check once per month based on the charm deployment date. You may also set a custom string as described in the 'refresh.timer' section here: https://forum.snapcraft.io/t/system-options/87

socket_listener_port | string

Default: 8094

If set, the input socket_listener will listen on the specified port. The default option is to listen to 8094.

tags | string

Comma separated list of global tags. ie, 'dc=us-east-1,rack=1a' will tag all metrics with dc=us-east-1 and rack=1a

wait_time | string

Default: 5m

When exporting Prometheus alerting rules, how long a condition should be true before firing an alert. String, e.g. 5m, 1h, etc.

Axino Telegraf