Download the PHP package anexia/zf2-monitoring without Composer
On this page you can find all versions of the php package anexia/zf2-monitoring. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download anexia/zf2-monitoring
More information about anexia/zf2-monitoring
Files in anexia/zf2-monitoring
Package zf2-monitoring
Short Description A zf2 module to monitor runtime (php, zf2) versions, composer package versions and composer package licences
License MIT
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 zf2-monitoring
Anexia Monitoring
A Zend Framework 2 plugin used to monitor updates for core and composer packages. It can be also used to check if the website is alive and working correctly.
Installation and configuration
Install the module via composer, therefore adapt the require part of your composer.json:
In the projects application.config.php add the new module:
In the projects local.php config file add the access token configuration:
In the projects local.php config file add the database connection configuration:
Usage
The module registers some custom REST endpoints which can be used for monitoring. Make sure that the ANX_MONITORING_ACCESS_TOKEN is defined, since this is used for authorization. The endpoints will return a 401 HTTP_STATUS code if the token is not defined or invalid, or will return a 200 HTTP_STATUS code if everything went well.
Version monitoring of core and composer packages
Returns all a list with platform and composer package information.
URL: /anxapi/v1/modules?access_token=custom_access_token
Response headers:
Response body:
Live monitoring
This endpoint can be used to verify if the application is alive and working correctly. It checks if the database connection is working. It allows to register custom checks by using hooks.
URL: /anxapi/v1/up?access_token=custom_access_token
Response headers:
Response body:
Custom up check failure (without custom error message):
Response headers (custom check failed without additional error message):
Response body (containing default error message):
Custom up check failure (with custom error message):
Response headers (custom check failed without additional error message):
Response body (containing custom error message):
Custom up check
The anexia/zf2-monitoring only checks the DB connection / DB availability.
To add further up checks a customized service can be defined. This service must implement the
Anexia\Monitoring\Service\UpCheckServiceInterface and must be available as Anexia\Monitoring\Service\UpCheck.
Therefore two steps are necessary:
1) Add a new service class (and its factory) to the project source code tree, e.g.:
2) Declare the new service class to be used (via its factory) as Anexia\Monitoring\Service\UpCheck in the service's
module.config.php, e.g.:
The customized service's check method is automatically added to the anexia/zf2-monitoring module's db check. If the
customized service's check method returns false and/or adds content to its $error array (given as method parameter by
reference), the anexia/zf2-monitoring module's up check will fail.
If the customized service's check method returns false without giving any additional information in the $error array
(array stays empty), the response will automatically add the default error message ERROR to the response.
List of developers
- Alexandra Bruckner [email protected], Lead developer
