Ansible Role: Node Exporter

This role installs node_exporter on Debian/Ubuntu and EL systems by default.

Requirements

No specific requirements are needed.

The systemd service for node_exporter sends logs to syslog, and the SyslogIdentifier is set as node_exporter. You can review the logs using the command sudo journalctl -u node_exporter.service. You may also want to set up rsyslog to collect logs from node_exporter and save them to a specific file. For managing log files, use the darkwizard242.logrotate role available on Ansible Galaxy.

Role Variables

Here are the available variables (found in defaults/main.yml):

Variables list:

node_exporter_app: node_exporter
node_exporter_version: 1.5.0
node_exporter_osarch: linux-amd64
node_exporter_archive_format: tar.gz
node_exporter_dl_url: "https://github.com/prometheus/{{ node_exporter_app }}/releases/download/v{{ node_exporter_version }}/{{ node_exporter_app }}-{{ node_exporter_version }}.{{ node_exporter_osarch }}.{{ node_exporter_archive_format }}"

node_exporter_app_group: "{{ node_exporter_app }}"
node_exporter_app_group_desired_state: present

node_exporter_app_user: "{{ node_exporter_app }}"
node_exporter_app_user_desired_state: present
node_exporter_app_user_home_state: no
node_exporter_app_user_shell: /bin/false

node_exporter_temp_path: /tmp

node_exporter_bin_path: /usr/local/bin
node_exporter_bin_path_mode: '0755'
node_exporter_bin_path_remote_src: yes

node_exporter_systemd_service_setup: true
node_exporter_systemd_service_name: "{{ node_exporter_app }}"
node_exporter_systemd_service_flags: --collector.systemd --collector.processes --collector.mountstats
node_exporter_systemd_service_template: "{{ node_exporter_app }}.service.j2"
node_exporter_systemd_service_template_dest: "/etc/systemd/system/{{ node_exporter_app }}.service"
node_exporter_systemd_service_template_user: root
node_exporter_systemd_service_template_group: root
node_exporter_systemd_service_template_dest_mode: '0644'
node_exporter_systemd_service_template_backup: yes
node_exporter_systemd_service_desired_state: restarted
node_exporter_systemd_service_desired_boot_enabled: yes

node_exporter_app_port: 9100
node_exporter_app_check_status_code: 200
node_exporter_app_check_status_code_retries: 10
node_exporter_app_check_status_code_delay: 5

Variables summary:

Dependencies

No dependencies.

Example Playbook

To install node_exporter with default settings in an Ansible playbook:

- hosts: servers
  roles:
    - role: darkwizard242.node_exporter

To customize the role (e.g., to specify a node_exporter version):

- hosts: servers
  roles:
    - role: darkwizard242.node_exporter
      vars:
        node_exporter_version: 1.0.1

To customize the role (e.g., to disable the systemd service setup):

- hosts: servers
  roles:
    - role: darkwizard242.node_exporter
      vars:
        node_exporter_systemd_service_setup: false

License

MIT

Author Information

This role was created by Ali Muhammad.