Forge Home


Installs and configures the graylog collector sidecar


1,974 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

  • 3.2.0 (latest)
  • 3.1.0
  • 3.0.0
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Feb 3rd 2020
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, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.0.0
  • , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'dodevops-graylogcollectorsidecar', '3.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add dodevops-graylogcollectorsidecar
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install dodevops-graylogcollectorsidecar --version 3.2.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.



dodevops/graylogcollectorsidecar — version 3.2.0 Feb 3rd 2020



Table of Contents

  1. Description
  2. Setup
  3. Reference
  4. Limitations


This module installs and configures the Graylog collector sidecar.


Beginning with graylogcollectorsidecar

To install the graylog collector sidecar, simply configure the class:

class { 'graylogcollectorsidecar':
  api_url => '',
  version => '0.1.0',
  tags => [ 'apache.accesslog' ]

Or using hiera:

graylogcollectorsidecar::api_url: ""
graylogcollectorsidecar::version: "0.1.0"
    - apache.accesslog


class graylogcollectorsidecar

Parameter Description
version Select the version of the collector to install. Defaults to 'latest', which selects the latest available release version
api_url Graylog server api url (e.g.
tags An array of tags that the collector should be set up with

Additionally, all other parameters as noted in the collector sidecar documentation can be specified.

The node_id will be set to the local hostname, if not specified.


This module uses the githubreleases module to download the graylog distribution package from Github. However, Github imposes a rate limiting on unauthenticated requests, which the module does (currently, this module doesn't allow setting Github credentials).

So if you have a rather large deployment using this module, the rate limit might fail the deployment. If so, you'll have to wait for the Rate limit to be reset.

If this is a constant pain, please open an issue.

OS compatibility:

  • Debian-Family (Ubuntu, Debian)
  • RedHat-Family (RHEL, CentOS)