The daemon configuration file is read from `/etc/netdata/netdata.conf`.Depending on your installation method, Netdata will have been installed either directly under `/`, or under `/opt/netdata`. The paths mentioned here and in the documentation in general assume that your installation is under `/`. If it is not, you will find the exact same paths under `/opt/netdata` as well. (i.e. `/etc/netdata` will be `/opt/netdata/etc/netdata`).
This config file is not needed by default. Netdata works fine out of the box without it. But it does allow you to adapt the general behavior of Netdata, in great detail. You can find all these settings, with their default values, by accessing the URL
https://netdata.server.hostname:19999/netdata.conf. For example check the configuration file of netdata.firehol.org. HTTP access to this file is limited by default to private IPs, via the web server access lists.
netdata.conf has sections stated with
[section]. You will see the following sections:
[global]to configure the Netdata daemon.
[web]to configure the web server.
[plugins]to configure which collectors to use and PATH settings.
[health]to configure general settings for health monitoring
[registry]for the Netdata registry.
[backend]to set up streaming and replication options.
[statsd]for the general settings of the stats.d.plugin.
[plugin:NAME]sections for each collector plugin, under the comment Per plugin configuration.
[CHART_NAME]sections for each chart defined, under the comment Per chart configuration.
The configuration file is a
name = value dictionary. Netdata will not complain if you set options unknown to it. When you check the running configuration by accessing the URL
/netdata.conf on your Netdata server, Netdata will add a comment on settings it does not currently use.
netdata.conf has been modified, Netdata needs to be restarted for changes to apply:
If the above does not work, try the following:
Please note that your data history will be lost if you have modified
history parameter in section
[global] section options
|process scheduling policy||See Netdata process scheduling policy|
|OOM score||See OOM score|
|glibc malloc arena max for plugins||See Virtual memory.|
|glibc malloc arena max for Netdata||See Virtual memory.|
|hostname||auto-detected||The hostname of the computer running Netdata.|
|history||Used with |
|update every||The frequency in seconds, for data collection. For more information see Performance.|
|config directory||The directory configuration files are kept.|
|stock config directory|
|log directory||The directory in which the log files are kept.|
|web files directory||The directory the web static files are kept.|
|cache directory||The directory the memory database will be stored if and when Netdata exits. Netdata will re-read the database when it will start again, to continue from the same point.|
|lib directory||Contains the alarm log and the Netdata instance guid.|
|home directory||Contains the db files for the collected metrics|
|plugins directory||The directory plugin programs are kept. This setting supports multiple directories, space separated. If any directory path contains spaces, enclose it in single or double quotes.|
|page cache size||32||Determines the amount of RAM in MiB that is dedicated to caching Netdata metric values.|
|dbengine disk space||256||Determines the amount of disk space in MiB that is dedicated to storing Netdata metric values and all related metadata describing them|
|host access prefix||This is used in docker environments where /proc, /sys, etc have to be accessed via another path. You may also have to set SYS_PTRACE capability on the docker for this work. Check issue 43.|
|memory deduplication (ksm)||When set to |
|TZ environment variable||Where to find the timezone|
|timezone||auto-detected||The timezone retrieved from the environment variable|
|debug flags||Bitmap of debug options to enable. For more information check Tracing Options.|
|debug log||The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to |
|error log||The filename to save error messages for Netdata daemon and all plugins (|
|access log||The filename to save the log of web clients accessing Netdata charts. You can also set it to |
|errors flood protection period||Length of period (in sec) during which the number of errors should not exceed the |
|errors to trigger flood protection||Number of errors written to the log in |
|run as user||The user Netdata will run as.|
|pthread stack size||auto-detected|
|cleanup obsolete charts after seconds||See monitoring ephemeral containers, also sets the timeout for cleaning up obsolete dimensions|
|gap when lost iterations above|
|cleanup orphan hosts after seconds||How long to wait until automatically removing from the DB a remote Netdata host (slave) that is no longer sending data.|
|delete obsolete charts files||See monitoring ephemeral containers, also affects the deletion of files for obsolete dimensions|
|delete orphan hosts files||Set to |
|enable zero metrics||Set to |
[web] section options
Refer to the web server documentation
[plugins] section options
In this section you will see be a boolean (
no) option for each plugin (e.g. tc, cgroups, apps, proc etc.). Note that the configuration options in this section for the orchestrator plugins
node.d control all the modules written for that orchestrator. For instance, setting
python.d = no means that all Python modules under
collectors/python.d.plugin will be disabled.
Additionally, there will be the following options:
|PATH environment variable|
|PYTHONPATH environment variable||Used to set a custom python path|
|enable running new plugins||When set to |
|check for new plugins every||60||The time in seconds to check for new plugins in the plugins directory. This allows having other applications dynamically creating plugins for Netdata.|
|checks||This is a debugging plugin for the internal latency|
[health] section options
This section controls the general behavior of the health monitoring capabilities of Netdata.
Specific alarms are configured in per-collector config files under the
health.d directory. For more info, see health
Alarm notifications are configured in
|enabled||Set to |
|in memory max health log entries||1000||Size of the alarm history held in RAM|
|script to execute on alarm||The script that sends alarm notifications. Note that in versions before 1.16, the plugins.d directory may be installed in a different location in certain OSs (e.g. under |
|stock health configuration directory||Contains the stock alarm configuration files for each collector|
|health configuration directory||The directory containing the user alarm configuration files, to override the stock configurations|
|run at least every seconds||Controls how often all alarm conditions should be evaluated.|
|postpone alarms during hibernation for seconds||Prevents false alarms. May need to be increased if you get alarms during hibernation.|
|rotate log every lines||2000||Controls the number of alarm log entries stored in |
[registry] section options
To understand what this section is and how it should be configured, please refer to the registry documentation.
Refer to the streaming and replication documentation.
The configuration options for plugins appear in sections following the pattern
Most internal plugins will provide additional options. Check Internal Plugins for more information.
Please note, that by default Netdata will enable monitoring metrics for disks, memory, and network only when they are not zero. If they are constantly zero they are ignored. Metrics that will start having values, after Netdata is started, will be detected and charts will be automatically added to the dashboard (a refresh of the dashboard is needed for them to appear though). Use
yes instead of
auto in plugin configuration sections to enable these charts permanently. You can also set the
enable zero metrics option to
yes in the
[global] section which enables charts with zero metrics for all internal Netdata plugins.
External plugins will have only 2 options at
|update every||the value of ||The frequency in seconds the plugin should collect values. For more information check Performance.|
|command options||empty||Additional command line options to pass to the plugin.|
External plugins that need additional configuration may support a dedicated file in
/etc/netdata. Check their documentation.
In this area of
netdata.conf you can find configuration options for individual charts. They appear in sections
following the pattern
Using the settings and values under these sections, you can control all aspects of a specific chart. You can change its title, make it appear higher in Netdata's menu, tweak its dimensions, and much more.
To find the name of a given chart, and thus the name of its section in
netdata.conf, look at the top-left corner of a
Every per-chart configuration section has several common settings, which are listed in the table just below. Beneath
that is information about lines that begin with
dim, which affect a chart's dimensions.
|Override the |
|A boolean (|
|The directory where cache files for this plugin, if needed, are stored.|
|Defines what type of chart to display. It can be |
|Uniquely identify which metrics menu on the Netdata dashboard this chart should appear under. Some examples include |
|Change the chart's family from its default. For example, you could force a disk space chart to collect metrics for family |
|Text for the label of the vertical axis of the chart. This means all dimensions should have the same unit of measurement.|
|Change the default context of the chart. Changing this setting will affect what metrics and metrics the chart displays, and which alarms are attached to it.|
|Define where the chart should appear on the Netdata dashboard. Lower values equal higher priority, so a priority of |
|The name of the chart that appears in the top-left corner, after the chart's title. You can also use this name when writing health entities.|
|The text that appears above the chart in the Netdata dashboard.|
You may notice some settings that begin with
dim beneath the ones defined in the table above. These settings determine
which dimensions appear on the given chart and how Netdata calculates them.
Each dimension setting has the following structure:
dim [DIMENSION ID] [OPTION] = [VALUE]. The available options are
|The name of the dimension as it will appear in the legend of the chart. If left empty, or is missing, Netdata will use the |
|Can be |
|An integer value by which to multiply the collected value. If empty or missing, Netdata will use |
|An integer value by which to divide the collected value. If empty or missing, Netdata will use |
Here are the options for the
absolute: The value is drawn as-is (interpolated to second boundary).
incremental: To be used when the value always increases over time, such as the I/O on a disk. Netdata takes the difference between the current metric and the past metric to calculate a per-second figure.
percentage-of-absolute-row: The % of this value compared to the total of all dimensions.
percentage-of-incremental-row: The % of this value compared to the incremental total of all dimensions.
For example, the
system.io chart has the following default settings:
dim settings produce two dimensions,
out, both of which use the
incremental algorithm. By
multiplying the value of
out by -1, Netdata creates the negative values seen in the following area chart: