Puppet Class: prometheus::bird_exporter

Inherits:: prometheus

Defined in:: manifests/bird_exporter.pp

Summary

This module manages prometheus bird exporter

Overview

Parameters:

arch (String[1]) (defaults to: $prometheus::real_arch) —

Architecture (amd64 or i386)
bin_dir (String[1]) (defaults to: '/usr/local/bin') —

Directory where binaries are located
download_extension (String) (defaults to: '') —

Extension for the release binary archive
download_url (Optional[String]) (defaults to: undef) —

Complete URL corresponding to the where the release binary archive can be downloaded
download_url_base (String[1]) (defaults to: 'https://github.com/czerwonk/bird_exporter/releases') —

Base URL for the binary archive
extra_groups (Array[String]) (defaults to: ['bird']) —

Extra groups to add the binary user to
extra_options (String[1]) (defaults to: '-bird.v2 -web.listen-address=127.0.0.1:9324 -format.new=true') —

Extra options added to the startup command
group (String[1]) (defaults to: 'bird-exporter') —

Group under which the binary is running
init_style (Prometheus::Initstyle) (defaults to: $facts['service_provider']) —

Service startup scripts style (e.g. rc, upstart or systemd)
install_method (String[1]) (defaults to: 'url') —

Installation method: url or package (only url is supported currently)
manage_group (Boolean) (defaults to: true) —

Whether to create a group for or rely on external code for that
manage_service (Boolean) (defaults to: true) —

Should puppet manage the service? (default true)
manage_user (Boolean) (defaults to: true) —

Whether to create user or rely on external code for that
os (String[1]) (defaults to: downcase($facts['kernel'])) —

Operating system (linux is the only one supported)
package_ensure (String[1]) (defaults to: 'installed') —

If package, then use this for package ensure default ‘latest’
package_name (String[1]) (defaults to: 'bird_exporter') —

The binary package name - not available yet
purge_config_dir (Boolean) (defaults to: true) —

Purge config files no longer generated by Puppet
restart_on_change (Boolean) (defaults to: true) —

Should puppet restart the service on configuration change? (default true)
service_enable (Boolean) (defaults to: true) —

Whether to enable the service from puppet (default true)
service_ensure (Stdlib::Ensure::Service) (defaults to: 'running') —

State ensured for the service (default ‘running’)
service_name (String[1]) (defaults to: 'bird_exporter') —

Name of the bird exporter service (default ‘bird_exporter’)
user (String[1]) (defaults to: 'bird-exporter') —

User which runs the service
version (String[1]) (defaults to: '1.2.4') —

The binary release version
export_scrape_job (Boolean) (defaults to: false)
scrape_port (Stdlib::Port) (defaults to: 9324)
scrape_job_name (String[1]) (defaults to: 'bird')
scrape_job_labels (Optional[Hash]) (defaults to: undef)
bin_name (Optional[String[1]]) (defaults to: undef)

See Also:

https://github.com/czerwonk/bird_exporter

Author:

Tim Meusel <tim@bastelfreak.de>

# File 'manifests/bird_exporter.pp', line 55

class prometheus::bird_exporter (
  String $download_extension              = '',
  String[1] $download_url_base            = 'https://github.com/czerwonk/bird_exporter/releases',
  Array[String] $extra_groups             = ['bird'],
  String[1] $group                        = 'bird-exporter',
  String[1] $package_ensure               = 'installed',
  String[1] $package_name                 = 'bird_exporter',
  String[1] $user                         = 'bird-exporter',
  String[1] $version                      = '1.2.4',
  Boolean $purge_config_dir               = true,
  Boolean $restart_on_change              = true,
  Boolean $service_enable                 = true,
  Stdlib::Ensure::Service $service_ensure = 'running',
  String[1] $service_name                 = 'bird_exporter',
  Prometheus::Initstyle $init_style       = $facts['service_provider'],
  String[1] $install_method               = 'url',
  Boolean $manage_group                   = true,
  Boolean $manage_service                 = true,
  Boolean $manage_user                    = true,
  String[1] $os                           = downcase($facts['kernel']),
  String[1] $extra_options                = '-bird.v2 -web.listen-address=127.0.0.1:9324 -format.new=true',
  Optional[String] $download_url          = undef,
  String[1] $arch                         = $prometheus::real_arch,
  String[1] $bin_dir                      = '/usr/local/bin',
  Boolean $export_scrape_job              = false,
  Stdlib::Port $scrape_port               = 9324,
  String[1] $scrape_job_name              = 'bird',
  Optional[Hash] $scrape_job_labels       = undef,
  Optional[String[1]] $bin_name           = undef,
) inherits prometheus {
  $real_download_url = pick($download_url,"${download_url_base}/download/${version}/${package_name}-${version}_${os}_${arch}")

  $notify_service = $restart_on_change ? {
    true    => Service[$service_name],
    default => undef,
  }

  prometheus::daemon { $service_name:
    install_method     => $install_method,
    version            => $version,
    download_extension => $download_extension,
    os                 => $os,
    arch               => $arch,
    real_download_url  => $real_download_url,
    bin_dir            => $bin_dir,
    notify_service     => $notify_service,
    package_name       => $package_name,
    package_ensure     => $package_ensure,
    manage_user        => $manage_user,
    user               => $user,
    extra_groups       => $extra_groups,
    group              => $group,
    manage_group       => $manage_group,
    purge              => $purge_config_dir,
    options            => $extra_options,
    init_style         => $init_style,
    service_ensure     => $service_ensure,
    service_enable     => $service_enable,
    manage_service     => $manage_service,
    export_scrape_job  => $export_scrape_job,
    scrape_port        => $scrape_port,
    scrape_job_name    => $scrape_job_name,
    scrape_job_labels  => $scrape_job_labels,
    bin_name           => $bin_name,
  }
}