Puppet Class: promtail

Defined in:
manifests/init.pp

Summary

promtail's main interface. All interactions should be with this class.

Overview

promtail’s main interface. All interactions should be with this class. The promtail module is intended to install and configure Grafana’s promtail tool for shipping logs to Loki.

Examples:

include promtail
class { 'promtail':
  config_hash           => $config_hash,
  password_file_path    => '/etc/promtail/.gc_pw',
  password_file_content => Sensitive('myPassword'),
}

Settings in a Hiera file

---
promtail::password_file_path: '/etc/promtail/.gc_pw'
promtail::password_file_content: ENC[PKCS7,MIIBasdfasdfasdfasdfasdfasdf==]
promtail::server_config_hash:
  server:
    http_listen_port: 9274
    grpc_listen_port: 0
promtail::clients_config_hash:
  clients:
    - url: 'https://logs-us-west1.grafana.net/api/prom/push'
      basic_auth:
        username: '1234'
        password_file: '/etc/promtail/.gc_pw'
promtail::positions_config_hash:
  positions:
    filename: /tmp/positions.yaml
promtail::scrape_configs_hash:
  scrape_configs:
    - job_name: system_secure
      entry_parser: raw
      static_configs:
      - targets:
          - localhost
        labels:
          job: var_log_secure
          host: "%{facts.networking.fqdn}"
          __path__: /var/log/secure
    - job_name: system_messages
      entry_parser: raw
      static_configs:
      - targets:
          - localhost
        labels:
          job: var_log_messages
          host: "%{facts.networking.fqdn}"
          __path__: /var/log/messages

Merging scrape configs in Hiera

class profile::logging::promtail {
  $_real_scrape_configs_hash = lookup('promtail_scrape_configs_hash', {merge => 'deep'})
  class { 'promtail':
    scrape_configs_hash => $_real_scrape_configs_hash,
  }
}

Parameters:

  • service_ensure (Enum['running', 'stopped']) —

    The value passed to the service resource’s ensure parameter for promtail’s service

  • clients_config_hash (Hash) —

    Describes how Promtail connects to multiple instances of Loki, sending logs to each. See github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md for all parameters.

  • positions_config_hash (Hash) —

    Describes how to save read file offsets to disk. See github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md for all parameters.

  • scrape_configs_hash (Hash) —

    Each scrape_config block configures how Promtail can scrape logs from a series of targets using a specified discovery method. See github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md for all parameters.

  • bin_dir (Stdlib::Absolutepath) —

    The directory in which to create a symlink to the promtail binary

  • checksum (String[1]) —

    The checksum of the promtail binary. Note: each platform has its own checksum. Values can be found with each release on GitHub

  • version (String[1]) —

    The version as listed on the GitHub release page See github.com/grafana/loki/releases for a list

  • server_config_hash (Optional[Hash]) (defaults to: undef) —

    Configures Promtail’s behavior as an HTTP server. Defaults will be used if this block is omitted. See github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md for all parameters.

  • target_config_hash (Optional[Hash]) (defaults to: undef) —

    Configures how tailed targets will be watched. Defaults will be used if this block is omitted. See github.com/grafana/loki/blob/master/docs/clients/promtail/configuration.md for all parameters.

  • password_file_path (Optional[Stdlib::Absolutepath]) (defaults to: undef) —

    The fully qualified path to the file containing the password used for basic auth

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

    The value to be placed in the password file. This value is cast to Sensitive via lookup_options defined in ‘data/common.yaml`



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'manifests/init.pp', line 113

class promtail (
  Enum['running', 'stopped'] $service_ensure,
  Hash $clients_config_hash,
  Hash $positions_config_hash,
  Hash $scrape_configs_hash,
  Stdlib::Absolutepath $bin_dir,
  String[1] $checksum,
  String[1] $version,
  Optional[Hash] $server_config_hash = undef,
  Optional[Hash] $target_config_hash = undef,
  Optional[Stdlib::Absolutepath] $password_file_path = undef,
  Optional[Sensitive[String[1]]] $password_file_content = undef,
){
  Class['promtail::install']
  -> Class['promtail::config']
  -> Class['promtail::service']

  contain promtail::install
  contain promtail::config
  contain promtail::service
}