This is a Chef cookbook to manage Filebeat.
For Production environment, always prefer the most recent release.
cookbook 'filebeat', '~> 2.4.0'cookbook 'filebeat', github: 'vkhatri/chef-filebeat', tag: 'v2.4.0'https://github.com/vkhatri/chef-filebeat- Windows
- Amazon Linux
- CentOS
- Fedora
- Ubuntu
- Debian
- Mac OSX
Also works on Solaris zones given a physical Solaris 11.2 server. For that, use the .kitchen.zone.yml file. Check usage at (https://github.com/criticalmass/kitchen-zone). You will need an url to a filebeat package that works on Solaris 11.2. Checkout Building-Filebeat-On-Solaris11.md for instructions to build a filebeat package.
This cookbook is tested against current Chef version. But, the cookbook is known to work with Chef Client version >=12.14.
- 6.x
- 7.x
homebrewelastic_repoyum-plugin-versionlockrunitwindows
- lwrp_test - LWRP examples recipe
-
filebeat_config- filebeat configuration resource -
filebeat_install- filebeat install resource -
filebeat_install_preview- filebeat preview package install resource -
filebeat_service- filebeat service resource -
filebeat_runit_service- filebeat service resource using runit -
filebeat_prospector- filebeat prospector resource (renamed filebeat inputs in version 6.3+)
The Mac OSX setup only allows for package installs and depends on brew, this means that version selection and preview build installs are not supported.
LWRP filebeat_install installs filebeat, creates log/prospectors directories, and also enable filebeat service.
Below attributes are derived using helper methods and also used by other LWRP.
conf_dirprospectors_dirlog_dir
LWRP example
filebeat_install 'default' do
[options ..]
endLWRP Options
- action (optional) - default
:create, options: :create, :delete - version (optional, String) - default
6.3.0, filebeat version - release (optional, String) - default
1, filebeat release version, used byrhelfamily package resource - setup_repo (optional, Boolean) - default
true, set tofalse, to skip elastic repository setup using cookbookelastic_repo - ignore_package_version (optional, Boolean) - default
false, set to true, to install latest available yum/apt filebeat package - service_name (optional, String) - default
filebeat, filebeat service name, must be common across resources - disable_service (optional, Boolean) - default
false, set totrue, to disable filebeat service - notify_restart (optional, Boolean) - default
true, set tofalse, to ignore filebeat service restart notify - delete_prospectors_dir (optional, Boolean) - default
false, set totrue, to purge prospectors directory by deleting and recrating prospectors directory - conf_dir (optional, String, NilClass) - default
nil, filebeat configuration directory, this attribute is derived by helper method - prospectors_dir (optional, String, NilClass) - default
nil, filebeat prospectors directory, this attribute is derived by helper method - log_dir (optional, String, NilClass) - default
nil, filebeat log directory, this attribute is derived by helper method - windows_package_url (optional, String) - default
auto, windows filebeat package url - windows_base_dir (optional, String) - default
C:/opt/filebeat, filebeat windows base directory - apt_options (optional, Array) - default
%w[stable main], filebeat package resource attribute fordebianplatform family - elastic_repo_options (optional, Hash) - default
{}, resource elastic_repo options,filebeat_installattributeversionoverrideselasti_repo_optionskeyversionvalue. Check out elastic_repo cookbook for more details.
LWRP filebeat_service configures filebeat service.
LWRP example
filebeat_service 'default' do
[options ..]
endLWRP Options
- action (optional) - default
:create, options: :create, :delete - filebeat_install_resource_name (optional, String) - default
default, filebeat_install/filebeat_install_preview resource name, set this attribute if LWRP resource name is other thandefault - service_name (optional, String) - default
filebeat, filebeat service name, must be common across resources - disable_service (optional, Boolean) - default
false, set totrue, to disable filebeat service - purge_prospectors_dir (optional, Boolean) - default
false, set totrue, to purge prospectors - service_ignore_failure (optional, Boolean) - default
false, set totrue, to ignore filebeat service failures - service_retries (optional, Integer) - default
2, filebeat service resource attribute - service_retry_delay (optional, Integer) - default
0, filebeat service resource attribute
LWRP filebeat_config creates filebeat configuration yaml file /etc/filebeat/filebeat.yml.
Below filebeat configuration parameters gets overwritten by the LWRP.
filebeat.registry_filefilebeat.config_dirlogging.files
conf = {
'filebeat.modules' => [],
'prospectors' => [],
'logging.level' => 'info',
'logging.to_files' => true,
'logging.files' => { 'name' => 'filebeat' },
'output.elasticsearch' => { 'hosts' => ['127.0.0.1:9200'] }
}
filebeat_config 'default' do
config conf
action :create
endAbove LWRP Resource will create a file /etc/filebeat/filebeat.yml with content:
filebeat.modules: []
prospectors: []
logging.level: info
logging.to_files: true
logging.files:
path: "/var/log/filebeat"
output.elasticsearch:
hosts:
- 127.0.0.1:9200
filebeat.registry_file: "/var/lib/filebeat/registry"
filebeat.config_dir: "/etc/filebeat/conf.d"conf = {
'filebeat.modules' => [],
'filebeat.inputs' => [],
'logging.level' => 'info',
'logging.to_files' => true,
'logging.files' => { 'name' => 'filebeat' },
'output.elasticsearch' => { 'hosts' => ['127.0.0.1:9200'] }
}
filebeat_config 'default' do
config conf
action :create
endAbove LWRP Resource will create a file /etc/filebeat/filebeat.yml with content:
filebeat.modules: []
prospectors: []
logging.level: info
logging.to_files: true
logging.files:
path: "/var/log/filebeat"
output.elasticsearch:
hosts:
- 127.0.0.1:9200
filebeat.registry_file: "/var/lib/filebeat/registry"
filebeat.config.inputs:
enabled: true
path: "/etc/filebeat/conf.d/*.yml"LWRP Options
- action (optional) - default
:create, options: :create, :delete - filebeat_install_resource_name (optional, String) - default
default, filebeat_install/filebeat_install_preview resource name, set this attribute if LWRP resource name is other thandefault - config (Hash) - default
{}filebeat configuration options - config_sensitive (optional, Boolean) - default
false, filebeat configuration file chef resource attribute - service_name (optional, String) - default
filebeat, filebeat service name, must be common across resources - conf_file (optional, String, NilClass) - default
nil, filebeat configuration file, this attribute is derived by helper method - disable_service (optional, Boolean) - default
false, set totrue, to disable filebeat service - notify_restart (optional, Boolean) - default
true, set tofalse, to ignore filebeat service restart notify - prefix (optional, String) - default
lwrp-prospector-, filebeat prospecteor filename prefix, set to '' if no prefix is desired
LWRP filebeat_prospector creates a filebeat prospector configuration yaml file under prospectors directory with file name lwrp-prospector-#{resource_name}.yml.
lwrp-prospector- prefix can be changed with prefix property (see above).
LWRP example
conf = {
'enabled' => true,
'paths' => ['/var/log/messages'],
'type' => 'log',
'fields' => {'type' => 'messages_log'}
}
filebeat_prospector 'messages_log' do
config conf
action :create
prefix 'my-custom-prefix-'
endAbove LWRP Resource will create a file /etc/filebeat/conf.d/my-custom-prefix-messages_log.yml with content:
filebeat:
prospectors:
- enabled: true
paths:
- "/var/log/messages"
type: log
fields:
type: messages_logWith filebeat.config.inputs set, Filebeat 6.3+ will read in the files as previous versions and the same config will work as expected
conf = {
'type' => 'log',
'enabled' => true,
'paths' => ['/var/log/messages'],
'type' => 'log',
'fields' => {'type' => 'messages_log'}
}
filebeat_prospector 'messages_log' do
config conf
action :create
endthe file is created with content:
- enabled: true
paths:
- "/var/log/messages"
type: log
fields:
type: messages_logLWRP Options
- action (optional) - default
:create, options: :create, :delete - filebeat_install_resource_name (optional, String) - default
default, filebeat_install/filebeat_install_preview resource name, set this attribute if LWRP resource name is other thandefault - config (Hash) - default
{}filebeat configuration options - config_sensitive (optional, Boolean) - default
false, filebeat configuration file chef resource attribute - service_name (optional, String) - default
filebeat, filebeat service name, must be common across resources - disable_service (optional, Boolean) - default
false, set totrue, to disable filebeat service - notify_restart (optional, Boolean) - default
true, set tofalse, to ignore filebeat service restart notify
LWRP filebeat_runit_service configures filebeat service using runit.
LWRP example
filebeat_runit_service 'default' do
[options ..]
endLWRP Options
- action (optional) - default
:create, options: :create, :delete - filebeat_install_resource_name (optional, String) - default
default, filebeat_install/filebeat_install_preview resource name, set this attribute if LWRP resource name is other thandefault - service_name (optional, String) - default
filebeat, filebeat service name, must be common across resources - disable_service (optional, Boolean) - default
false, set totrue, to disable filebeat service - purge_prospectors_dir (optional, Boolean) - default
false, set totrue, to purge prospectors - runit_filebeat_cmd_options (optional, Boolean) - default
'', set totrue, runit filebeat service command line options - service_ignore_failure (optional, Boolean) - default
false, set totrue, to ignore filebeat service failures
Check out filebeat test cookbook filebeat_test.
- Add other platforms support to install_preview resource
- Fork the repository on Github
- Create a named feature branch (like
add_component_x) - Write your change
- Write tests for your change (if applicable)
- Run the tests (
rake & rake knife), ensuring they all pass - Write new resource/attribute description to
README.md - Write description about changes to PR
- 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
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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent