promtail

Deploy and configure Grafana's Promtail

Project URL RSS Feed Report issues

Module Stats

25,817 downloads

14,721 latest version

5.0 quality score

Version information

released Aug 31st 2021

This version is compatible with:

Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
Puppet >= 6.1.0 < 8.0.0
, , , , ,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'grafana-promtail', '2.1.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add grafana-promtail

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install grafana-promtail --version 2.1.0

Documentation

grafana/promtail — version 2.1.0 Aug 31st 2021

Promtail

Deploy and configure Grafana's Promtail on a node.

Description
Usage
Reference
Changelog
Limitations
Development
Module Release

Description

Promtail is an agent which ships the contents of local logs to a private Loki instance or Grafana Cloud. It is usually deployed to every machine that has applications needed to be monitored.

It primarily:

Discovers targets
Attaches labels to log streams
Pushes them to the Loki instance.

Currently, Promtail can tail logs from two sources: local log files and the systemd journal (on AMD64 machines only).

Usage

The simplest way to get started with this module is to add include promtail to a manifest and create your config settings in Hiera. Additional details and examples are contained in REFERENCE.md.

Reference

This module is documented via pdk bundle exec puppet strings generate --format markdown. Please see REFERENCE.md for more info.

Changelog

CHANGELOG.md is generated prior to each release via pdk bundle exec rake changelog. This process relies on labels that are applied to each pull request.

Limitations

At the moment, this module only supports Linux. Future versions will support additional OS's including Windows.

Development

Pull requests are welcome! A Vagrantfile is also included in this repository that can be used during development.

Module Release

Follow the steps below to tag a new release and push to The Forge using GitHub Actions.

Ensure that all closed PRs are labeled appropriately.
Create a "Release Prep" PR with the label "maintenance" containing changes made by the following:
1. Bump the module version (X.Y.Z) in metadata.json as appropriate based on closed PRs since the previous release. (i.e. "backwards-incomptible" is an X "release", "feature" is a Y release, and "bugfix" is a Z release)
2. Run pdk bundle exec puppet strings generate --format markdown. Any missing documentation will result in a failed pipeline.
3. Run pdk bundle exec rake changelog. Any unlabeled PRs will result in a failed pipeline.
Once the PR is merged, navigate to Actions --> Publish Module --> Run workflow --> select the main branch, and Run workflow.

Reference

Classes

Public Classes

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

Private Classes

promtail::config: Creates files and folders associated with promtail's config
promtail::install: Installs promtail
promtail::service: Creates a service defintion for promtail

Functions

promtail::strip_yaml_header: A function to strip the --- from the beginning of a string
promtail::to_yaml: A function to convert a hash into yaml for the promtail config

Classes

`promtail`

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

Sample of defining within a profile

class { 'promtail':
  clients_config_hash   => $clients_config_hash,
  positions_config_hash => $positions_config_hash,
  scrape_configs_hash   => $_real_scrape_configs_hash,
  password_file_content => $sensitive_password_file_content,
  password_file_path    => $password_file_path,
  service_ensure        => $service_ensure,
  server_config_hash    => $server_config_hash,
  target_config_hash    => $target_config_hash,
  bin_dir               => $bin_dir,
  checksum              => $checksum,
  version               => $version,
}

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: journal
      journal:
        max_age: 12h
        labels:
          job: systemd-journal
          host: "%{facts.networking.fqdn}"
      relabel_configs:
        - source_labels:
            - '__journal__systemd_unit'
          target_label: 'unit'
        - source_labels:
            - 'unit'
          regex: "session-(.*)"
          action: replace
          replacement: 'pam-session'
          target_label: 'unit'

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

The following parameters are available in the promtail class:

service_enable
service_ensure
clients_config_hash
positions_config_hash
scrape_configs_hash
bin_dir
checksum
version
server_config_hash
target_config_hash
password_file_path
password_file_content
source_url

