Puppet Class: prometheus

Inherited by:

prometheus::server
prometheus::pushgateway
prometheus::alertmanager
prometheus::bird_exporter
prometheus::grok_exporter
prometheus::node_exporter
prometheus::snmp_exporter
prometheus::mesos_exporter
prometheus::pushprox_proxy
prometheus::redis_exporter
prometheus::apache_exporter
prometheus::consul_exporter
prometheus::dellhw_exporter
prometheus::mysqld_exporter
prometheus::pushprox_client
prometheus::statsd_exporter
prometheus::haproxy_exporter
prometheus::mongodb_exporter
prometheus::process_exporter
prometheus::varnish_exporter
prometheus::blackbox_exporter
prometheus::collectd_exporter
prometheus::graphite_exporter
prometheus::postgres_exporter
prometheus::puppetdb_exporter
prometheus::rabbitmq_exporter
prometheus::memcached_exporter
prometheus::nginx_vts_exporter
prometheus::beanstalkd_exporter
prometheus::elasticsearch_exporter

Defined in:

manifests/init.pp

Overview

#sammary This module manages prometheus

Parameters:

• configname (String[1]) (defaults to: 'prometheus.yaml') —

  the name of the configfile, defaults to prometheus.yaml or prometheus.yml on most operating systems

• manage_user (Boolean) (defaults to: true) —

  Whether to create user for prometheus or rely on external code for that

• user (String) —

  User running prometheus

• manage_group (Boolean) (defaults to: true) —

  Whether to create user for prometheus or rely on external code for that

• purge_config_dir (Boolean) (defaults to: true) —

  Purge config files no longer generated by Puppet

• group (String) —

  Group under which prometheus is running

• bin_dir (Stdlib::Absolutepath) —

  Directory where binaries are located

• shared_dir (Stdlib::Absolutepath) —

  Directory where shared files are located

• arch (String[1]) (defaults to: $facts['os']['architecture']) —

  Architecture (amd64 or i386)

• version (String) —

  Prometheus release

• install_method (String) —

  Installation method: url or package (only url is supported currently)

• os (String[1]) (defaults to: downcase($facts['kernel'])) —

  Operating system (linux is supported)

• download_url (Optional[String]) —

  Complete URL corresponding to the Prometheus release, default to undef

• download_url_base (Prometheus::Uri) —

  Base URL for prometheus

• download_extension (String) —

  Extension of Prometheus binaries archive

• package_name (String) —

  Prometheus package name - not available yet

• package_ensure (String) —

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

• config_dir (String) —

  Prometheus configuration directory (default /etc/prometheus)

• localstorage (Stdlib::Absolutepath) —

  Location of prometheus local storage (storage.local argument)

• extra_options (Optional[String[1]]) —

  Extra options added to prometheus startup command

• config_hash (Hash) (defaults to: {}) —

  Startup config hash

• config_defaults (Hash) (defaults to: {}) —

  Startup config defaults

• config_template (String) —

  Configuration template to use (template/prometheus.yaml.erb)

• config_mode (String) —

  Configuration file mode (default 0660)

• service_enable (Boolean) (defaults to: true) —

  Whether to enable or not prometheus service from puppet (default true)

• service_ensure (Stdlib::Ensure::Service) (defaults to: 'running') —

  State ensured from prometheus service (default ‘running’)

• service_name (String) —

  Name of the prometheus service (default ‘prometheus’)

• manage_service (Boolean) (defaults to: true) —

  Should puppet manage the prometheus service? (default true)

• restart_on_change (Boolean) (defaults to: true) —

  Should puppet restart prometheus on configuration change? (default true) Note: this applies only to command-line options changes. Configuration options are always reloaded without restarting.

• init_style (Prometheus::Initstyle) (defaults to: $facts['service_provider']) —

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

• global_config (Hash) —

  Prometheus global configuration variables

• rule_files (Array) —

  Prometheus rule files

• scrape_configs (Array) —

  Prometheus scrape configs

