Download the PHP package yidas/mtr-database without Composer
On this page you can find all versions of the php package yidas/mtr-database. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yidas/mtr-database
More information about yidas/mtr-database
Files in yidas/mtr-database
Package mtr-database
Short Description MTR Batch processing storing in database with dashboard
License MIT
Homepage https://github.com/yidas/mtr-database-php
Informations about the package mtr-database
MTR Database for PHP
MTR centralized monitoring dashboard with agent deployment
OUTLINE
- Demonstration
- Introduction
- Requirements
- Installation
- Download
- Setup
- Database Setup
- Agent Setup & Launch
- API for collector & agents
- Dashboard
- Advanced Usage
- Agent Configuration
- Purge
- References
DEMONSTRATION
INTRODUCTION
Easy to deploy agents and collect MTR data into a database for monitoring via a web dashboard with charts.
REQUIREMENTS
This library requires the following:
- MTR library (CLI) 0.9+
- PHP 5.4.0+|7.0+
INSTALLATION
Download
Composer Installation
Using Composer to install is the easiest way with auto-installer:
Wget Installation
You could see Release for picking up the package with version, for example:
After download, uncompress the package:
SETUP
Database Setup
After the download, you could start to set up the config.inc.php
with your database connection:
Then run install.php
which will help you to install the database & table:
Agent Setup & Launch
The default setting of the agent can be configurated in config.inc.php
:
After the setting, enjoy to run or set launch.php
with your prefered arguments in crontab:
Set crontab into /etc/cron.d/mtr-database
:
The default batch period is configured to be 10 minutes, so we can set the batch to be executed every 10 minutes.
API for collector & agents
Regarding the introduction structure diagram, it's better to collect agents' MTR data via API (Default is database).
The endpoint path of collector (reportUrl
) is /collect.php
, you could place the project in the web path such as /var/www/html/mtr-database/index.php
.
Configuration for collector, the database setting is required:
Configuration for agents:
Dashboard
The endpoint path of MTR Dashboard is /index.php
and it's disable by default, you could place the project in the web path such as /var/www/html/mtr-database/index.php
.
Turn the enabled
on and set the username and password for the authentication in config.ini.php
, the database setting is required:
categories
will enable you to query specific data by category settings or query all data with default blank values.
ADVANCED USAGE
Agent Configuration
The configuration file config.inc.php
allows you to set the default settings for MTR launching. However, you can also specify parameters immediately in the command to be run.
Host
Host parameter allows you to specify the target host to be tracked with -h --host
parameter:
Period
Period argument allocate the number of minutes between crontab intervals with -p --period
parameter:
In addition, Count argument will distribute the sending count between the interval according to the Period setting with -c --report-cycles
parameter:
TCP
TCP argument allows you to use MTR TCP mode with specified port, -T --tcp
for enabling TCP mode and -P --port
for setting port:
Category
Category allows to categorize each monitor command and supports filtering from the dashboard, which also can be achieved by using the --category
parameter:
Purge
Running purge.php
will delete old records older than the given number of days. You can use the -d --days
parameter to set with (default is 90 days):