Download the PHP package govigilant/vigilant-healthchecks-base without Composer
On this page you can find all versions of the php package govigilant/vigilant-healthchecks-base. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download govigilant/vigilant-healthchecks-base
More information about govigilant/vigilant-healthchecks-base
Files in govigilant/vigilant-healthchecks-base
Package vigilant-healthchecks-base
Short Description Base package for integrating healthchecks
License MIT
Informations about the package vigilant-healthchecks-base
Vigilant Healthchecks Base
This package provides common functionality for implementing healthchecks for Vigilant in various PHP based platforms and frameworks.
Overview
Vigilant supports two types of healthchecks:
- Check: A check that returns unhealthy, warning, or healthy status
- Metric: A check that returns a numeric value
This package provides base classes for both types of healthchecks that can be extended to implement custom healthchecks. It also provides a way to build responses for Vigilant to consume.
Features
Base Classes
Check
Extend the Check class to create status-based healthchecks:
MetricCheck
Extend the MetricCheck class to create metric-based healthchecks. The key can be used to differentiate multiple instances of the same metric type.
Data Classes
ResultData
Used for check results with validation:
MetricData
Used for metric results with validation:
Configuration Methods
Checks can be configured using static methods:
BuildResponse
The BuildResponse class builds the final response for Vigilant:
Availability Checking
The available() method determines if a check should run:
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Vincent Boon
- All Contributors
License
The MIT License (MIT). Please see License File for more information.