• remote_read_configs (Array) —

  Prometheus remote_read config to scrape prometheus 1.8+ instances

• remote_write_configs (Array) —

  Prometheus remote_write config to scrape prometheus 1.8+ instances

• alerts (Variant[Array,Hash]) —

  alert rules to put in alerts.rules

• extra_alerts (Hash) (defaults to: {}) —

  Hash with extra alert rules to put in separate files.

• alert_relabel_config (Array) —

  Prometheus alert relabel config under alerting

• alertmanagers_config (Array) —

  Prometheus managers config under alerting

• storage_retention (String) —

  How long to keep timeseries data. This is given as a duration like “100h” or “14d”. Until prometheus 1.8.*, only durations understood by golang’s time.ParseDuration are supported. Starting with prometheus 2, durations can also be given in days, weeks and years.

• external_url (Optional[Variant[Stdlib::HTTPUrl, Stdlib::Unixpath, String[1]]]) (defaults to: undef) —

  The URL under which Alertmanager is externally reachable (for example, if Alertmanager is served via a reverse proxy). Used for generating relative and absolute links back to Alertmanager itself. If omitted, relevant URL components will be derived automatically.

• extract_command (Optional[String[1]]) —

  Custom command passed to the archive resource to extract the downloaded archive.

• collect_scrape_jobs (Optional[Array[Hash[String[1], Any]]]) (defaults to: []) —

  Array of scrape_configs. Format, e.g.:

  • job_name: some_exporter scheme: https

  The jobs defined here will be used to collect resources exported via prometheus::daemon, creating the appropriate prometheus scrape configs for each endpoint. All scrape_config options can be passed as hash elements. Only the job_name is mandatory.

