Prometheus JMX Exporter Ansible role

This ansible role installs a Prometheus Node Exporter in a debian environment.

• Getting Started
  • Prerequisities
  • Installing
• Usage
• Testing
• Built With
• Versioning
• Authors
• License
• Contributing

Getting Started

These instructions will get you a copy of the role for your ansible playbook. Once launched, it will install an Prometheus JMX Exporter server in a Debian system.

Note: Beginning with the 2.1.0 version, the default behaviour is the service sending logs to systemd's journal instead to a log file. You can change it modifying the necessary ansible vars (see defaults/main.yml)

Prerequisities

Ansible 2.9.x.x version installed. Inventory destination should be a Debian environment.

For testing purposes, Molecule with Vagrant as driver (with vagrant-hostmanager) and VirtualBox as provider.

Installing

Create or add to your roles dependency file (e.g requirements.yml):

- src: idealista.prometheus_jmx_exporter_role
  version: 2.1.2
  name: prometheus_jmx_exporter

Install the role with ansible-galaxy command:

ansible-galaxy install -p roles -r requirements.yml -f

Use in a playbook:

---
- hosts: someserver
  roles:
    - role: prometheus_jmx_exporter

Usage

Look to the defaults properties file to see the possible configuration properties.

Providing custom configuration

Starting from role version 2.x.x, in order to provide custom JMX Exporter configuration, set jmx_exporter_config_template_path to the template in your playbook that is the configuration file. For example:

jmx_exporter_config_template_path: "{{ playbook_dir }}/templates/jmx_exporter/config/jmx_config.yml"

In previous versions, this variable pointed to a folder instead of a file. If you are using this role since version 1.x, you may check our migration guide

Testing

Install dependencies

$ pipenv sync

For more information read the pipenv docs.

Testing

$ pipenv run molecule test 

Built With

Versioning

For the versions available, see the tags on this repository.

Additionaly you can see what change in each version in the CHANGELOG.md file.

Authors

• Idealista - Work with - idealista

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.