badpixxel / paddock-nrpe
Paddock - NRPE Extension
Package info
gitlab.com/paddock-project/paddock-nrpe
Type:bundle
pkg:composer/badpixxel/paddock-nrpe
Requires
- php: ^7.4|^8.0
- badpixxel/paddock-core: ^4.0
Requires (Dev)
- badpixxel/php-sdk: ^2.0
README
Paddock extension for Nagios / NRPE integration: expose all your Paddock tracks as NRPE commands, so your Nagios-like monitoring can trigger them remotely.
It also ships a few ready-to-use NRPE plugins for Proxmox servers
(src/Resources/plugins/).
Requirements
- PHP 8.1+
badpixxel/paddock-core^5.0 (Symfony 5.4 → 8.x)
| Version | PHP | Paddock Core | Status |
|---|---|---|---|
| 5.x | ^8.1 | ^5.0 | Active |
| 4.x | ^7.4 | 4.x | Maintenance |
Installation
composer require badpixxel/paddock-nrpe
Usage
Deploy the NRPE commands configuration (writes
/etc/nagios/nrpe.d/paddock.cfg, one NRPE command per Paddock track):
php bin/paddock paddock:nrpe:deploy
Your NRPE server can then trigger any track:
check_paddock!my-track-code # Run a single track
check_paddock_full # Run all tracks
Each command executes paddock:run <track> -f=nrpe, returning standard
NRPE status codes (OK / WARNING / CRITICAL) to Nagios.
A nrpe-health-checker track is registered automatically: it verifies that
the deployed NRPE configuration exists and is up-to-date, so Paddock also
monitors its own NRPE integration.
Development & Tests
All checks run identically in CI and locally: the GitLab pipeline executes the exact same commands as the docker containers (one per Symfony version, 5.4 → 8.x):
# Start all containers & run everything (composer, quality, tests)
make verify
# Run PhpUnit tests in all containers
make test
# Quality suites (GrumPHP: lint, code style, PhpStan)
php vendor/bin/grumphp run --testsuite=travis
php vendor/bin/grumphp run --testsuite=csfixer
php vendor/bin/grumphp run --testsuite=phpstan
# PhpUnit testsuites
vendor/bin/phpunit --testsuite=integration
License
Paddock is released under the MIT License.