Download the PHP package anexia/neos-monitoring without Composer
On this page you can find all versions of the php package anexia/neos-monitoring. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download anexia/neos-monitoring
More information about anexia/neos-monitoring
Files in anexia/neos-monitoring
Package neos-monitoring
Short Description A neos plugin to monitor runtime versions, composer package versions and composer package licenses
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 neos-monitoring
Anexia Monitoring
A Neos plugin used to monitor updates for active 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 your site package /app/Packages/Sites/[SITE_NAME]/Configuration/Settings.yaml add the following:
Now run
To enable the plugin, run
Usage
The package registers some custom REST endpoints which can be used for monitoring. Make sure that the Anexia.Neos.Monitoring.accessToken is defined, since this is used for authorization. The endpoints will return a 503 HTTP_STATUS code if the token is not configured, 403 HTTP_STATUS code if its missing or a 401 HTTP_STATUS code if its invalid. If everything is ok, a 200 HTTP_STATUS code will be returned.
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 simply adding classes to the config.
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 live monitoring hooks:
The anexia/neos-monitoring only checks the DB connection.
To add further up checks a customized class can be defined. This class must implement the
Anexia\Neos\Monitoring\Check\CheckInterface.
Add a new class to the project source code tree as /app/Packages/Sites/[SITE_NAME]/Classes/Check/CustomCheck.php, e.g.:
The run method gets automatically called by the anexia/neos-monitoring plugin up check. If the run method
returns false or throws an exception, the anexia/neos-monitoring up check will fail.
If the run method returns false a generic error will be displayed. To customize error messages, simply throw an
exception with your own message.
List of developers
- Nikita Bernthaker [email protected], Lead developer
