Puppet Class: prometheus::nginx_vts_exporter

Inherits:
prometheus
Defined in:
manifests/nginx_vts_exporter.pp

Summary

This module manages prometheus nginx_vts_exporter

Overview

Note:

This class is deprecated.

Parameters:

  • arch (String) (defaults to: $prometheus::real_arch) —

    Architecture (amd64 or i386)

  • bin_dir (String) (defaults to: $prometheus::bin_dir) —

    Directory where binaries are located

  • nginx_scrape_uri (String) —

    The URI to obtain nginx JSON stats from

  • download_extension (String) —

    Extension for the release binary archive

  • download_url (Optional[Prometheus::Uri]) (defaults to: undef) —

    Complete URL corresponding to the where the release binary archive can be downloaded

  • download_url_base (String) —

    Base URL for the binary archive

  • extra_groups (Array) —

    Extra groups to add the binary user to

  • extra_options (String) (defaults to: '') —

    Extra options added to the startup command

  • group (String) —

    Group under which the binary is running

  • init_style (Prometheus::Initstyle) (defaults to: $prometheus::init_style) —

    Service startup scripts style (e.g. rc, upstart or systemd)

  • install_method (Prometheus::Install) (defaults to: $prometheus::install_method) —

    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) (defaults to: downcase($facts['kernel'])) —

    Operating system (linux is the only one supported)

  • package_ensure (String) —

    If package, then use this for package ensure default ‘latest’

  • package_name (String[1]) —

    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 (String) (defaults to: 'running') —

    State ensured for the service (default ‘running’)

  • service_name (String[1]) —

    Name of the nginx-vts exporter service (default ‘nginx-vts-exporter’)

  • user (String) —

    User which runs the service

  • version (String) (defaults to: '0.10.3') —

    The binary release version

  • proxy_server (Optional[String[1]]) (defaults to: undef) —

    Optional proxy server, with port number if needed. ie: example.com:8080

  • proxy_type (Optional[Enum['none', 'http', 'https', 'ftp']]) (defaults to: undef) —

    Optional proxy server type (none|http|https|ftp)

  • export_scrape_job (Boolean) (defaults to: false)
  • scrape_host (Optional[Stdlib::Host]) (defaults to: undef)
  • scrape_port (Stdlib::Port) (defaults to: 9913)
  • scrape_job_name (String[1]) (defaults to: 'nginx_vts')
  • scrape_job_labels (Optional[Hash]) (defaults to: undef) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'manifests/nginx_vts_exporter.pp', line 56

class prometheus::nginx_vts_exporter (
  String           $nginx_scrape_uri,
  String           $download_extension,
  String           $download_url_base,
  Array            $extra_groups,
  String           $group,
  String           $package_ensure,
  String[1]        $package_name,
  String[1]        $service_name,
  String           $user,
  # renovate: depName=hnlq715/nginx-vts-exporter
  String           $version                                  = '0.10.3',
  Boolean          $purge_config_dir                         = true,
  Boolean          $restart_on_change                        = true,
  Boolean          $service_enable                           = true,
  String           $service_ensure                           = 'running',
  Prometheus::Initstyle $init_style                          = $prometheus::init_style,
  Prometheus::Install $install_method                        = $prometheus::install_method,
  Boolean          $manage_group                             = true,
  Boolean          $manage_service                           = true,
  Boolean          $manage_user                              = true,
  String           $os                                       = downcase($facts['kernel']),
  String           $extra_options                            = '', # lint:ignore:params_empty_string_assignment
  Optional[Prometheus::Uri] $download_url                    = undef,
  String           $arch                                     = $prometheus::real_arch,
  String           $bin_dir                                  = $prometheus::bin_dir,
  Boolean $export_scrape_job                                 = false,
  Optional[Stdlib::Host] $scrape_host                        = undef,
  Stdlib::Port $scrape_port                                  = 9913,
  String[1] $scrape_job_name                                 = 'nginx_vts',
  Optional[Hash] $scrape_job_labels                          = undef,
  Optional[String[1]] $proxy_server                          = undef,
  Optional[Enum['none', 'http', 'https', 'ftp']] $proxy_type = undef,
) inherits prometheus {
  $real_download_url = pick($download_url,"${download_url_base}/download/v${version}/${package_name}-${version}.${os}-${arch}.${download_extension}")
  $notify_service = $restart_on_change ? {
    true    => Service[$service_name],
    default => undef,
  }

  deprecation(
    'prometheus::nginx_vts_exporter',
    'nginx_vts_exporter exporter is deprecated and will be removed in the next major release. See https://github.com/sysulq/nginx-vts-exporter/issues/93',
    false
  )

  $options = "-nginx.scrape_uri=\"${nginx_scrape_uri}\" ${extra_options}"

  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            => $options,
    init_style         => $init_style,
    service_ensure     => $service_ensure,
    service_enable     => $service_enable,
    manage_service     => $manage_service,
    export_scrape_job  => $export_scrape_job,
    scrape_host        => $scrape_host,
    scrape_port        => $scrape_port,
    scrape_job_name    => $scrape_job_name,
    scrape_job_labels  => $scrape_job_labels,
    proxy_server       => $proxy_server,
    proxy_type         => $proxy_type,
  }
}