jmadureira/netdata-cookbook

Chef cookbook to install FireHol's NetData

NetData Cookbook

This cookbook provides a way to download, install and configure NetData from FireHol, a real-time performance monitoring.

Live demo: http://netdata.firehol.org

Github: https://github.com/firehol/netdata

Requirements

Platforms

• Amazon Linux 2013.09+
• Centos 6.9+
• Debian 7.11+
• Fedora 25+
• Ubuntu 14.04+

Chef

• Chef 12.6+

Cookbooks

• yum-epel
• apt

Usage

This cookbook implements resources to install NetData and manage its configuration files.

Recipies

default

Installs NetData using the netdata_install resource with default parameters.

install_netdata

Deprecated, please use default recipe or netdata_install resource.

Resources

netdata_install

Installs NetData from source or binary on supported platforms (default: source).

netdata_install 'default' do
  install_method 'source'
  git_repository 'https://github.com/firehol/netdata.git'
  git_revision 'master'
  git_source_directory '/tmp/netdata'
  autoupdate true
  update true
end

• install_method - Installation method.
• git_repository - Location of git repository to pull the NetData source.
• git_revision - Tag/Branch/Commit to checkout.
• git_source_directory - Location to sync the repository to on the server.
• install_path - Change the location where NetData is installed.
• autoupdate - Allow NetData to autoupdate itself via a cron entry.
• update - Allow chef-client to update NetData if it is already installed (note: use 'true' to update NetData on every chef-client run, 'false' is the default value).

It's highly recommended to use a different path than /tmp/netdata for git_source_directory and in future versions the default path will change. This is encouraged because when autoupdate is set to true NetData will create a symbolic link from the source directory to cron.d and you don't want NetData to create a symbolic link to anything in /tmp

netdata_install 'optional' do
  install_method 'binary'
  binary_repository 'https://raw.githubusercontent.com/firehol/binary-packages/master'
  binary_package 'netdata-latest.gz.run'
  binary_install_options([
    '--accept'
  ])
  binary_post_install_options([
    '--dont-start-it'
  ])
end

• install_method - Installation method.
• binary_repository - Location of the repository for binary packages.
• binary_package - The binary package to be installed (note: 'netdata-latest.gz.run' is the default value that updates NetData on every chef-client run).
• binary_install_options - Array of options to pass to the binary package installation script ('--accept' is required for automated installation).
• binary_post_install_options - Array of options to pass to the binary package post installation script.

This resource will create a file /opt/netdata/version.txt with the filename of the binary package installed.

netdata_config

Manages the main netdata.conf file. Call this as many times as needed. Each name should be unique. (i.e. web, global)

netdata_config 'web' do
  owner 'netdata'
  group 'netdata'
  base_directory '/etc'
  configurations(
    'bind to' => 'localhost'
  )
end

Resulting file content (/etc/netdata/netdata.conf):

[web]
  bind to = localhost

• owner - User to own the file
• group - Group to own the file
• base_directory - Parent folder that holds the NetData configuration files.
• configurations - Hash of key, value pairs for customizing NetData.

This resource will restart the NetData service automatically.

netdata_stream

Manages stream.conf file. Call this as many times as needed.
Resource names could be either 'stream' or "#{api_key}" and "#{machine_guid}" depending on whether you configure slave or master NetData. Name 'stream' should be used only once to configure slave NetData. Values for api_key and machine_guid should be unique.

netdata_stream 'stream' do
  owner 'netdata'
  group 'netdata'
  base_directory "#{install_path}/netdata"
  configurations(
    'enabled' => 'yes',
    'destination' => 'netdata_master:19999',
    'api key' => '11111111-2222-3333-4444-555555555555'
  )
end

Resulting file content ("#{install_path}/netdata/etc/netdata/stream.conf"):

[stream]
  enabled = yes
  destination = netdata_master:19999
  api key = 11111111-2222-3333-4444-555555555555

• owner - User to own the file
• group - Group to own the file
• base_directory - Parent folder where the NetData has been installed to (should be "#{install_path}/netdata" if install_path was used in netdata_install resource, otherwise should not be used).
• configurations - Hash of key, value pairs for customizing NetData stream configuration.

This resource will restart the NetData service automatically.

netdata_python_plugin

Manages python plugin configuration files.

netdata_python_plugin 'mysql' do
  owner 'netdata'
  group 'netdata'
  base_directory '/etc'
  global_configuration(
    'retries' => 5
  )
  jobs(
    'tcp' => {
      'name' => 'local',
      'host' => 'localhost',
      'port' => 3306   
    }
  )
end

Resulting file content (/etc/netdata/python.d/mysql.conf):

# GLOBAL
retries: 5

# JOBS
tcp:
  name: local
  host: localhost
  port: 3306

• owner - User to own the file
• group - Group to own the file
• base_directory - Parent folder that holds the NetData configuration files.
• global_configuration - Hash of global variables for the plugin.
• jobs - Hash of jobs that tell NetData to pull statistics from.

This resource will restart the NetData service automatically.

netdata_statsd_plugin

Manages statsd plugin configuration files.

netdata_statsd_plugin 'your_app' do
  owner 'netdata'
  group 'netdata'
  base_directory ''
  app_configuration(
    'name' => 'your_app',
    'metrics' => 'metrics to match'
  )
  charts(
    'heap' => {
      'name' => 'heap',
      'title' => 'Heap Memory',
      'dimension' => 'app.memory.heap.used used last 1 1000000'  
    }
  )
end

Resulting file content (/etc/netdata/statsd.d/your_app.conf):

# APP
[app]
  name = your_app
  metrics = metrics to match

# CHARTS
[heap]
  name = heap
  title = Heap Memory
  dimension = app.memory.heap.used used last 1 1000000

• owner - User to own the file
• group - Group to own the file
• base_directory - Parent folder that holds the NetData configuration files.
• app_configuration - Hash with the application configuration.
• charts - Hash of each specific chart configuration.

netdata_bind_rndc_conf

Deprecated, please use netdata_python_plugin

netdata_nginx_conf

Deprecated, please use netdata_python_plugin

Contributing

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, ensuring they all pass
6. Submit a Pull Request using Github

License and Authors

Authors:

• Sergio Pena https://github.com/sergiopena
• João Madureira https://github.com/jmadureira
• Nick Willever https://github.com/nictrix