juju deploy telegraf
|latest/candidate||44||44||11 Oct 2021|
The plugin-driven server agent for collecting & reporting metrics. Read more
Discuss this charm
Share your thoughts on this charm with the community on discourse.
This is a subordinate charm to deploy the telegraf metrics agent to collect metrics from related services. The metrics may be scraped by or pushed to supported systems such as Prometheus, Graphite or InfluxDB.
For details about telegraf see: https://github.com/influxdata/telegraf
Deploy telegraf alongside your service, and also a time series storage (in this case, influxdb)
juju deploy telegraf juju deploy influxdb juju deploy some-service
Add the relations:
juju add-relation telegraf:juju-info some-service:juju-info juju add-relation telegraf:influxdb-api influxdb:api
Network space support
The charm support the 'prometheus-client' binding for the prometheus-client interface. If the charm is deployed with 'prometheus-client' bound to a network space then the client relation will contain the network space IP address rather than the unit's private address.
Note for deployment into LXC containers
When deployed into a container, the following plugins are disabled:
- cpu, disk, diskio, mem, swap, system, bcache, bond, cgroup, kernel_vmstat
On very busy environments with lots of LXC containers per host, some metrics collected by default may contribute to performance issues with lxcfs. In order to reduce this, you may wish to consider disabling the following plugins:
- net, netstat, conntrack, nstat
Installation method: deb or snap
The charm can deploy using either a deb (default) or a snap installation. juju config telegraf install_method=deb # to use the debian package juju config telegraf install_method=snap # to use the snap Only the needed package (deb or snap) will be installed.
To change the snap channel: juju config telegraf snap_channel=beta
By default, Prometheus output is presented available for scraping.
When related to an InfluxDB service, metrics will be pushed to a database
For the apache input plugin, the charm provides the apache relation which
apache-website interface. Current apache charm disables
mod_status and in order to telegraf apache input to work
should be removed from the list of
disable_modules in the apache charm
Postgresql & MySQL input
Due to relation scope issues,
two relations need to be established between telegraf and the postgresql
service. first a plain
juju-info relation to get standard system
metrics and a
db-admin relation for PostgreSQL database metrics. eg.:
``` juju add-relation postgresql:juju-info telegraf juju add-relation postgresql:db-admin telegraf ```
Similarly, for MySQL:
``` juju add-relation mysql:juju-info telegraf juju add-relation mysql:db-admin telegraf ```
You will need both relations:
juju add-relation telegraf:juju-info rabbitmq-server:juju-infoto start serving data
juju add-relation telegraf:amqp rabbitmq-server:amqpfor the actual rabbitmq communication
This relation requires rabbitmq management plugin to be activated:
juju config rabbitmq-server management_plugin=true
The rabbitmq charm doesn't appear to give true administrator privileges to relations.
On the rabbitmq unit, you will need to grant permissions for the newly created charm user:
rabbitmqctl set_permissions -p openstack telegraf-telegraf-XX ".*" ".*" ".*"
The charm configures telegraf to drop
idle_since metrics (e.g.
idle_since="2018-08-14 0:24:04") which break time series in Prometheus, since any difference in labels (presence or lack, and content) is treated as a new series.
A basic set of input plugins are setup by default, which can be overriden
inputs_config configuration option. Both of these accept raw
To configure any of the (default or via relation) plugins, the
extra_options charm config can be used. It's yaml, that needs to
be encoded as a string in the config. For example:
```yaml telegraf: # The trailing | means the following indented section is all one string. extra_options: | 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 ```
This extra options will only be applied to plugins configured via
relations and the following list (defined in
- inputs.cpu - inputs.disk - inputs.diskio - inputs.mem - inputs.net - inputs.netstat - inputs.swap - inputs.system
The only output plugin supported via relation is influxdb, any other output
plugin needs to be configured manually (via
To use a different metrics storage such as Graphite, the raw telegraf
plugin configuration needs to be set as a string in
configuration. For example:
```yaml telegraf: # The trailing | indicates a multiline string in yaml. outputs_config: | [[outputs.graphite]] servers = ["10.0.3.231:2003"] prefix = "juju_local.devel.telegraf" timeout = 10 ```
This will make telegraf agents to send the metrics to the graphite instance.