PHPackages                             roger-russel/beholder-web-client - 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 &amp; Monitoring](/categories/logging)
4. /
5. roger-russel/beholder-web-client

ActiveSystem[Logging &amp; Monitoring](/categories/logging)

roger-russel/beholder-web-client
================================

A simple php monitoring client

v0.12.0(7y ago)31.1k1[14 issues](https://github.com/roger-russel/beholder-web-client/issues)Apache-2.0PHPPHP &gt;=5.5

Since Jul 7Pushed 7y agoCompare

[ Source](https://github.com/roger-russel/beholder-web-client)[ Packagist](https://packagist.org/packages/roger-russel/beholder-web-client)[ RSS](/packages/roger-russel-beholder-web-client/feed)WikiDiscussions master Synced today

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

Beholder Monitor - Php Web Client
=================================

[](#beholder-monitor---php-web-client)

[![Travis:Master](https://camo.githubusercontent.com/ad8f3ad05992d54309a8ba65e70fa0baa6fa2f85a2a472a6e190b2d529a676ba/68747470733a2f2f7472617669732d63692e6f72672f726f6765722d72757373656c2f6265686f6c6465722d7765622d636c69656e742e7376673f6272616e63683d6d6173746572 "Travis Master")](https://camo.githubusercontent.com/ad8f3ad05992d54309a8ba65e70fa0baa6fa2f85a2a472a6e190b2d529a676ba/68747470733a2f2f7472617669732d63692e6f72672f726f6765722d72757373656c2f6265686f6c6465722d7765622d636c69656e742e7376673f6272616e63683d6d6173746572)[![Codecov branch](https://camo.githubusercontent.com/3594dbe39d36c86e1d013d325f25d3a544a774503b0e80c8d316bd01b79386df/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f726f6765722d72757373656c2f6265686f6c6465722d7765622d636c69656e742f6d61737465722e737667)](https://codecov.io/gh/roger-russel/beholder-web-client)[![Latest Version](https://camo.githubusercontent.com/25f77eb2aa424ec0dcc654635517b9723059b4f365d12a2e962202d9f42668de/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f726f6765722d72757373656c2f6265686f6c6465722d7765622d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/roger-russel/beholder-web-client)![Packagist](https://camo.githubusercontent.com/c5b28d60294311163c0b936db48fb277518e187f8b8fb00220ec73109f7f311a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f726f6765722d72757373656c2f6265686f6c6465722d7765622d636c69656e742e737667)[![Software License](https://camo.githubusercontent.com/e396acbea77d14ab36b6a3ccdee86feb8c4952604e12780071eb7daa194d858e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4170616368652d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)

Beholder is a simple php monitoring system, this client is made to serve a json response with the current stats of what is been monitored.

[![Try Beholder](https://raw.githubusercontent.com/RogerRussel/beholder-web-client/master/opt/img/beholder.jpg)](https://raw.githubusercontent.com/RogerRussel/beholder-web-client/master/opt/img/beholder.jpg)

This client can be used with Zabbix and others tools, just setup those to read the json file which this client give.

Dependencies
------------

[](#dependencies)

- PHP:5.6, why? For compatibility.
- Composer
- Lib Yaml, required only if you use it. See more here. [here](doc/YAML.md).

Some modules could have more dependencies, please look at src/Eyes/ModuleName/Readme.md too.

How Install
-----------

[](#how-install)

Use the command below to add the dependencies inside the composer.json file:

> `$ composer require roger-russel/beholder-web-client;`

### How to use

[](#how-to-use)

You can look at a especific model configuration in doc/ModelName folder.

```
require 'vendor/autoload.php';

$conf = [
  'eyes' => [
      'DB' => [ // This DB is just an alias, it can be anything
        'type' => 'Db\MySQL', // Model wich will be used, this will be usage Db\Mysql Model.
//      'driver' => 'PDO', // If this option is not setted it will try to use one on this order: PDO, mysqli or mysql. If setted it will force to use it.
        'host' => 'beholder-test-mysql',
        'user' => 'root',
        'password' => 'initial1234',
//      'port' => 3306, // If not setted it will use the default port 3306
        'dbname' => 'beholder_test',
        'querys' => [ // Query that will runned on a test, it will be executed into the following order: CREATE, INSERT, UPDATE, SELECT and DROP.
          'select' => 'select name from user limit 1'
        ]
      ]
  ]
];

$beholder = new BeholderWebClient\Observer($conf);
$beholder->run();

```

How to Contribute
-----------------

[](#how-to-contribute)

Contribute is easy. Make a fork and start to code, then do a pull request.

You can contribute not just in code, you can make a bug report, a issue asking for a feature or simply giving your suggestion.

### How to run locally

[](#how-to-run-locally)

With docker is easy and fun!

- Create a docker network

> `$ docker network create --driver bridge beholder-network`

- Build the project and run the container

> `$ docker-compose build`

> `$ docker-compose up`

- Enter the container and run composer to install the dependencies

> `$ docker exec -it beholder-web-client bash`

> `$ composer install`

Or the one liner command:

> `$ docker exec -it beholder-web-client composer install`

### To run the codeception tests

[](#to-run-the-codeception-tests)

With the docker container running do the following:

> `$ docker exec -it beholder-web-client bash`

> `$ codecept run`

Or the one liner command:

> `$ docker exec -it beholder-web-client codecept run`

You can run especific tests like the following:

> `$ codecept run nfs`

> `$ codecept run unit`

If you want to run a mysql test, first you need to start the docker mysql container inside tests/mysql/ folder. Then run the following command:

> `$ codecept run mysql `

License
=======

[](#license)

Apache 2.0 Copyright 2017 Roger Russel, and Alan Yoshida

###  Health Score

25

—

LowBetter than 35% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~18 days

Recently: every ~106 days

Total

26

Last Release

2818d ago

PHP version history (2 changes)v0.7.1PHP &gt;=5.6

v0.9.1PHP &gt;=5.5

### Community

Maintainers

![](https://www.gravatar.com/avatar/5533968397e006bf78cd79dd0f7331f824dd64ecabc1bef7f6997003de49c204?d=identicon)[RogerRussel](/maintainers/RogerRussel)

---

Top Contributors

[![roger-russel](https://avatars.githubusercontent.com/u/2228641?v=4)](https://github.com/roger-russel "roger-russel (36 commits)")[![alanyoshida](https://avatars.githubusercontent.com/u/299053?v=4)](https://github.com/alanyoshida "alanyoshida (4 commits)")

---

Tags

configuration-monitoringmonitorphp

###  Code Quality

TestsCodeception

### Embed Badge

![Health badge](/badges/roger-russel-beholder-web-client/health.svg)

```
[![Health](https://phpackages.com/badges/roger-russel-beholder-web-client/health.svg)](https://phpackages.com/packages/roger-russel-beholder-web-client)
```

###  Alternatives

[psr/log

Common interface for logging libraries

10.4k1.2B11.5k](/packages/psr-log)[open-telemetry/api

API for OpenTelemetry PHP.

1941.5M275](/packages/open-telemetry-api)[open-telemetry/sdk

SDK for OpenTelemetry PHP.

2328.5M342](/packages/open-telemetry-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
