PHPackages                             anexia/laravel-monitoring - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. anexia/laravel-monitoring

ActiveLibrary[Logging & Monitoring](/categories/logging)

anexia/laravel-monitoring
=========================

A laravel module to monitor runtime (php, laravel) versions, composer package versions and composer package licenses

1.8.1(2y ago)33.4k↓84.6%[3 PRs](https://github.com/anexia-it/anexia-monitoring-laravel/pulls)MITPHP

Since Jul 12Pushed 2y ago1 watchersCompare

[ Source](https://github.com/anexia-it/anexia-monitoring-laravel)[ Packagist](https://packagist.org/packages/anexia/laravel-monitoring)[ RSS](/packages/anexia-laravel-monitoring/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (10)Dependencies (2)Versions (18)Used By (0)

Anexia 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
------------------------------

[](#installation-and-configuration)

Install the module via composer, therefore adapt the `require` part of your `composer.json`:

```
"require": {
    "anexia/laravel-monitoring": "^1.8"
}

```

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

```
"scripts": {
    "post-install-cmd": [
        "php artisan vendor:publish --provider=\"Anexia\\Monitoring\\Providers\\MonitoringServiceProvider\""
    ],
    "post-update-cmd": [
        "php artisan vendor:publish --provider=\"Anexia\\Monitoring\\Providers\\MonitoringServiceProvider\""
    ]
}

```

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

```
php artisan vendor:publish --provider="Anexia\Monitoring\Providers\MonitoringServiceProvider"

```

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:

```
return [
    'providers' => [
        /*
         * Anexia Monitoring Service Providers...
         */
        Anexia\Monitoring\Providers\MonitoringServiceProvider::class,
    ]
];

```

Now run

```
composer update [-o]

```

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:

```
ANX_MONITORING_ACCESS_TOKEN=custom_monitoring_token

```

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

```
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret

```

Usage
-----

[](#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

[](#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:

```
Status Code: 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Allow: GET
Content-Type: application/json

```

Response body:

```
{
   "runtime":{
      "platform":"php",
      "platform_version":"7.0.19",
      "framework":"laravel",
      "framework_installed_version":"5.4.28",
      "framework_newest_version":"5.4.28"
   },
   "modules":[
      {
         "name":"package-1",
         "installed_version":"3.1.10",
         "installed_version_licences":[
            "BSD-2-Clause"
         ],
         "newest_version":"3.3.2",
         "newest_version_licences":[
            "BSD-3-Clause"
         ]
      },
      {
         "name":"package-2",
         "installed_version":"1.4",
         "installed_version_licences":[
            "MIT"
         ],
         "newest_version":"1.4",
         "newest_version_licences":[
            "MIT"
         ]
      },
      ...
   ]
}

```

#### Live monitoring

[](#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:

```
Status Code: 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Allow: GET
Content-Type: text/plain

```

Response body:

```
OK

```

**Custom up check failure (without custom error message):**

Response headers (custom check failed without additional error message):

```
Status Code: 500 Internal Server Error
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Allow: GET
Content-Type: text/plain

```

Response body (containing default error message):

```
ERROR

```

**Custom up check failure (with custom error message):**

Response headers (custom check failed without additional error message):

```
Status Code: 500 Internal Server Error
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Allow: GET
Content-Type: text/plain

```

Response body (containing custom error message):

```
This is an example for a custom db check 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.:

```