Forge Home

promtail

Deploy and configure Grafana's Promtail

22,212 downloads

11,305 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 2.1.0 (latest)
  • 2.0.0
  • 1.0.0
  • 0.4.0 (deleted)
  • 0.3.1
  • 0.3.0
  • 0.2.0
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

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

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

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

grafana/promtail — version 2.1.0 Aug 31st 2021

Promtail

Build Status License

Deploy and configure Grafana's Promtail on a node.

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:

  1. Discovers targets
  2. Attaches labels to log streams
  3. 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.

  1. Ensure that all closed PRs are labeled appropriately.
  2. 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.
  3. Once the PR is merged, navigate to Actions --> Publish Module --> Run workflow --> select the main branch, and Run workflow.