• max_open_files (Optional[Integer]) (defaults to: undef) —

  The maximum number of file descriptors for the prometheus server. Defaults to ‘undef`, but set to a large integer to override your default OS limit. Currently only implemented for systemd based service.

• usershell (Stdlib::Absolutepath) —

  if requested, we create a user for prometheus or the exporters. The default shell is nologin. It can be overwritten to any valid path.

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

  –web.listen-address=“0.0.0.0:9090” Address to listen on for UI, API, and telemetry.

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

  –web.read-timeout=5m Maximum duration before timing out read of the request, and closing idle connections.

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

  –web.max-connections=512 Maximum number of simultaneous connections.

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

  –web.route-prefix=<path> Prefix for the internal routes of web endpoints. Defaults to path of –web.external-url.

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

  –web.user-assets=<path> Path to static asset directory, available at /user.

• web_enable_lifecycle (Boolean) (defaults to: false) —

  –web.enable-lifecycle Enable shutdown and reload via HTTP request

• web_enable_admin_api (Boolean) (defaults to: false) —

  –web.enable-admin-api Enable API endpoints for admin control actions.

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

  –web.page-title=“Prometheus Time Series Collection and Processing Server” Document title of Prometheus instance.

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

  –web.cors.origin=“.*” Regex for CORS origin. It is fully anchored. Example: ‘https?://(domain1|domain2).com’

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

  –storage.tsdb.retention.size=STORAGE.TSDB.RETENTION.SIZE

  EXPERIMENTAL

  Maximum number of bytes that can be stored for blocks. Units supported: KB,

  MB, GB, TB, PB. This flag is experimental and can be changed in future releases.

• storage_no_lockfile (Boolean) (defaults to: false) —

  –storage.tsdb.no-lockfile Do not create lockfile in data directory.

• storage_allow_overlapping_blocks (Boolean) (defaults to: false) —

  –storage.tsdb.allow-overlapping-blocks

  EXPERIMENTAL

  Allow overlapping blocks, which in turn enables vertical compaction and

  vertical query merge.

• storage_wal_compression (Boolean) (defaults to: false) —

  –storage.tsdb.wal-compression Compress the tsdb WAL.

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

  –storage.remote.flush-deadline=<duration> How long to wait flushing sample on shutdown or config reload.

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

  –storage.remote.read-sample-limit=5e7 Maximum overall number of samples to return via the remote read interface, in a single query. 0 means no limit. This limit is ignored for streamed response types.

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

  –storage.remote.read-concurrent-limit=10 Maximum number of concurrent remote read calls. 0 means no limit.

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

  –storage.remote.read-max-bytes-in-frame=1048576 Maximum number of bytes in a single frame for streaming remote read response types before marshalling. Note that client might have limit on frame size as well. 1MB as recommended by protobuf by default.

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

  –rules.alert.for-outage-tolerance=1h Max time to tolerate prometheus outage for restoring “for” state of alert.

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

  –rules.alert.for-grace-period=10m Minimum duration between alert and restored “for” state. This is maintained only for alerts with configured “for” time greater than grace period.

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

  –rules.alert.resend-delay=1m Minimum amount of time to wait before resending an alert to Alertmanager.

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

  –alertmanager.notification-queue-capacity=10000 The capacity of the queue for pending Alertmanager notifications.

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

  –alertmanager.timeout=10s Timeout for sending alerts to Alertmanager.

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

  REMOVED, v1 ONLY

  -alertmanager.url

  Comma-separated list of Alertmanager URLs to send notifications to. In Prometheus v2, Alertmanager must be discovered via service discovery

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

  –query.lookback-delta=5m The maximum lookback duration for retrieving metrics during expression evaluations.

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

  –query.timeout=2m Maximum time a query may take before being aborted.

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

  –query.max-concurrency=20 Maximum number of queries executed concurrently.

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

  –query.max-samples=50000000 Maximum number of samples a single query can load into memory. Note that queries will fail if they try to load more samples than this into memory, so this also limits the number of samples a query can return.

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

  REMOVED, v1 ONLY

  -query.staleness-delta=5m0s

  Staleness delta allowance during expression evaluations.

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

  REMOVED, v1 ONLY

  -web.telemetry-path=“/metrics”

  Path under which to expose metrics

• web_enable_remote_shutdown (Boolean) (defaults to: false) —

  REMOVED, v1 ONLY

  -web.enable-remote-shutdown=false

  Enable remote service shutdown.

• log_level (Optional[Enum['debug', 'info', 'warn', 'error', 'fatal']]) (defaults to: undef) —

  –log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error] Value of ‘fatal’ is also allowed in prometheus v1

• log_format (Optional[Enum['logfmt', 'json']]) (defaults to: undef) —

  –log.format=logfmt Output format of log messages. One of: [logfmt, json]

• config_show_diff (Boolean) (defaults to: true) —

  Whether to show prometheus configuration file diff in the Puppet logs.

• extra_groups (Array)
• env_file_path (Stdlib::Absolutepath)
• manage_prometheus_server (Boolean)
• manage_config (Boolean)

# File 'manifests/init.pp', line 214

class prometheus (
  String $user,
  String $group,
  Array $extra_groups,
  Stdlib::Absolutepath $bin_dir,
  Stdlib::Absolutepath $shared_dir,
  String $version,
  String $install_method,
  Prometheus::Uri $download_url_base,
  String $download_extension,
  String $package_name,
  String $package_ensure,
  String $service_name,
  String $config_dir,
  Stdlib::Absolutepath $localstorage,
  String $config_template,
  String $config_mode,
  Hash $global_config,
  Array $rule_files,
  Array $scrape_configs,
  Array $remote_read_configs,
  Array $remote_write_configs,
  Variant[Array,Hash] $alerts,
  Array $alert_relabel_config,
  Array $alertmanagers_config,
  String $storage_retention,
  Stdlib::Absolutepath $env_file_path,
  Boolean $manage_prometheus_server,
  Optional[String[1]] $extra_options,
  Optional[String] $download_url,
  Optional[String[1]] $extract_command,
  Boolean $manage_config,
  Stdlib::Absolutepath $usershell,
  Optional[String[1]] $web_listen_address                                       = undef,
  Optional[String[1]] $web_read_timeout                                         = undef,
  Optional[String[1]] $web_max_connections                                      = undef,
  Optional[String[1]] $web_route_prefix                                         = undef,
  Optional[String[1]] $web_user_assets                                          = undef,
  Boolean $web_enable_lifecycle                                                 = false,
  Boolean $web_enable_admin_api                                                 = false,
  Optional[String[1]] $web_page_title                                           = undef,
  Optional[String[1]] $web_cors_origin                                          = undef,
  Optional[String[1]] $storage_retention_size                                   = undef,
  Boolean $storage_no_lockfile                                                  = false,
  Boolean $storage_allow_overlapping_blocks                                     = false,
  Boolean $storage_wal_compression                                              = false,
  Optional[String[1]] $storage_flush_deadline                                   = undef,
  Optional[String[1]] $storage_read_sample_limit                                = undef,
  Optional[String[1]] $storage_read_concurrent_limit                            = undef,
  Optional[String[1]] $storage_read_max_bytes_in_frame                          = undef,
  Optional[String[1]] $alert_for_outage_tolerance                               = undef,
  Optional[String[1]] $alert_for_grace_period                                   = undef,
  Optional[String[1]] $alert_resend_delay                                       = undef,
  Optional[String[1]] $alertmanager_notification_queue_capacity                 = undef,
  Optional[String[1]] $alertmanager_timeout                                     = undef,
  Optional[String[1]] $alertmanager_url                                         = undef, #v1 only
  Optional[String[1]] $query_lookback_delta                                     = undef,
  Optional[String[1]] $query_timeout                                            = undef,
  Optional[String[1]] $query_max_concurrency                                    = undef,
  Optional[String[1]] $query_max_samples                                        = undef,
  Optional[String[1]] $query_staleness_delta                                    = undef, #v1 only
  Optional[String[1]] $web_telemetry_path                                       = undef, #v1 only
  Boolean $web_enable_remote_shutdown                                           = false, #v1 only
  Optional[Enum['debug', 'info', 'warn', 'error', 'fatal']] $log_level          = undef,
  Optional[Enum['logfmt', 'json']] $log_format                                  = undef,
  Hash $extra_alerts                                                            = {},
  Hash $config_hash                                                             = {},
  Hash $config_defaults                                                         = {},
  String[1] $os                                                                 = downcase($facts['kernel']),
  Optional[Variant[Stdlib::HTTPUrl, Stdlib::Unixpath, String[1]]] $external_url = undef,
  Optional[Array[Hash[String[1], Any]]] $collect_scrape_jobs                    = [],
  Optional[Integer] $max_open_files                                             = undef,
  String[1] $configname                                                         = 'prometheus.yaml',
  Boolean $service_enable                                                       = true,
  Boolean $manage_service                                                       = true,
  Stdlib::Ensure::Service $service_ensure                                       = 'running',
  Boolean $restart_on_change                                                    = true,
  Prometheus::Initstyle $init_style                                             = $facts['service_provider'],
  String[1] $arch                                                               = $facts['os']['architecture'],
  Boolean $manage_group                                                         = true,
  Boolean $purge_config_dir                                                     = true,
  Boolean $manage_user                                                          = true,
  Boolean $config_show_diff                                                     = true,
) {
  case $arch {
    'x86_64', 'amd64': { $real_arch = 'amd64' }
    'i386':            { $real_arch = '386' }
    'aarch64':         { $real_arch = 'arm64' }
    'armv7l':          { $real_arch = 'armv7' }
    'armv6l':          { $real_arch = 'armv6' }
    'armv5l':          { $real_arch = 'armv5' }
    'ppc64le':         { $real_arch = 'ppc64le' }
    default:           {
      fail("Unsupported kernel architecture: ${arch}")
    }
  }

  if $manage_prometheus_server {
    include prometheus::server
  }
}