https://github.com/ahaaje/linux-system-information

Light-weight library to help gather information on a running Linux system
https://github.com/ahaaje/linux-system-information

composer linux php stats system-information

Last synced: 15 days ago
JSON representation

Light-weight library to help gather information on a running Linux system

• Host: GitHub
• URL: https://github.com/ahaaje/linux-system-information
• Owner: ahaaje
• License: mit
• Created: 2017-07-17T14:15:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-28T12:57:19.000Z (almost 6 years ago)
• Last Synced: 2024-07-29T17:40:02.444Z (3 months ago)
• Topics: composer, linux, php, stats, system-information
• Language: PHP
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Linux System Information

=========================

[![Latest Stable Version](https://poser.pugx.org/ahaaje/linux-system-information/v/stable)](https://packagist.org/packages/ahaaje/linux-system-information)

[![License](https://poser.pugx.org/ahaaje/linux-system-information/license)](https://packagist.org/packages/ahaaje/linux-system-information)

[![composer.lock](https://poser.pugx.org/ahaaje/linux-system-information/composerlock)](https://packagist.org/packages/ahaaje/linux-system-information)

This is a light-weight library to gather information (stats) about the Linux system it is running on.

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 `exec`calls to binaries installed on your system.

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

 - Linux

 - PHP 5.5

 

### Installation

With [composer](https://getcomposer.org/) simply do `composer require ahaaje/linux-system-information` inside your project directory.

### 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

```php

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)```

### 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.

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.