• This repository has been archived on 06/Mar/2023
  • Stars
    star
    504
  • Rank 87,509 (Top 2 %)
  • Language
    Python
  • License
    MIT License
  • Created almost 7 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Provision basic metrics exporter for prometheus monitoring tool

DEPRECATED

This role has been deprecated in favor of a the prometheus-community/ansible collection.

Ansible Role: node exporter

License Ansible Role GitHub tag

Warning

Due to limitations of galaxy.ansible.com we had to move the role to https://galaxy.ansible.com/cloudalchemy/node_exporter and use _ instead of - in role name. This is a breaking change and unfortunately, it affects all versions of node_exporter role as ansible galaxy doesn't offer any form of redirection. We are sorry for the inconvenience.

Description

Deploy prometheus node exporter using ansible.

Requirements

  • Ansible >= 2.7 (It might work on previous versions, but we cannot guarantee it)
  • gnu-tar on Mac deployer host (brew install gnu-tar)
  • Passlib is required when using the basic authentication feature (pip install passlib[bcrypt])

Role Variables

All variables which can be overridden are stored in defaults/main.yml and are listed in the table below.

Name Default Value Description
node_exporter_version 1.1.2 Node exporter package version. Also accepts latest as parameter.
node_exporter_binary_local_dir "" Enables the use of local packages instead of those distributed on github. The parameter may be set to a directory where the node_exporter binary is stored on the host where ansible is run. This overrides the node_exporter_version parameter
node_exporter_web_listen_address "0.0.0.0:9100" Address on which node exporter will listen
node_exporter_web_telemetry_path "/metrics" Path under which to expose metrics
node_exporter_enabled_collectors ["systemd",{textfile: {directory: "{{node_exporter_textfile_dir}}"}}] List of dicts defining additionally enabled collectors and their configuration. It adds collectors to those enabled by default.
node_exporter_disabled_collectors [] List of disabled collectors. By default node_exporter disables collectors listed here.
node_exporter_textfile_dir "/var/lib/node_exporter" Directory used by the Textfile Collector. To get permissions to write metrics in this directory, users must be in node-exp system group. Note: More information in TROUBLESHOOTING.md guide.
node_exporter_tls_server_config {} Configuration for TLS authentication. Keys and values are the same as in node_exporter docs.
node_exporter_http_server_config {} Config for HTTP/2 support. Keys and values are the same as in node_exporter docs.
node_exporter_basic_auth_users {} Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.

Example

Playbook

Use it in a playbook as follows:

- hosts: all
  roles:
    - cloudalchemy.node_exporter

TLS config

Before running node_exporter role, the user needs to provision their own certificate and key.

- hosts: all
  pre_tasks:
    - name: Create node_exporter cert dir
      file:
        path: "/etc/node_exporter"
        state: directory
        owner: root
        group: root

    - name: Create cert and key
      openssl_certificate:
        path: /etc/node_exporter/tls.cert
        csr_path: /etc/node_exporter/tls.csr
        privatekey_path: /etc/node_exporter/tls.key
        provider: selfsigned
  roles:
    - cloudalchemy.node_exporter
  vars:
    node_exporter_tls_server_config:
      cert_file: /etc/node_exporter/tls.cert
      key_file: /etc/node_exporter/tls.key
    node_exporter_basic_auth_users:
      randomuser: examplepassword 

Demo site

We provide an example site that demonstrates a full monitoring solution based on prometheus and grafana. The repository with code and links to running instances is available on github and the site is hosted on DigitalOcean.

Local Testing

The preferred way of locally testing the role is to use Docker and molecule (v3.x). You will have to install Docker on your system. See "Get started" for a Docker package suitable for your system. Running your tests is as simple as executing molecule test.

Continuous Integration

Combining molecule and circle CI allows us to test how new PRs will behave when used with multiple ansible versions and multiple operating systems. This also allows use to create test scenarios for different role configurations. As a result we have quite a large test matrix which can take more time than local testing, so please be patient.

Contributing

See contributor guideline.

Troubleshooting

See troubleshooting.

License

This project is licensed under MIT License. See LICENSE for more details.

More Repositories

1

ansible-prometheus

Deploy Prometheus monitoring system
Jinja
1,106
star
2

ansible-grafana

Platform for analytics and monitoring
Jinja
502
star
3

ansible-alertmanager

Deploy Prometheus Alertmanager service
Jinja
141
star
4

ansible-blackbox-exporter

Blackbox prober exporter
Python
59
star
5

ansible-coredns

Ansible provisioning of CoreDNS
Python
27
star
6

ansible-mysqld_exporter

Provision mysqld exporter for prometheus monitoring tool
Jinja
21
star
7

ansible-fluentd

Provision fluentd log collector
Shell
20
star
8

ansible-pushgateway

Install Prometheus pushgateway service
Python
19
star
9

ansible-process_exporter

Provision process exporter for prometheus monitoring tool
Python
18
star
10

ansible-snmp-exporter

Provision SNMP metrics exporter for prometheus monitoring
Python
17
star
11

skeleton

Ansible role skeleton used for new cloud alchemy roles
Shell
16
star
12

demo-site

Demo site auto-deployed with Ansible and Travis CI.
HTML
7
star
13

ansible-systemd-exporter

Deploy https://github.com/povilasv/systemd_exporter
Python
7
star
14

presentation

Presentation about prometheus deployment
HTML
7
star
15

ansible-smokeping_prober

Deploy smokeping prober
Python
7
star
16

ansible-ebpf_exporter

Ansible provisioning of eBPF exporter
Shell
5
star
17

ansible-bind_exporter

Ansible Role for the Prometheus Community bind_exporter
Python
4
star
18

ansible-cortex

Python
4
star
19

ansible-ipmi_exporter

IPMI Exporter
Python
3
star
20

auto-maintenance

Org wide automated repo maintenance
Shell
3
star
21

ansible-alertmanager-irc-relay

Ansible role for the alertmanager-irc-relay
Jinja
2
star
22

ansible-pushprox

PushProxy
Shell
1
star
23

dockerfiles

dockerfiles used in ansible role testing
Dockerfile
1
star