README
¶
Declarative HTTP, TCP, DNS, and ping checks with multi-environment support. Check metrics and pass/fail state available via Prometheus for visualization and alerting.
See demo/README.md for a demo.
Features
- Declarative YAML Configuration: Define checks with endpoints, assertions, and intervals in YAML.
- Multiple Check Types: HTTP, TCP, DNS, and ping checks supported.
- Multi-Environment Support: Run the same checks across prod, stage, dev, external, etc.
- Powerful Assertions: Uses CEL for asserting responses.
- Monitoring Integration: Check results are logged to stdout in JSON format and exposed as Prometheus metrics.
Configuration
See CONFIGURATION for detailed configuration instructions.
Commands
evaluator- Run checks at their configured interval (default)evaluate-once <check-name>- Run a specific check oncevalidate- Validate configuration file
Contributing
See CONTRIBUTING for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
config
Package config provides configuration loading and parsing, with basic config validation.
|
Package config provides configuration loading and parsing, with basic config validation. |
|
evaluator
Package evaluator will execute checks and evaluate their assertions.
|
Package evaluator will execute checks and evaluate their assertions. |
|
metrics
Package metrics provides service metrics functionality for checks.
|
Package metrics provides service metrics functionality for checks. |
Click to show internal directories.
Click to hide internal directories.