Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abrander/phpusage
Simple usage logger for php
https://github.com/abrander/phpusage
Last synced: about 1 month ago
JSON representation
Simple usage logger for php
- Host: GitHub
- URL: https://github.com/abrander/phpusage
- Owner: abrander
- License: mit
- Created: 2015-02-02T09:37:06.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-02-05T14:55:24.000Z (almost 10 years ago)
- Last Synced: 2023-02-27T02:06:40.220Z (almost 2 years ago)
- Language: PHP
- Size: 699 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# phpusage
Simple usage logger for php.
An important note about CLK_TCK
--------------------
PhpUsage needs to know the number of clock tics per second. A value of 100 is hardcoded in
```PhpUsage::CLK_TCK```. You should check if this is the case for your environment too:
```sh
$ getconf CLK_TCK
100
```
If the system value is not 100 you must update ```PhpUsage::CLK_TCK``` to reflect the actual value.
Manual logging
--------------
You can simply call ```PhpUsage::logUsage()``` and the class will write
a line to /var/log/phpusage.csv with some basic usage statistics.
Automatic logging
-----------------
For deplying it can be useful to enable automatic logging of all script
execution. The file *phpusage.ini* can be included in PHP configuration
for automatic logging of all processes. Remember to update path.
The script *auto_prepend_file.php* will simply call
```register_shutdown_function(array('PhpUsage', 'logUsage'));```.
Fields in the CSV file
----------------------
| Field | Description |
| :------ | :--------------------------------------------------------------------------------------------- |
| pid | Process ID of the process |
| start | Start time of the process as a RFC2822-formatted date |
| nice | Nice value of process |
| ruid | [Real userid of process](http://en.wikipedia.org/wiki/User_identifier#Real_user_ID) |
| euid | [Effective userid of process](http://en.wikipedia.org/wiki/User_identifier#Effective_user_ID) |
| real | Time passed since process start |
| utime | Time spend in user mode (excluding time spend by children) (seconds) |
| stime | Time spend in kernel mode (excluding time spend by children) (seconds) |
| cutime | Time spend by children in user mode (seconds) |
| cstime | Time spend by children in kernel mode (seconds) |
| rchar | Characters read by process (bytes) |
| wchar | Characters written by process (bytes) |
| syscr | Number of syscalls caused by reads |
| syscw | Number of syscalls caused by writes |
| iowait | Time spend waiting for IO (seconds) |
| cmdline | Command line used to start the process |
Importing to MySQL
------------------
The logfile is standard CSV so it should be pretty simple to import to MySQL (or
other SQL server).
```sql
CREATE TABLE phpusage (
pid int(11),
start timestamp,
nice int(11),
ruid int(11),
euid int(11),
`real` float,
utime float,
stime float,
cutime float,
cstime float,
rchar int(11),
wchar int(11),
syscr int(11),
syscw int(11),
iowait float,
cmdline varchar(100)
);
LOAD DATA LOCAL INFILE "/var/log/phpusage.csv"
INTO TABLE phpusage CHARACTER SET utf8
FIELDS TERMINATED BY "," ENCLOSED BY "\""
IGNORE 1 LINES;
```
The file *mysql-import.sql* contains a simple example of importing to MySQL.
Example SQL queries
-------------------
#### Overview
```sql
SELECT
cmdline,
COUNT(1) AS called,
AVG(`real`) AS real_avg,
MAX(`real`) AS real_max,
AVG(iowait) AS iowait_avg,
MAX(iowait) AS iowait_max
FROM phpusage
GROUP BY cmdline;
```
#### Slowest
```sql
SELECT
cmdline,
COUNT(1) AS called,
AVG(`real`) AS real_avg
FROM phpusage
GROUP BY cmdline
ORDER BY real_avg DESC;
```
#### Total time
```sql
SELECT
cmdline,
COUNT(1) AS called,
SUM(`real`) AS real_sum
FROM phpusage
GROUP BY cmdline
ORDER BY real_sum DESC;
```
#### Total IO
```sql
SELECT
cmdline,
COUNT(1) AS called,
SUM(rchar)+SUM(wchar) AS io_bytes,
SUM(rchar) AS rchar_sum,
SUM(wchar) AS wchar_sum
FROM phpusage
GROUP BY cmdline
ORDER BY io_bytes DESC;
```