fluentd

Installs, configures, and manages Fluentd data collector

Module Stats

177,001 downloads

46,857 latest version

4.6 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Sep 1st 2017

This version is compatible with:

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'konstantin-fluentd', '0.10.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add konstantin-fluentd

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install konstantin-fluentd --version 0.10.0

Tags: logging, fluentd, td-agent, fluent

Documentation

konstantin/fluentd — version 0.10.0 Sep 1st 2017

Fluentd

Install, configure, and manage Fluentd data collector.

Module Description

Installs td-agent package
Generates configuration file td-agent.conf
Generates custom configuration files and saves them to config.d/
Manages td-agent service
Installs Fluentd gem plugins

Usage Examples

Basic

Install and start the service.

class { 'fluentd': }

Routing Events To Elasticsearch

Receive logs from other Fluentd instances and via UNIX domain socket. Forward the logs to Elasticsearch.

include fluentd

fluentd::plugin { 'fluent-plugin-elasticsearch': }

fluentd::config { '500_elasticsearch.conf':
  config => {
    'source' => [
      {
        'type' => 'forward',
      },
      {
        'type' => 'unix',
        'path' => '/tmp/td-agent/td-agent.sock',
      },
    ],
    'match'  => {
      'tag_pattern'     => '**',
      'type'            => 'elasticsearch',
      'index_name'      => 'foo',
      'type_name'       => 'bar',
      'logstash_format' => true,
    }
  }
}

Forwarding Events To Fluentd Aggregator

Read logs from UNIX domain socket, then forward them to Fluentd aggregators.

include fluentd

fluentd::config { '600_forwarding.conf':
  config => {
    'source' => {
      'type' => unix,
      'path' => '/tmp/td-agent/td-agent.sock',
    },
    'match'  => {
      'tag_pattern' => '**',
      'type'        => forward,
      'server'      => [
        { 'host' => 'example1.com', 'port' => 24224 },
        { 'host' => 'example2.com', 'port' => 24224 },
      ]
    }
  }
}

Hiera Support

Defining Fluentd resources in Hiera.

fluentd::plugins:
  'fluent-plugin-http':
    plugin_ensure: 0.1.0
  'fluent-plugin-elasticsearch':
    plugin_ensure: present
fluentd::configs:
  '100_fwd.conf':
    config:
      source:
        type: forward
  '200_stdout.conf':
    config:
      match:
        tag_pattern: test
        type: stdout

Config File Naming

All configs employ a numbering system in the resource's title that is used for ordering. When titling your config, make sure you prefix the filename with a number, for example, 999_catch_all.conf, 500_elasticsearch.conf (999 has smaller priority than 500)

Reference

Classes

Public Classes

fluentd: Main class, includes all other classes.

Private Classes

fluentd::install: Handles the packages.
fluentd::service: Handles the service.

Parameters

The following parameters are available in the fluentd class:

`repo_install`

Default value: true

`repo_name`

Default value: 'treasuredata'

`repo_desc`

Default value: 'TreasureData'

`repo_url`

Default value: 'http://packages.treasuredata.com/2/redhat/$releasever/$basearch'

`repo_enabled`

Default value: true

`repo_gpgcheck`

Default value: true

`repo_gpgkey`

Default value: 'https://packages.treasuredata.com/GPG-KEY-td-agent'

`repo_gpgkeyid`

Default value: 'C901622B5EC4AF820C38AB861093DB45A12E206F'

`package_name`

Default value: 'td-agent'

`package_ensure`

Default value: present

`service_name`

Default value: 'td-agent'

`service_ensure`

Default value: running

`service_enable`

Default value: true

`service_manage`

Default value: true

`service_provider`

Default value:

when $facts['osfamily'] == 'redhat': redhat
otherwise: undef

`config_file`

Default value: '/etc/td-agent/td-agent.conf'

`config_path`

Default value: '/etc/td-agent/config.d'

`config_owner`

Default value: 'td-agent'

`config_group`

Default value: 'td-agent'

`configs`

Default value: {}

`plugins`

Default value: {}

Public Defines

fluentd::config: Generates custom configuration files.
fluentd::plugin: Installs plugins.

The following parameters are available in the fluentd::plugin defined type:

`title`

Plugin name

`plugin_ensure`

Default value: present

`plugin_source`

Default value: 'https://rubygems.org'

`plugin_provider`

Default value: tdagent

`plugin_install_options`

Default value: [] see https://docs.puppetlabs.com/puppet/latest/reference/type.html#package-provider-gem, e.g.

plugin_install_options => [{'--http-proxy' => $http_proxy}]

The following parameters are available in the fluentd::config defined type:

