Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status


filebeat (36) Versions 0.2.1

Installs/Configures Elastic Filebeat

cookbook 'filebeat', '= 0.2.1', :supermarket
cookbook 'filebeat', '= 0.2.1'
knife supermarket install filebeat
knife supermarket download filebeat
Quality 100%

filebeat Cookbook

Cookbook Build Status

This is a Chef cookbook to manage Filebeat.

For Production environment, always prefer the most recent release.

Most Recent Release

cookbook 'filebeat', '~> 0.2.1'

From Git

cookbook 'filebeat', github: 'vkhatri/chef-filebeat'


Supported OS

This cookbook was tested on Windows, Amazon & Ubuntu Linux and expected to work on other RHEL platforms.

Cookbook Dependency

  • windows
  • powershell


  • filebeat::default - default recipe (use it for run_list)

  • filebeat::install - install filebeat

  • filebeat::config - configure filebeat

Core Attributes

  • default['filebeat']['version'] (default: 1.0.0-rc2): filebeat version

  • default['filebeat']['package_url'] (default: auto): package url

  • default['filebeat']['conf_dir'] (default: /etc/filebeat): filebeat yaml configuration file directory

  • default['filebeat']['conf_file'] (default: /etc/filebeat/filebeat.yml): filebeat configuration file

  • default['filebeat']['notify_restart'] (default: true): whether to restart filebeat service on configuration file change

  • default['filebeat']['disable_service'] (default: false): whether to stop and disable filebeat service

  • default['filebeat']['enable_localhost_output'] (default: true): by default add localhost hosts for output elasticsearch and logstash

  • default['filebeat']['prospectors_dir'] (default: /etc/filebeat/conf.d): prospectors configuration file directory

  • default['filebeat']['prospectors'] (default: {}): prospectors configuration file

Configuration File filebeat.yml Attributes

  • default['filebeat']['config']['filebeat']['prospectors'] (default: []): filebeat interface device name

  • default['filebeat']['config']['filebeat']['registry_file'] (default: /var/lib/filebeat/registry): filebeat services to capture packets

  • default['filebeat']['config']['filebeat']['config_dir'] (default: node['filebeat']['prospectors_dir']): filebeat prospectors configuration files folder

  • default['filebeat']['config']['output']['elasticsearch']['enabled'] (default: true): enable elasticsearch output

  • default['filebeat']['config']['output']['elasticsearch']['hosts'] (default: []): elasticsearch hosts

  • default['filebeat']['config']['output']['elasticsearch']['save_topology'] (default: false):

  • default['filebeat']['config']['output']['logstash']['enabled'] (default: true): enable logstash output

  • default['filebeat']['config']['output']['logstash']['hosts'] (default: []): logstash hosts

  • default['filebeat']['config']['output']['logstash']['loadbalance'] (default: true): set true to load balance between logstash hosts

  • default['filebeat']['config']['output']['logstash']['index'] (default: filebeat): logstash index name

  • default['filebeat']['config']['output']['logstash']['tls']['enabled'] (default: false):

  • default['filebeat']['config']['output']['logstash']['save_topology'] (default: false):

  • default['filebeat']['config']['output']['file']['enabled'] (default: false):

  • default['filebeat']['config']['output']['file']['path'] (default: /tmp/filebeat):

  • default['filebeat']['config']['output']['file']['filename'] (default: filebeat):

  • default['filebeat']['config']['output']['file']['rotate_every_kb'] (default: 10240):

  • default['filebeat']['config']['output']['file']['number_of_files'] (default: 7):

For more attribute info, visit below links:

How to Add Filebeat Prospectors via Node Attribute

Individual propspectors configuration file can be added using attribute default['filebeat']['prospectors']. Each prospector configuration will
be created as a different yaml file under default['filebeat']['prospector_dir'] with prefix prospector-

  "default_attributes": {
    "filebeat": {
      "prospectors": {
        "system_logs": {
          "filebeat": {
            "prospectors": [
                "paths": [
                "type": "log",
                "fields": {
                  "type": "system_logs"
        "secure_logs": {
          "filebeat": {
            "prospectors": [
                "paths": [
                "type": "log",
                "fields": {
                  "type": "secure_logs"
        "apache_logs": {
          "filebeat": {
            "prospectors": [
                "paths": [
                "type": "log",
                "ignore_older": "24h",
                "scan_frequency": "15s",
                "harvester_buffer_size": 16384,
                "fields": {
                  "type": "apache_logs"

Above configuration will create three different prospector files - prospector-system_logs.yml, prospector-secure_logs.yml and prospector-apache_logs.yml


  1. Fork the repository on Github
  2. Create a named feature branch (like add_component_x)
  3. Write your change
  4. Write tests for your change (if applicable)
  5. Run the tests (rake & rake knife), ensuring they all pass
  6. Write new resource/attribute description to
  7. Write description about changes to PR
  8. Submit a Pull Request using Github

Authors:: Virender Khatri and Contributors

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

windows >= 0.0.0
powershell >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

filebeat CHANGELOG

This file is used to list changes made in each version of the filebeat cookbook.


  • Brandon Wilson - Include dpkg options to keep old config files when upgrading filebeat to a new release. Without specifying the dpkg options, dpkg will attempt to interactively ask if it should keep the old conf file, or replace it with the vendor supplied conf file which comes with the new version of the package. Since chef is running dpkg non-interactively, it causes dpkg to exit with code 1, and the chef run fails.

  • Virender Khatri - Fix for #4, handle derived attribute for package_url

  • Patrick Christopher - Added support for Windows OS


  • Virender Khatri - Initial release of filebeat

Check the Markdown Syntax Guide for help with Markdown.

The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.

Foodcritic Metric

0.2.1 passed this metric