Download the PHP package anexia/laravel-monitoring without Composer

On this page you can find all versions of the php package anexia/laravel-monitoring. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package laravel-monitoring

Anexia Monitoring

A Laravel package 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:

To automatically publish the composer packages config files to the app, add the scripts to your composer.json:

To manually add the config file of anexia/laravel-monitoring instead either run

or manually copy the /vendor/anexia/laravel-monitoring/config/monitoring.php to /app/config/monitoring.php after the composer update command.

In the projects config/app.php add the new service providers:

Now run

to add the packages source code to your /vendor directory and its config files to your /config directory.

In the projects .env config file add the access token configuration:

In the projects .env config file add the database connection configuration:

Usage

The package 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 live monitoring hooks:

The anexia/laravel-monitoring only checks the DB connection / DB availability. To add further up checks a customized helper class can be defined. This class must implement the Anexia\Monitoring\Interfaces\UpMonitoringInterface and must be available as App\Helper\AnexiaMonitoringUpCheckHelper.

Add a new helper class to the project source code tree as /app/Helper/AnexiaMonitoringUpCheckHelper.php, e.g.:

The customized helper's checkUpStatus method gets automatically called by the anexia/laravel-monitoring package's up check. If the helper's checkUpStatus method returns false and/or adds content to its $error array (given as method parameter by reference), the anexia/laravel-monitoring package's up check will fail. If the customized helper's checkUpStatus method returns false without giving any additional information in the $error array (array stays empty), the default error message ERROR will be added to the response.

Deactivate default DB connection test:

If you don't want the default DB connection test to happen (because you're on a system where no DB is needed) you can do that in the /app/config/monitoring.php by setting the key deactivate_db_check to true.

List of developers

Project related external resources


All versions of laravel-monitoring with dependencies

PHP Build Version
Package Version
Requires anexia/composer-tools Version >=1.4
laravel/framework Version >=6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package anexia/laravel-monitoring contains the following files

Loading the files please wait ....