`title`

Config filename

`config`

Config Hash, please see usage examples.

Limitations

Tested on CentOS 6, CentOS 7, Ubuntu 14.04, Debian 7.8

Development

Bug reports and pull requests are welcome!

Running Tests

$ bundle install
$ bin/rake lint
$ bin/rake metadata_lint
$ bin/rake spec
$ bin/rspec spec/lib
$ bin/rake beaker BEAKER_set=centos-6-x64
$ bin/rake beaker BEAKER_set=centos-7-x64
$ bin/rake beaker BEAKER_set=debian-7-amd64
$ bin/rake beaker BEAKER_set=ubuntu-server-1404-x64

License

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.

2017-09-01 - Release v. 0.10.0

Update version requirements for puppetlabs/stdlib
Update version requirements for puppetlabs/apt

2017-01-28 - Release v. 0.9.0

Use Puppet 4 data types
Run apt update before installing packages

2016-11-06 - Release v. 0.8.0

Add param plugins
Add param configs
Remove deprecated params plugin_names, plugin_ensure, plugin_source, plugin_provider, plugin_install_options

2016-10-13 - Release v. 0.7.0

Add param service_provider (@larsks)
Plugin version can be specified (@denis-sorokin)
Add params config_path and plugin_provider (@paramite)
Add params config_owner and config_group (@MartinMeinhold)
Deprecate param plugin_names
Deprecate param plugin_ensure
Deprecate param plugin_source
Deprecate param plugin_provider
Deprecate param plugin_install_options

2016-04-20 - Release v. 0.6.1

Remove rubygems package
Fix the issue with Ruby load path

2016-04-11 - Release v. 0.6.0

Rework config generation

2016-03-23 - Release v. 0.5.1

Use fully qualified param names (@tosmi)

2016-02-20 - Release v. 0.5.0

Add param plugin_install_options (@dembaca)

2016-02-03 - Release v. 0.4.0

Support CentOS 6

2016-01-22 - Release v. 0.3.2

Purge unmanaged config files
Manage td-agent.conf file with a fully qualified path (@EmilienM)
Fix the issue with td-agent service being enabled on each run on EL7

2015-12-02 - Release v. 0.3.1

Add param repo_desc

2015-10-28 - Release v. 0.3.0

Remove class fluentd::config
Add defined type fluentd::config
Add defined type fluentd::plugin

2015-10-22 - Release v. 0.2.0

Add param service_manage
Add param repo_gpgkeyid
Add param repo_install
Add param plugin_source
Rename param repo_baseurl to repo_url
Remove param config_template
Param validation
Support Ubuntu 14.04
Support Debian 7.8
Support nested config tags

2015-10-19 - Release v. 0.1.0

Initial release

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

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

fluentd

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

Fluentd

Module Description

Usage Examples

Basic

Routing Events To Elasticsearch

Forwarding Events To Fluentd Aggregator

Hiera Support

Config File Naming

Reference

Classes

Public Classes

Private Classes

Parameters

repo_install

repo_name

repo_desc

repo_url

repo_enabled

repo_gpgcheck

repo_gpgkey

repo_gpgkeyid

package_name

package_ensure

service_name

service_ensure

service_enable

service_manage

service_provider

config_file

config_path

config_owner

config_group

configs

plugins

Public Defines

title

plugin_ensure

plugin_source

plugin_provider

plugin_install_options

title

config

Limitations

Development

Running Tests

License

2017-09-01 - Release v. 0.10.0

2017-01-28 - Release v. 0.9.0

2016-11-06 - Release v. 0.8.0

2016-10-13 - Release v. 0.7.0

2016-04-20 - Release v. 0.6.1

2016-04-11 - Release v. 0.6.0

2016-03-23 - Release v. 0.5.1

2016-02-20 - Release v. 0.5.0

2016-02-03 - Release v. 0.4.0

2016-01-22 - Release v. 0.3.2

2015-12-02 - Release v. 0.3.1

2015-10-28 - Release v. 0.3.0

2015-10-22 - Release v. 0.2.0

2015-10-19 - Release v. 0.1.0

Dependencies

`repo_install`

`repo_name`

`repo_desc`

`repo_url`

`repo_enabled`

`repo_gpgcheck`

`repo_gpgkey`

`repo_gpgkeyid`

`package_name`

`package_ensure`

`service_name`

`service_ensure`

`service_enable`

`service_manage`

`service_provider`

`config_file`

`config_path`

`config_owner`

`config_group`

`configs`

`plugins`

`title`

`plugin_ensure`

`plugin_source`

`plugin_provider`

`plugin_install_options`

`title`

`config`