PHP class \appmonitorapi

Table of Contents

📦 Class \appmonitorapi


 ____________________________________________________________________________

  _____ _____ __                   _____         _ _
 |     |     |  |      ___ ___ ___|     |___ ___|_| |_ ___ ___
 |-   -| | | |  |__   | .'| . | . | | | | . |   | |  _| . |  _|
 |_____|_|_|_|_____|  |__,|  _|  _|_|_|_|___|_|_|_|_| |___|_|
                          |_| |_|
                    _                            _
            ___ ___|_|   ___ ___ ___ _ _ ___ ___| |_
           | .'| . | |  |  _| -_| . | | | -_|_ -|  _|
           |__,|  _|_|  |_| |___|_  |___|___|___|_|
               |_|                |_|
 ____________________________________________________________________________

 APPMONITOR API CLIENT<br>
 <br>
 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE <br>
 LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR <br>
 OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, <br>
 EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED <br>
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE <br>
 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. <br>
 SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY <br>
 SERVICING, REPAIR OR CORRECTION.<br>
 <br>
 --------------------------------------------------------------------------------<br>
 @version v0.9
 @author Axel Hahn
 @link https://github.com/iml-it/appmonitor-api-client
 @license GPL
 @license http://www.gnu.org/licenses/gpl-3.0.html GPL 3.0
 --------------------------------------------------------------------------------<br>
 2024-11-14  0.1  axel.hahn@unibe.ch  first lines
 2024-11-15  0.2  axel.hahn@unibe.ch  update hmac authorization header; add verifications in setConfig(); configure ttl and cachedir
 2024-11-20  0.3  axel.hahn@unibe.ch  handle full data or metadata only; add 3 functions to get parts of the app result
 2024-11-20  0.4  axel.hahn@unibe.ch  add getAllApps, getAllTags, getGroupResult
 2025-02-19  0.5  axel.hahn@unibe.ch  reduce curl timeout 15 -> 5 sec
 2025-03-12  0.6  axel.hahn@unibe.ch  handle newly added "public" keyword of api, add method getAppResultSince()
 2026-01-27  0.7  axel.hahn@unibe.ch  improve verification of config values; use error_log()
 2026-02-04  0.8  axel.hahn@unibe.ch  hardening using mago
 2026-02-18  0.9  axel.hahn@unibe.ch  implement hard result, add last responses, add methods to get basic meta infos

🔶 Properties

(none)

🔷 Methods

🔹 public __construct()

Constructor

Line 104 (7 lines)

Return: void

Parameters: 1 (required: 0)

Parameter Type Description
<optional> $aConfig array configuration array with subkeys 
                     - apiurl
                     - user
                     - secret

🔹 public fetchByTags()

Get application data of all matching apps by given list of tags

@see getErrors()

Line 378 (43 lines)

Return: bool

Parameters: 2 (required: 0)

Parameter Type Description
<optional> $aTags array array of tags to collect matching applications
<optional> $sWhat string kind of details; one of “public” (default)

🔹 public fetchData()

Fetch all urls to get upto date monitoring data. It first checks if cache files for the urls are outdated (older than 10 seconds). If so, they are fetched using the _multipleHttpGet method. If not, their cache files are read instead.

Then, all received data is looped over to extract metadata per application, which is stored in the internal _aData array.

It returns true if all data for all apps were fetched.

Line 436 (32 lines)

Return: array

Parameters: 1 (required: 1)

Parameter Type Description
<required> $aRelUrls array array of relative urls to fetch

🔹 public getAllAppData()

Get an array of all fetched app data by a given app id. You need to get the list of all applications first to know the ID.

@see getApps()

Line 561 (4 lines)

Return: array

Parameters: 0 (required: 0)

🔹 public getAllApps()

Get an array of all app ids as array. Each array value has

  • a key - the pplication id and
  • the subkeys “website” and “url”.

It returns false if the request faailed. You can use getErrors() to see full data of the response

@see getErrors()

Line 497 (14 lines)

Return: array|bool

Parameters: 0 (required: 0)

🔹 public getAllTags()

Get a flat list of tags as array. It returns false if the request faailed. You can use getErrors() to see full data of the response

@see getErrors()

Line 521 (14 lines)

Return: array|bool

Parameters: 0 (required: 0)

🔹 public getAppChecks()

Get an array of checks and their results by a given app id. Get an array of app meta data by a given app id. You need to get the list of all applications first to know the ID.

@see getApps()

Line 604 (4 lines)

Return: array

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppData()

Get an array of all fetched app data by a given app id. You need to get the list of all applications first to know the ID.

@see getApps()

Line 575 (4 lines)

Return: array

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppHost()

Get hostname where the application runs meta -> host

@see getApps()

Line 651 (4 lines)

Return: string

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppLabel()

Get application name meta -> website

@see getApps()

Line 637 (4 lines)

Return: string

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppLastResponses()

Get hard state of an application It returns an empty list if not found.

@see getApps()

Line 693 (4 lines)

Return: array

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppMeta()

Get an array of app meta data by a given app id. You need to get the list of all applications first to know the ID.

@see getApps()

Line 589 (4 lines)

Return: array

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppResult()

Get an array of result meta infos by a given app id. This information is available with full fetches only. You need to get the list of all applications first to know the ID.

@see getApps()

Line 619 (4 lines)

Return: array

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppResultHard()

Get hard state of an application It returns RESULT_UNKNOWN if not found.

@see getApps()

Line 665 (4 lines)

Return: int

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppResultSince()

Get unix timestamp when the current appstatus was reached (hard state). It returns -1 if not found.

@see getApps() @see getAppResult()

Line 708 (6 lines)

Return: int

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getAppResultSoft()

Get hard state of an application It returns RESULT_UNKNOWN if not found.

@see getApps()

Line 679 (4 lines)

Return: int

Parameters: 1 (required: 1)

Parameter Type Description
<required> $sApp string App ID

🔹 public getApps()

Get a list of all app keys in the result set Use this to loop over all fetched apps.

@see getAppData(<ID>)

Line 548 (4 lines)

Return: array

Parameters: 0 (required: 0)

🔹 public getErrors()

Get array of all errors of the last request Warning: Print its output only in development environment only.

Line 475 (4 lines)

Return: array

Parameters: 0 (required: 0)

🔹 public getGroupResult()

Get the worst app result in the group

Line 720 (11 lines)

Return: int

Parameters: 0 (required: 0)

🔹 public setConfig()

Set configuration. Given values will be verified. It throws an exception if something is wrong.

Line 169 (35 lines)

Return: void

Parameters: 1 (required: 1)

Parameter Type Description
<required> $aConfig array configuration array with subkeys 
                     - apiurl    string  url of appmonitor api, eg http://localhost/api/v1
                     - user      string  username for basic auth or hmac hash
                     - secret    string  (for hmac hash)
                     - password  string  (for basic auth)
                     - ttl       int     time to live in seconds (0 = no caching; max. 60)
                     - cachedir  string  path to cache dir

🔹 public verifyConfig()

Verify configuration and abort on critical error @throws Exception

Line 133 (22 lines)

Return: void

Parameters: 0 (required: 0)

Generated with Axels PHP class doc parser