collectd #4

Supports: trusty bionic

Description

collectd is a small daemon which collects system information periodically and provides mechanisms to monitor and store the values in a variety of ways. Since the daemon doesn't need to startup every time it wants to update the values it's very fast and easy on the system. Also, the statistics are very fine grained since the files are updated every 10 seconds by default. The collected information can be used to find current performance bottlenecks (performance analysis) and predict future system load (capacity planning). This charm was initially developed and maintained by Prometheus Charmers open-charmers@lists.launchpad.net


Juju collectd subordinate charm

This subordinate charm will deploy collectd daemon

Supports: Trusty, Bionic

Available features

  • Added support for bionic.
  • "write_prometheus" plugin support enabled by default.
  • Option "prometheus_output_port" to publish metrics in a custom port.
  • Added support for collectd and Prometheus Juju relation.
  • Support extra plugin configuration via charm option.
  • Fix clean-up logic when the unit removes

Prometheus Output

By default, write_prometheus plugin is enabled and can be used for metrics scraping without using any additional exporter.

Optionally by installing prometheus-collectd-exporter package, metrics are exposed for prometheus scraping (not recommended).

How to deploy the charm

The charm relates with any principal charm using juju-info interface. Assuming that the principal service is called ubuntu.

juju deploy cs:~open-charmers/collectd collectd
# and 
juju add-relation ubuntu collectd

To send metrics to the graphite server listening on 192.168.99.10 port 2003:

juju set collectd graphite_endpoint=192.168.99.10:2003

To expose metrics for prometheus on port 9103 (prometheus-exporter) under "/metrics" URL:

juju set collectd prometheus_export=http://127.0.0.1:9103/metrics

(New) To expose metrics for prometheus on port 9104 (inbuilt Collectd plugin) under "/metrics" URL:

juju config collectd prometheus_output_port="9104"

See config.yaml for more details about configuration options

Build and publish to charm store

To install the Charm Tools on Ubuntu: sudo snap install charm --classic Make sure you have logined using Ubuntu SSO charm login

git clone $COLLECTD_REPO_URL collectd
charm build collectd

charm push $PATH_TO_COLLECTD_BUILD/collectd cs:~open-charmers/collectd
# By default, charm build to /tmp/charm-builds

#Charm not released to any channel, to release,
charm release cs:~open-charmers/collectd-2
#mention the revision number for publishing to any release channel, ('stable' by default)

For local testing,

juju deploy $PATH_TO_COLLECTD_BUILD/collectd

Configuration

extra_config
(string) Extra plugin configuration added and enabled based on the option 'plugins'. No pre-installation validation for the added config lines. Note: To enable the plugins, add plugins: "syslog, df" example: <Plugin "syslog"> LogLevel "info" NotifyLevel "OKAY" </Plugin> <Plugin "df"> IgnoreSelected true </Plugin>
graphite_endpoint
(string) Optional graphite hostname(or IP) and port. For example: graphite.example.com:2003 If set write_graphite will be enabled and configured
graphite_prefix
(string) Prepended to unit hostname in graphite. Only used in graphite_endpoint is set
collectd.
graphite_protocol
(string) TCP or UDP. Only used if graphite_endpoint is set
TCP
hostname_type
(string) Controls how hostname is determined by collectd. Accepted values are: fqdn - sets "FQDNLookup true" in the collectd.conf hostname - use python socket.gethostname() to get hostname. Useful in clouds where FQDN lookup does not work If unset or set to empty string defaults to fqdn
install_keys
(string) YAML list of GPG keys for installation sources, as a string. For apt repository URLs, use the public key ID used to verify package signatures. For other sources such as PPA, use empty string. This list must have the same number of elements as install_sources, even if the key items are all empty string. An example to go with the above for install_sources: install_keys: | - "" - ""
install_sources
(string) YAML list of additional installation sources, as a string. The number of install_sources must match the number of install_keys. For example: install_sources: | - ppa:project1/ppa - ppa:project2/ppa
interval
(int) Interval at which to query values by default
10
nagios_context
(string) 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.
juju
nagios_servicegroups
(string) Comma separated list of nagios servicegroups for the graphite check
juju
network_target
(string) Configured collectd to send data over network to remote collectd intance. Example: 192.168.99.99:25826
plugins
(string) Comma separated list of plugins to enable. If set to "default" list of plugins will match defaults shipped with Ubuntu package
default
prometheus_export
(string) If set collectd will be configured to publish metrics to prometheus graphite_exporter service using write_http plugin. If host is set to 127.0.0.1 the charm will install collectd_exporter package which must be available for installation. See "install_sources" and "install_keys". Please note that it is also possible to send metric to remote collectd_exporter using collectd binary protocol. This can be done using "network_target" option. Examples: To send metrics to remote collectd_exporter instance using http POST to "/my-post-url": http://remote.host.example.com:9103/my-post-url To install collectd_exporter locally and expose metrics for prometheus scraping under "/metrics" URI set this option to: http://127.0.0.1:9103/metrics If set to "True", it'll default to "http://127.0.0.1:9103/metrics", specially handy if you're relating it to prometheus service, as this setting is still needed for the relation to work.
prometheus_output_port
(string) If set write_prometheus output plugin will be configured to listen on the provided port. If set to string "default" the charm will use default port (9104)"
9104