Yavook.de/kiwi-simple-metrics
1
0
Fork 0
mirror of https://github.com/yavook/kiwi-simple-metrics.git synced 2024-11-21 15:23:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
(mirror) A lightweight monitoring solution for kiwi-scp
56 commits 2 branches 6 tags 124 KiB
Python 96.5%
Dockerfile 2.7%
Shell 0.8%
Find a file
Jörn-Michael Miehe efb178ab6b Merge branch 'release/0.1.0'
2023-09-02 16:34:04 +00:00
.devcontainer Initial commit 2023-08-30 20:55:48 +00:00
.vscode env_prefix 2023-09-02 15:26:33 +00:00
example preparation for release 0.1.0 2023-09-02 15:02:17 +00:00
kiwi_simple_metrics "result" param for webhooks 2023-09-02 16:30:54 +00:00
.drone.yml drone config 2023-09-02 16:33:46 +00:00
.gitignore Initial commit 2023-08-30 20:55:48 +00:00
Dockerfile preparation for release 0.1.0 2023-09-02 15:02:17 +00:00
LICENSE Initial commit 2023-08-30 20:55:48 +00:00
poetry.lock webhook handling 2023-08-31 23:49:02 +00:00
pyproject.toml package description 2023-09-02 16:28:10 +00:00
README.md "result" param for webhooks 2023-09-02 16:30:54 +00:00

README.md

kiwi-simple-metrics

Build Status

kiwi - simple, consistent, powerful

A lightweight monitoring solution for kiwi-scp, created with uptime-kuma in mind. Also on Docker Hub.

Quick start

The minimal config to add to one of your docker-compose.yml is this:

metrics:
  image: yavook/kiwi-simple-metrics:0.1
  • admittedly not useful, but it does run monitoring
  • every 600 seconds (10 minutes), metrics are evaluated
  • measures cpu, memory and swap, and disk usage at "/"
  • does not log to stdout
  • does not trigger any webhooks

Every aspect of kiwi-simple-metrics can be tweaked by environment variables, so this is a more reasonable configuration example:

metrics:
  image: yavook/kiwi-simple-metrics:0.1
  environment:
    METRICS__LOG__ENABLED: "True"
    METRICS__WEBHOOK__URL: "https://my.webhook.host/success?report={result}"
    METRICS__WEBHOOK__FAIL: "https://my.webhook.host/failure?report={result}"
  • same metrics as above
  • logs reports to stdout
  • triggers webhooks ({result} is the placeholder for the result string)

Configuration

These are the environment variables you most likely need:

  • METRICS__INTERVAL: Time in seconds between metrics evaluation (default: 600, i.e. 10 minutes)
  • METRICS__LOG__ENABLED: If truthy, logs reports to stdout (default: False)
  • METRICS__[M]__ENABLED, METRICS__[M]__THRESHOLD (with [M] from CPU, MEMORY, DISK): Enable or disable each metric, and set its failure threshold
  • METRICS__MEMORY__SWAP: How swap space is handled in the "memory" report (default: include)
  • METRICS__DISK__PATHS: At which paths the disk usage is measured (default: ["/"])
  • METRICS__EXTERNAL__ENABLED, METRICS__EXTERNAL__EXECUTABLES: Setup for external values, as further defined in metrics/external.py (default: False, [])
  • METRICS__WEBHOOK__URL, METRICS__WEBHOOK__FAIL: Which webhooks to push the reports to (default: None, None)

All settings can be found in the SETTINGS variable defined by module kiwi_simple_metrics.settings in settings/__init__.py. For default values, refer to the respective python files.

Example: The above METRICS__LOG__ENABLED refers to SETTINGS.log.enabled, defined by model LogSettings in settings/misc.py.