Skip to content

JayJayArr/maedic

Repository files navigation

Maedic

Tests

Service to monitor a PW-installation for its health. Latest tested version : 6.5.2

Currently featuring the following PW specific checks:

  • Spool Files
  • Hi_Queue Size
  • PW main Service monitoring
  • Sysinfo checks incl. CPU/RAM

The following endpoints are available:

  • /v1/health for the health of PW
  • /v1/self for checking the health of maedic itself, also checks the database connection
  • /v1/config to check the configured limits and options

There are multiple options to install:

Docker

Warning

When using Docker the local Service can not be checked, disable the check via check_local_service: true in the base.yaml file.

Prerequisites

  • A Docker installation, if you need help installing please see here
  • The Rust toolchain installed, if you need help installing please see here
# Clone the repository
git clone https://github.com/JayJayArr/maedic
cd maedic
# Run the container
docker compose up -d

Windows

For Windows an installation using pm2 is recommended.

For a complete Installation with pm2 the following Files are required (please check the releases page):

  • the compiled binary
  • base.yaml as a config file
  • ecosystem.config.js

Assuming a node js environment installed follow these steps to setup pm2:

# configure node prefix and cache
npm run configure

# configure execution policy
npm run configure-policy

# Setup pm2
npm run setup

After setting up pm2 follow these steps to install maedic as a service:

# Assuming all files are located in C:\maedic
pm2 start ecosystem.config.js

# Save the pm2 config for automatic restarts
pm2 save

About

Small monitoring API for PW

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages