idealista.prometheus_jmx_exporter_role

Prometheus JMX Exporter Ansible Role

This Ansible role installs a Prometheus Node Exporter on a Debian system.

Getting Started
- Prerequisites
- Installing
Usage
Testing
Built With
Versioning
Authors
License
Contributing

Getting Started

These steps will help you get this role for your Ansible playbook. When you run it, it will install a Prometheus JMX Exporter server on a Debian system.

Note: From version 2.1.0, the default setting is for the service to log to systemd's journal instead of a log file. You can change this by modifying the required Ansible variables (see defaults/main.yml).

Prerequisites

Make sure you have Ansible version 2.9.x.x installed. You should also be working in a Debian environment.

For testing, use Molecule with Vagrant and VirtualBox.

Installing

Create or update 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 using the Ansible Galaxy command:

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

Use it in a playbook:

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

Usage

Check the defaults file for configuration options.

Providing Custom Configuration

Starting with version 2.x.x, to provide a custom JMX Exporter configuration, set the jmx_exporter_config_template_path variable to point to your configuration template in the playbook, like this:

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

In earlier versions, this variable referred to a folder instead of a file. If you're using this role from version 1.x, refer to our migration guide.