The daemon configuration file is read from /etc/netdata/netdata.conf.
Depending on your installation method, Netdata will have been installed either directly under
/opt/netdata. The paths mentioned here and in the documentation in general assume that your installation is
/. If it is not, you will find the exact same paths under
/opt/netdata as well. (i.e.
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.
[db]to configure the database of Netdata.
[directories]to configure the directories used by Netdata.
[logs]to configure the Netdata logging.
[environment variables]to configure the environment variables used Netdata.
[sqlite]to configure the Netdata daemon SQLite settings.
[ml]to configure settings for machine learning.
[health]to configure general settings for health monitoring.
[web]to configure the web server.
[registry]for the Netdata registry.
[global statistics]for the Netdata registry.
[statsd]for the general settings of the stats.d.plugin.
[plugins]to configure which collectors to use and PATH settings.
[plugin:NAME]sections for each collector plugin, under the comment Per plugin 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:
sudo systemctl restart netdata
If the above does not work, try the following:
sudo killall netdata; sleep 10; sudo netdata
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|
|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.|
|host access prefix||empty||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.|
|timezone||auto-detected||The timezone retrieved from the environment variable|
|run as user||The user Netdata will run as.|
|pthread stack size||auto-detected|
[db] section options
|retention||Used with |
|storage tiers||The number of storage tiers you want to have in your dbengine. Check the tiering mechanism in the dbengine's reference. You can have up to 5 tiers of data (including the Tier 0). This number ranges between 1 and 5.|
|dbengine page cache size MB||Determines the amount of RAM in MiB that is dedicated to caching for Tier 0 Netdata metric values.|
|dbengine tier ||Determines the amount of RAM in MiB that is dedicated for caching Netdata metric values of the |
|dbengine disk space MB||Determines the amount of disk space in MiB that is dedicated to storing Tier 0 Netdata metric values and all related metadata describing them. This option is available only for legacy configuration (|
|dbengine multihost disk space MB||Same functionality as |
|dbengine tier ||Same functionality as |
|update every||The frequency in seconds, for data collection. For more information see the performance guide. These metrics stored as Tier 0 data. Explore the tiering mechanism in the dbengine's reference.|
|dbengine tier ||The down sampling value of each tier from the previous one. For each Tier, the greater by one Tier has N (equal to 60 by default) less data points of any metric it collects. This setting can take values from |
|dbengine tier ||Specifies the strategy of recreating missing data on each Tier from the exact lower Tier. |
|memory deduplication (ksm)||When set to |
|cleanup obsolete charts after secs||See monitoring ephemeral containers, also sets the timeout for cleaning up obsolete dimensions|
|gap when lost iterations above|
|cleanup orphan hosts after secs||How long to wait until automatically removing from the DB a remote Netdata host (child) 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 |
The multiplication of all the enabled tiers
dbengine tier N update every iterations values must be less than
[directories] section options
|config||The directory configuration files are kept.|
|log||The directory in which the log files are kept.|
|web||The directory the web static files are kept.|
|cache||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||Contains the alarm log and the Netdata instance GUID.|
|home||Contains the db files for the collected metrics.|
|lock||Contains the data collectors lock files.|
|plugins||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.|
|health config||The directory containing the user alarm configuration files, to override the stock configurations|
|stock health config||Contains the stock alarm configuration files for each collector|
|registry||Contains the registry database and GUID that uniquely identifies each Netdata Agent|
[logs] section options
|debug flags||Bitmap of debug options to enable. For more information check Tracing Options.|
|debug||The filename to save debug information. This file will not be created if debugging is not enabled. You can also set it to |
|error||The filename to save error messages for Netdata daemon and all plugins (|
|access||The filename to save the log of web clients accessing Netdata charts. You can also set it to |
|facility||A facility keyword is used to specify the type of system that is logging the message.|
|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 |
[environment variables] section options
|TZ||Where to find the timezone|
|PATH||Specifies the directories to be searched to find a command|
|PYTHONPATH||Used to set a custom python path|
[sqlite] section options
|auto vacuum||The auto-vacuum status in the database|
|synchronous||The setting of the "synchronous" flag|
|journal mode||The journal mode for databases|
|temp store||Used to determine where temporary tables and indices are stored|
|journal size limit||Used to set a new limit in bytes for the database|
|cache size||Used to suggest the maximum number of database disk pages that SQLite will hold in memory at once per open database file|
[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 |
|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 |
|enabled alarms||*||Defines which alarms to load from both user and stock directories. This is a simple pattern list of alarm or template names. Can be used to disable specific alarms. For example, |
[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
charts.d control all the
modules written for that orchestrator. For instance, setting
python.d = no means that all Python modules
collectors/python.d.plugin will be disabled.
Additionally, there will be the following options:
|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|
[registry] section options
To understand what this section is and how it should be configured, please refer to the registry 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 the performance guide.|
|command options||-||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
Was this page helpful?
Need more help?
- Join our community
- Submit a bug or feature request for the FOSS agent
- Submit a bug or feature request for the Netdata cloud