, (*1)
This is a light-weight library to gather information (stats) about the Linux system it is running on., (*2)
The information is read from the files in /proc/* and /etc/*. These are usually world readable, but your system may vary. There is no dependency on system or execcalls to binaries installed on your system., (*3)
Features
- PSR-4 auto loading compliant structure
- Example file
- Normalize stats to "human readable" form
- Extendability
Stats that can be fetched
- hostname
- load average for 1, 5 or 15 minutes
- memory as total, available and used
- file system size and usage
Requirements
Installation
With composer simply do composer require ahaaje/linux-system-information inside your project directory., (*4)
Usage
This is from the example file. You should not need to require the auto loader if already using composer to manage your project requirements, (*5)
<?php
require '../vendor/autoload.php';
use Ahaaje\LinuxSystemInformation\System;
try {
$system = new System();
echo 'Host:' . $system, PHP_EOL;
echo 'Load average last 5 minutes: ' . $system->getLoadAverage(5), PHP_EOL;
echo 'Total memory: ' . $system->getMemoryCategory('total'), PHP_EOL;
echo 'Used memory: ' . $system->getMemoryCategory('used'), PHP_EOL;
echo 'Available memory: ' . $system->getMemoryCategory('available'), PHP_EOL;
} catch (\RuntimeException $e) {
// Some stat could not be accessed
echo get_class($e) . ' : ' . $e->getMessage(), PHP_EOL;
} catch (\Exception $e) {
echo 'FATAL EXCEPTION: ' . $e->getMessage(), PHP_EOL;
}
Stat numbers for disk space and memory are returned as kilo bytes, but you can add true as a second parameter to
the get*Category() functions to have them normalized into MB, GB or TB - like this php $system->getMemoryCategory('total', true), (*6)
Exceptions
Exceptions are thrown as siblings of RuntimeException if some stats can't be read or otherwise accessed.
The information sources used, like /proc/meminfo, are normally accessible. However, a system administrator could restrict access to functions that read files outside the home directory., (*7)
If thrown, the exception message should give you enough information to figure out what is the problem.
You can extend and override the System and Mount classes if you have a special setup that is not covered., (*8)
Wallogit.com
