https://github.com/nodiscc/netdata-modtime
[archived] Check/graph time since last modification of files - netdata plugin
https://github.com/nodiscc/netdata-modtime
Last synced: 9 months ago
JSON representation
[archived] Check/graph time since last modification of files - netdata plugin
- Host: GitHub
- URL: https://github.com/nodiscc/netdata-modtime
- Owner: nodiscc
- License: gpl-3.0
- Created: 2020-08-20T12:25:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-22T21:39:48.000Z (over 3 years ago)
- Last Synced: 2025-01-20T12:46:33.915Z (11 months ago)
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# netdata-modtime
----------------------
**ARCHIVED** - this repository is left public for reference purposes. Checking/alerting on file modification date can now be done with the native netdata [filecheck module](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/filecheck) [[1]](https://github.com/netdata/netdata/issues/9794).
This is an [example](https://gitlab.com/nodiscc/xsrv/-/blob/master/roles/backup/templates/etc_netdata_go.d_filecheck.conf.d_rsnapshot.conf.j2) netdata filecheck, and corresponding health [alarm](https://gitlab.com/nodiscc/xsrv/-/blob/master/roles/backup/templates/etc_netdata_health.d_filecheck.conf.d_rsnapshot.conf.j2) configuration:
```yaml
# /etc/netdata/go.d/filecheck.conf
files:
include:
- '/var/log/rsnapshot_last_success'
```
```yaml
# raise a critical alarm when the file does not exist
alarm: filecheck_rsnapshot_last_success_exists
on: filecheck_rsnapshot_last_success.file_existence
calc: $_var_log_rsnapshot_last_success
every: 5m
crit: $this = 0
info: /var/log/rsnapshot_last_success file present
# Raise a warning when the file is older than 24h30min, critical alarm when older than 25h
alarm: filecheck_rsnapshot_last_success_mtime
on: filecheck_rsnapshot_last_success.file_mtime_ago
calc: $_var_log_rsnapshot_last_success
every: 5m
units: seconds
warn: $this > 88200
crit: $this > 90000
info: /var/log/rsnapshot_last_success file last modification
```
----------------------
Check/graph time since last modification of files
This is a `python.d` plugin for [netdata](https://my-netdata.io/).
Maximum acceptable age of each watched file can be configured, alarms will be raised if the last modification time is older than this value.
## Installation
```bash
# clone the repository
git clone https://gitlab.com/nodiscc/netdata-modtime
# edit configuration values in these files (update interval, watched files, alarm thresholds...)
nano netdata-modtime/python.d_modtime.conf
nano netdata-modtime/health.d_modtime.conf
# copy files in place
netdata_install_prefix="/opt/netdata" # if netdata is installed from binary/.run script
netdata_install_prefix="" # if netdata is installed from OS packages
sudo cp netdata-modtime/modtime.chart.py $netdata_install_prefix/usr/libexec/netdata/python.d/
sudo cp netdata-modtime/python.d_modtime.conf $netdata_install_prefix/etc/netdata/python.d/modtime.conf
sudo cp netdata-modtime/health.d_modtime.conf $netdata_install_prefix/etc/netdata/health.d/modtime.conf
# restart netdata
systemctl restart netdata
```
You can also install this module using the [`nodiscc.xsrv.monitoring` ansible role](https://gitlab.com/nodiscc/xsrv/-/tree/master/roles/monitoring).
## Configuration
- Files for which time since last modification should bea measured, and chart refresh time/common `python.d` plugin options can be changed in [`$netdata_install_prefix/etc/netdata/python.d/modtime.conf`](python.d_modtime.conf)
- Alarm settings can be changed in [`$netdata_install_prefix/etc/netdata/health.d/modtime.conf`](health.d_modtime.conf)
## Usage
To monitor time since last successful execution of a cron job or other scheduled task, have it update the modification time of a file on successful execution, for example:
```bash
# my daily backup job
0 1 * * * root rsnapshot daily && touch /var/log/rsnapshot_last_success
```
[Configure](python.d_modtime.conf) the plugin to watch this file:
```yaml
last_rsnapshot_success:
path: '/var/log/rsnapshot_last_success'
```
[Configure](health.d_modtime.conf) an alarm/notification when the file age exceeds a threshold.
```yaml
# Raise a warning when the file is older than 24h30min
# Raise a critical alert when older than 25h
alarm: modtime_last_rsnapshot_success
on: modtime_last_rsnapshot_success.file_age
calc: $file_age
every: 10s
warn: $this > 88200
crit: $this > 90000
units: seconds
info: time since last modification
to: sysadmin
```
## Debug
To debug this plugin:
```bash
$ sudo su -s /bin/bash netdata
$ $netdata_install_prefix/usr/libexec/netdata/plugins.d/python.d.plugin 1 debug trace modtime
```
## License
[GNU GPLv3](LICENSE)
## Mirrors
- https://github.com/nodiscc/netdata-modtime
- https://gitlab.com/nodiscc/netdata-modtime