`service_enable`

Data type: Boolean

The value passed to the service resource's enable parameter for promtail's service

`service_ensure`

Data type: Enum['running', 'stopped']

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

`clients_config_hash`

Data type: Hash

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

`positions_config_hash`

Data type: Hash

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

`scrape_configs_hash`

Data type: Hash

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

`bin_dir`

Data type: Stdlib::Absolutepath

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

`checksum`

Data type: 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`

Data type: String[1]

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

`server_config_hash`

Data type: Optional[Hash]

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

Default value: undef

`target_config_hash`

Data type: Optional[Hash]

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

Default value: undef

`password_file_path`

Data type: Optional[Stdlib::Absolutepath]

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

Default value: undef

`password_file_content`

Data type: Optional[Sensitive[String[1]]]

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

Default value: undef

`source_url`

Data type: Stdlib::HTTPUrl

The URL from which promtail packages can be downloaded

Default value: 'https://github.com/grafana/loki/releases/download'

Functions

`promtail::strip_yaml_header`

Type: Ruby 4.x API

A function to strip the --- from the beginning of a string

Examples

concat::fragment { 'server_config_hash':
  target  => $config_file,
  content => $promtail::server_config_hash.promtail::to_yaml.promtail::strip_yaml_header,
  order   => '10',
}

`promtail::strip_yaml_header(String $yaml_string)`

A function to strip the --- from the beginning of a string

Returns: String Returns the string with the leading header stripped off

Examples

concat::fragment { 'server_config_hash':
  target  => $config_file,
  content => $promtail::server_config_hash.promtail::to_yaml.promtail::strip_yaml_header,
  order   => '10',
}

`yaml_string`

Data type: String

A string that may start with the ---'s used to denote a YAML file

`promtail::to_yaml`

Type: Ruby 4.x API

A function to convert a hash into yaml for the promtail config

Examples

promtail::to_yaml($promtail::config_hash)

`promtail::to_yaml(Hash $config_hash)`

A function to convert a hash into yaml for the promtail config

Returns: String Returns the YAML version of the hash as a string

Examples

promtail::to_yaml($promtail::config_hash)

`config_hash`

Data type: Hash

A Puppet hash to be converted into YAML

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

promtail

Version information

This version is compatible with:

Start using this module

Documentation

Promtail

Description

Usage

Reference

Changelog

Limitations

Development

Module Release

Reference

Table of Contents

Classes

Public Classes

Private Classes

Functions

Classes

promtail

Examples

Sample of defining within a profile

Settings in a Hiera file

Merging scrape configs in Hiera

Parameters

service_enable

service_ensure

clients_config_hash

positions_config_hash

scrape_configs_hash

bin_dir

checksum

version

server_config_hash

target_config_hash

password_file_path

password_file_content

source_url

Functions

promtail::strip_yaml_header

Examples

promtail::strip_yaml_header(String $yaml_string)

Examples

yaml_string

promtail::to_yaml

Examples

promtail::to_yaml(Hash $config_hash)

Examples

config_hash

Change log

2.1.0 (2021-08-31)

Added

2.0.0 (2021-07-30)

Changed

Added

1.0.0 (2020-11-02)

Added

Fixed

0.3.1 (2020-01-13)

0.3.0 (2020-01-13)

0.2.0 (2019-12-12)

Fixed

0.1.0 (2019-10-25)

Dependencies

`promtail`

`service_enable`

`service_ensure`

`clients_config_hash`

`positions_config_hash`

`scrape_configs_hash`

`bin_dir`

`checksum`

`version`

`server_config_hash`

`target_config_hash`

`password_file_path`

`password_file_content`

`source_url`

`promtail::strip_yaml_header`

`promtail::strip_yaml_header(String $yaml_string)`

`yaml_string`

`promtail::to_yaml`

`promtail::to_yaml(Hash $config_hash)`

`config_hash`