Download the PHP package govigilant/statamic-healthchecks without Composer
On this page you can find all versions of the php package govigilant/statamic-healthchecks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download govigilant/statamic-healthchecks
More information about govigilant/statamic-healthchecks
Files in govigilant/statamic-healthchecks
Package statamic-healthchecks
Short Description A Statamic addon to integrate healthchecks to your application which are compatible with Vigilant
License MIT
Homepage https://govigilant.io
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package statamic-healthchecks
Vigilant Statamic Healthchecks
An addon that adds healthchecks to any Statamic application and integrates seamlessly with Vigilant. It extends the Vigilant Laravel Healthchecks package and adds Statamic specific checks.
Features
This package providers an API endpoint to check the health of your Statamic application. It returns two types of checks, health checks and metrics. Healthchecks are checks that indicate whether a specific part of your application is functioning correctly, while metrics provide numeric values that give insights on health over time. Vigilant can use these metrics to notify you of spikes or quickly increasing metrics.
Installation
Install the package via Composer:
Configuration
Set the API token in your .env file:
Note: The token is required to access the health endpoint.
Optionally publish the configuration if ou want to adjust default behavior:
This creates config/vigilant-healthchecks.php.
Scheduler
This package automatically schedules a command and a job to verify if your sheduler and queue workers are running.
If you do not want or want to customize this behavior, you can disable the automatic scheduling in the config file by setting schedule to false.
Ensure to schedule the php artisan vigilant:scheduler-heartbeat yourself if you disable automatic scheduling.
Usage and customization
Please refer to the Vigilant Laravel Healthchecks Readme for usage and customization instructions.
Available checks
All Laravel checks in Vigilant Laravel Healthchecks are available, plus the following Statamic specific checks:
| Check | Description |
|---|---|
| StacheCheck | Verifies that the stache is built |
Development Environment
A ready-to-use Docker-based development environment lives in devenv/.
Ensure Docker is running, then start the stack: docker compose -f devenv/docker-compose.yml up --build.
This will create a Statamic application and link this package for development. The bearer token is set to testing and can be used to access the health endpoint:
You may use the following credentials to log in to the Statamic control panel at http://localhost:8000/cp:
- Email:
[email protected] - Password:
admin
Quality
Run the quality checks:
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.
