Skip to content

Give the ability for status call to output in JSON format #1064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Give the ability for status call to output in JSON format #1064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6c9165c
Made changes to add new JSON format figure for status call.
Oct 29, 2024
8e310d5
Merge branch 'master' into dev-2024-10-25-status-json
Oct 29, 2024
916d59b
Code Cleanup of spaces.
Oct 29, 2024
8b1810d
Code Cleanup of spaces again.
Oct 29, 2024
4b7be16
Made Count and Processes ints.
Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ composer.lock
phpunit.xml
/phpstan.neon
/*.pid
/*.pid.lock
/*.pid.lock
nbproject/
128 changes: 126 additions & 2 deletions src/Worker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,13 @@ class Worker
*/
public static string $logFile;

/**
* Log in JSON.
*
* @var bool
*/
public static bool $jsonLog = false;

/**
* Global event loop.
*
Expand Down Expand Up @@ -972,7 +979,7 @@ protected static function parseCommand(): void

// Check argv;
$startFile = basename(static::$startFile);
$usage = "Usage: php yourfile <command> [mode]\nCommands: \nstart\t\tStart worker in USER mode.\n\t\tUse mode -d to start in DAEMON mode.\nstop\t\tStop worker.\n\t\tUse mode -g to stop gracefully.\nrestart\t\tRestart workers.\n\t\tUse mode -d to start in DAEMON mode.\n\t\tUse mode -g to stop gracefully.\nreload\t\tReload codes.\n\t\tUse mode -g to reload gracefully.\nstatus\t\tGet worker status.\n\t\tUse mode -d to show live status.\nconnections\tGet worker connections.\n";
$usage = "Usage: php yourfile <command> [mode]\nCommands: \nstart\t\tStart worker in USER mode.\n\t\tUse mode -d to start in DAEMON mode.\nstop\t\tStop worker.\n\t\tUse mode -g to stop gracefully.\nrestart\t\tRestart workers.\n\t\tUse mode -d to start in DAEMON mode.\n\t\tUse mode -g to stop gracefully.\nreload\t\tReload codes.\n\t\tUse mode -g to reload gracefully.\nstatus\t\tGet worker status.\n\t\tUse switch -d to show live status.\n\t\tUse flag -jl to print log in JSON.\\nconnections\tGet worker connections.\n";
$availableCommands = [
'start',
'stop',
Expand All @@ -985,6 +992,8 @@ protected static function parseCommand(): void
'-d',
'-g'
];
$availableLog = ['-jl'];

$command = $mode = '';
foreach (static::getArgv() as $value) {
if (!$command && in_array($value, $availableCommands)) {
Expand All @@ -993,6 +1002,9 @@ protected static function parseCommand(): void
if (!$mode && in_array($value, $availableMode)) {
$mode = $value;
}
if (in_array($value, $availableLog)) {
static::$jsonLog = true;
}
}

if (!$command) {
Expand Down Expand Up @@ -1211,7 +1223,119 @@ protected static function formatProcessStatusData(): string
. str_pad((string)$totalConnections, 11) . " " . str_pad((string)$totalFails, 9) . " "
. str_pad((string)$totalTimers, 7) . " " . str_pad((string)$totalRequests, 13) . " "
. str_pad((string)$totalQps, 6) . " [Summary] \n";
return $statusStr;
return ( static::$jsonLog === true ? self::formatConnectionStatusDataJson($statusStr) : $statusStr );
}

protected static function formatConnectionStatusDataJson( string $statusStr ): string
{
$gsKey = 'Global Status';
$pKey = 'Processes';
$arr = [ $gsKey => [], $pKey => ['Records' => []] ];
$currStatus = null;
$processKeys = [];

$lines = explode("\n", $statusStr );

foreach($lines as $line){
$matches = [];

if(preg_match('/GLOBAL STATUS/', $line)){
$currStatus = 'GLOBAL';
continue;
} elseif(preg_match('/^worker_name\s+exit_status\s+exit_count/', $line) && $currStatus === 'GLOBAL') {
$currStatus = 'WORKER';
continue;
} elseif(preg_match('/PROCESS STATUS/', $line) && $currStatus === 'WORKER') {
$currStatus = 'PROCESS';
continue;
} elseif(preg_match('/PROCESS STATUS/', $line) && $currStatus === 'PROCESS') {
$currStatus = 'SUMMARY';
continue;
}

if( $currStatus === 'GLOBAL' ){
if( preg_match('/^Workerman version:(\S+)\s+PHP version:(\S+)/', $line, $matches ) &&
array_key_exists(1,$matches) && array_key_exists(2,$matches) ){
$arr[$gsKey]['Versions'] = ['Workerman' => $matches[1], 'PHP' => $matches[2]];
} elseif( preg_match('/^start time:(.*?)\s+run(.*)/', $line, $matches ) &&
array_key_exists(1,$matches) && array_key_exists(2,$matches) ){
$arr[$gsKey]['Run Stats'] = [ 'Start Time' => rtrim($matches[1]),
'Uptime' => trim($matches[2]) ];
} elseif( preg_match('/^load average:\s(\S+,\s\S+,\s\S+)\s+event-loop:(\S+)/', $line, $matches ) &&
array_key_exists(1,$matches) && array_key_exists(2,$matches) ){
$arr[$gsKey]['Load Average'] = $matches[1];
$arr[$gsKey]['Event'] = $matches[2];
} elseif( preg_match('/^(\d+) workers\s+(\d+) processes/', $line, $matches ) &&
array_key_exists(1,$matches) && array_key_exists(2,$matches) ){
$arr[$gsKey]['Workers'] = [ 'Count' => intval($matches[1]), 'Processes' => intval($matches[2]),
'Records' => [] ];
$arr[$pKey]['Count'] = intval($matches[2]);
}
} elseif( $currStatus === 'WORKER' ){

if( preg_match('/^(.*?)\s(\d)\s+(\d)/', $line, $matches ) &&
array_key_exists(1,$matches) && array_key_exists(2,$matches) && array_key_exists(3,$matches) ){

$arr[$gsKey]['Workers']['Records'][] = ['Name' => rtrim($matches[1]),
'Exit Status' => intval($matches[2]),
'Exit Count' => intval($matches[3])];
}
} elseif( $currStatus === 'PROCESS' ){
if(preg_match('/^pid\s+memory\s+listening/', $line)) {
preg_match('/^(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*)/',
$line,
$matches );

if( count($matches) < 3 ){
continue;
}

for($i = 1; $i < count($matches); $i++ ){
$processKeys[$i] = $matches[$i];
}

} elseif( preg_match('/^(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(.*)/',
$line,
$matches ) ){

if( count($processKeys) !== count($matches) - 1 || count($processKeys) < 3 ){
//header row column count did not match row count
continue;
}
$pArr = [];

for( $i = 1; $i <= count($processKeys); $i++ ){
$pArr[$processKeys[$i]] = ( is_numeric($matches[$i]) ? intval($matches[$i]) : $matches[$i] );
}
$arr[$pKey]['Records'][] = $pArr;
}

} elseif( $currStatus === 'SUMMARY') {
if( preg_match('/^(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(.*)/',
$line,
$matches ) ){

if( count($processKeys) !== count($matches) - 1 || count($processKeys) < 3 ){
//header row column count did not match row count
continue;
}

$pArr = [];

for( $i = 2; $i < count($processKeys); $i++ ){
if( $matches[$i] === '-' ){
continue;
}
$pArr[$processKeys[$i]] = ( is_numeric($matches[$i]) ? intval($matches[$i]) : $matches[$i] );
}

$arr[$pKey]['Summary'] = $pArr;
}
}
}

return json_encode($arr, JSON_PRETTY_PRINT);

}

protected static function formatConnectionStatusData(): string
Expand Down