librenms-librenms/doc/Support/Cleanup-options.md
Sean 747506172a Update cleanup options document (#13026)
- Add missed units for config definition
  - And remove units from translate strings
- Change values in the document to the actual default value
- Sort configs in the document by order
- Replace redundant text with "please refer to"
- Add instruction to use Web GUI setting
2021-07-25 09:50:25 +02:00

2.0 KiB

source: Support/Cleanup-options.md path: blob/master/doc/

Cleanup Options

As the number of devices starts to grow in your LibreNMS install, so will things such as the RRD files, MySQL database containing eventlogs, Syslogs and performance data etc. Your LibreNMS install could become quite large so it becomes necessary to clean up those entries. With Cleanup Options, you can stay in control.

These options rely on daily.sh running from cron as per the installation instructions.

You can adjust the config in Global Setting -> System -> Cleanup.

Cleanup Options can also be set in config.php

$config['eventlog_purge']                            = 30;
$config['syslog_purge']                              = 30;
$config['route_purge']                               = 10;
$config['alert_log_purge']                           = 365;
$config['authlog_purge']                             = 30;
$config['ports_fdb_purge']                           = 10;
$config['device_perf_purge']                         = 7;
$config['rrd_purge']                                 = 0;
$config['ports_purge']                               = 10;

These options will ensure data within LibreNMS over X days old is automatically purged. You can alter these individually, values are in days.

NOTE: Please be aware that $config['rrd_purge'] is NOT set by default. This option will remove any RRD files that have not been updated for the set amount of days automatically - only enable this if you are comfortable with that happening. (All active RRD files are updated every polling period.)

Ports Purge

Over time as you add devices some interfaces will need to be purged as they are set to be ignored or bad interfaces or marked as deleted.

You can purge all deleted ports from the WebUI (see below) or by setting $config['ports_purge'] = true; in config.php

In the Web UI Under the Ports Tab in the Nav Bar, Click on "Deleted" then click on "Purge all deleted". This will purge all the ports.