-
Notifications
You must be signed in to change notification settings - Fork 11
Home
Welcome to the Prometheus JMX exporter role wiki!
For the moment, it will only have a quick and tiny migration guide from v1.x to v2, but we will add more content as soon as we find it interesting.
TL;DR: If updating the role version, add jmx_exporter_config_template_path variable specifying the path to your custom template to your playbook's vars files.
Prior to role version 2, no default configuration template was provided by the role: it always expected the user to provide it. For that reason, the role would fail if just use it out of the box.
To avoid this behavior, in version 2 we added a default template with a wildcard that basically scrapes all the JMX metrics available. Providing template config via playbook is, of course, still possible, but the way to do it has changed.
In version 1.x, to provide a template was done having a file named like the group name in the inventory under the folder specified via jmx_exporter_config_template_path.
Starting from version 2.0.0, it won't be necessary to name the configuration template as the host's group name. The jmx_exporter_config_template_path variable will specify exactly which file the role will use to provide the configuration. Problems can occur due to the default template. If jmx_exporter_config_template_path is not specified, the role will pick the default template and will override the one in the host(s) without failing. So, if you are updating the role version, please don't forget to add this variable specifying the path to your custom template to your playbook's vars files.