Quickstart Monitor a webapp

Edit on GitHub

Table of Contents

Global picture

This is an overview about needed installations or actions.

flowchart TD %% ----- STYLING linkStyle default stroke: #ccc,stroke-width:3px style START fill:#eee,stroke:#888,stroke-width:2px style END fill:#eee,stroke:#888,stroke-width:2px classDef ok fill:#8e8,stroke:#4a3,stroke-width:2px classDef work fill:#fb4,stroke:#da3,stroke-width:2px style LOOPSTART fill:#eee,stroke:#888,stroke-width:2px style LOOPEND fill:#eee,stroke:#888,stroke-width:2px %% ----- NODES START((Start)) END((End)) LOOPSTART(( )) SRV[First:<br>Install Appmonitor server] AddAppminitorCheck[Add delivered checks for<br>Appmonitor server] WannaMonitor[I want to monitor<br>a webapp<br>on a server] IsPHP{Is it a<br>PHP <br>webapp?} SeeDescription[See description<br>of JSON syntax for<br> client response] InstallClient[Install Appmonitor client] SupportedApp{Is this PHP webapp<br>supported already?} UseAppCheck[Start with a<br>pre defined check] CreateChecks[Create a custom check<br>using existing checks] LOOPEND(( )) MOREAPPS{One more<br>webapp?} %% ----- NODES START --> SRV:::ok --> AddAppminitorCheck --> LOOPSTART LOOPSTART --> WannaMonitor WannaMonitor --> IsPHP IsPHP -->|No| SeeDescription:::work IsPHP -->|Yes| InstallClient:::ok InstallClient --> SupportedApp SupportedApp --> |Yes| UseAppCheck:::ok SupportedApp --> |No| CreateChecks:::work SeeDescription --> LOOPEND UseAppCheck --> LOOPEND CreateChecks --> LOOPEND LOOPEND --> MOREAPPS MOREAPPS --> |Yes| LOOPSTART MOREAPPS --> |No| END

Server

You need a server installation to have a web interface and to send notifications. The server needs PHP and can be installed when a machine has PHP installed.

You also can install it on your local machine or a dedicated system

  • using Apache httpd/ Nginx and php or
  • using docker

You can check the application status in your network or on shared hosting.

👉 See Server -> Installation

PHP webapp

You run a PHP application and want to monitor it. Your luck: A PHP client is delivered in the project.

  • Install the Appmonitor client
  • Configure the Appmonitor client

Install the Appmonitor client

On you system with the web application you need to install the Appmonitor client. On a shared hosting you can create a subdirectory eg. [webroot]/appmonitor/. If you have more control you can install it outside webroot and add an alias /appmonitor.

👉 See Install the Appmonitor client

Configure the Appmonitor client

  • If you run a PHP application, where a pre defined client check is delivered (see ./client/plugins/apps/) then you are lucky again and can profit from it: you can start with a preset of application specific checks.
    👉 See Use Application checks

  • If not: the folder ./client/plugins/checks/ contains several check items to test http connections, database connections, files and more.
    You can create your own application check with these check plugins.
    👉 See Write Checks

Non-PHP webapp

You need to implement the checks and a JSON response in the given format.

👉 See Decription of response