mirror of https://github.com/MISP/MISP
new: [CLI] Worker management added
- Added a more exhaustive worker management CLI script package - list workers - start a worker - restart a worker - kill a workerpull/4448/head
iglocska
parent
79f34238a8
commit
90fc9f26c2
|
|
@ -39,11 +39,64 @@ class AdminShell extends AppShell
|
|||
echo $this->Server->update($status) . PHP_EOL;
|
||||
}
|
||||
|
||||
public function restartWorkers() {
|
||||
public function restartWorkers()
|
||||
{
|
||||
$this->Server->restartWorkers();
|
||||
echo PHP_EOL . 'Workers restarted.' . PHP_EOL;
|
||||
}
|
||||
|
||||
public function restartWorker()
|
||||
{
|
||||
if (empty($this->args[0]) || !is_numeric($this->args[0])) {
|
||||
echo 'Usage: ' . APP . '/cake ' . 'Admin restartWorker [PID]';
|
||||
}
|
||||
$pid = $this->args[0];
|
||||
$result = $this->Server->restartWorker($pid);
|
||||
if ($result === true) {
|
||||
$response = __('Worker restarted.');
|
||||
} else {
|
||||
$response = __('Could not restart the worker. Reason: %s', $result);
|
||||
}
|
||||
echo sprintf(
|
||||
'%s%s%s',
|
||||
PHP_EOL,
|
||||
$response,
|
||||
PHP_EOL
|
||||
);
|
||||
}
|
||||
|
||||
public function killWorker()
|
||||
{
|
||||
if (empty($this->args[0]) || !is_numeric($this->args[0])) {
|
||||
echo 'Usage: ' . APP . '/cake ' . 'Admin killWorker [PID]';
|
||||
die();
|
||||
}
|
||||
$pid = $this->args[0];
|
||||
$result = $this->Server->killWorker($pid, false);
|
||||
echo sprintf(
|
||||
'%s%s%s',
|
||||
PHP_EOL,
|
||||
__('Worker killed.'),
|
||||
PHP_EOL
|
||||
);
|
||||
}
|
||||
|
||||
public function startWorker()
|
||||
{
|
||||
if (empty($this->args[0])) {
|
||||
echo 'Usage: ' . APP . '/cake ' . 'Admin startWorker [queue]';
|
||||
die();
|
||||
}
|
||||
$queue = $this->args[0];
|
||||
$this->Server->startWorker($queue);
|
||||
echo sprintf(
|
||||
'%s%s%s',
|
||||
PHP_EOL,
|
||||
__('Worker started.'),
|
||||
PHP_EOL
|
||||
);
|
||||
}
|
||||
|
||||
public function updateGalaxies() {
|
||||
// The following is 7.x upwards only
|
||||
//$value = $this->args[0] ?? $this->args[0] ?? 0;
|
||||
|
|
@ -141,8 +194,27 @@ class AdminShell extends AppShell
|
|||
|
||||
public function getWorkers() {
|
||||
$result = $this->Server->workerDiagnostics($workerIssueCount);
|
||||
$query = 'all';
|
||||
if (!empty($this->args[0])) {
|
||||
$query = $this->args[0];
|
||||
}
|
||||
if ($query === 'dead') {
|
||||
$dead_workers = array();
|
||||
foreach ($result as $queue => $data) {
|
||||
if (!empty($data['workers'])) {
|
||||
foreach ($data['workers'] as $k => $worker) {
|
||||
if ($worker['alive']) {
|
||||
unset($result[$queue]['workers'][$k]);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (empty($result[$queue]['workers'])) {
|
||||
unset($result[$queue]);
|
||||
}
|
||||
}
|
||||
}
|
||||
echo json_encode($result, JSON_PRETTY_PRINT) . PHP_EOL;
|
||||
}
|
||||
}
|
||||
|
||||
public function getSetting() {
|
||||
$param = empty($this->args[0]) ? 'all' : $this->args[0];
|
||||
|
|
|
|||
|
|
@ -105,33 +105,43 @@ class Server extends AppModel
|
|||
$this->command_line_functions = array(
|
||||
'console_admin_tasks' => array(
|
||||
'data' => array(
|
||||
'getSettings' => 'MISP/app/Console/cake Admin getSetting [setting]',
|
||||
'setSettings' => 'MISP/app/Console/cake Admin setSetting [setting] [value]',
|
||||
'getAuthkey' => 'MISP/app/Console/cake Admin getAuthkey [email]',
|
||||
'setBaseurl' => 'MISP/app/Console/cake Baseurl [baseurl]',
|
||||
'changePassword' => 'MISP/app/Console/cake Password [email] [new_password] [--override_password_change]',
|
||||
'clearBruteforce' => 'MISP/app/Console/cake Admin clearBruteforce [user_email]',
|
||||
'updateDatabase' => 'MISP/app/Console/cake Admin updateDatabase',
|
||||
'updateGalaxies' => 'MISP/app/Console/cake Admin updateGalaxies',
|
||||
'updateTaxonomies' => 'MISP/app/Console/cake Admin updateTaxonomies',
|
||||
'updateObjectTemplates' => 'MISP/app/Console/cake Admin updateObjectTemplates',
|
||||
'updateWarningLists' => 'MISP/app/Console/cake Admin updateWarningLists',
|
||||
'updateNoticeLists' => 'MISP/app/Console/cake Admin updateNoticeLists',
|
||||
'setDefaultRole' => 'MISP/app/Console/cake Admin setDefaultRole [role_id]'
|
||||
'Get setting' => 'MISP/app/Console/cake Admin getSetting [setting]',
|
||||
'Set setting' => 'MISP/app/Console/cake Admin setSetting [setting] [value]',
|
||||
'Get authkey' => 'MISP/app/Console/cake Admin getAuthkey [email]',
|
||||
'Set baseurl' => 'MISP/app/Console/cake Baseurl [baseurl]',
|
||||
'Change password' => 'MISP/app/Console/cake Password [email] [new_password] [--override_password_change]',
|
||||
'Clear Bruteforce Entries' => 'MISP/app/Console/cake Admin clearBruteforce [user_email]',
|
||||
'Run database update' => 'MISP/app/Console/cake Admin updateDatabase',
|
||||
'Update Galaxy definitions' => 'MISP/app/Console/cake Admin updateGalaxies',
|
||||
'Update taxonomy definitions' => 'MISP/app/Console/cake Admin updateTaxonomies',
|
||||
'Update object templates' => 'MISP/app/Console/cake Admin updateObjectTemplates',
|
||||
'Update Warninglists' => 'MISP/app/Console/cake Admin updateWarningLists',
|
||||
'Update Noticelists' => 'MISP/app/Console/cake Admin updateNoticeLists',
|
||||
'Set default role' => 'MISP/app/Console/cake Admin setDefaultRole [role_id]'
|
||||
),
|
||||
'description' => __('Certain administrative tasks are exposed to the API, these help with maintaining and configuring MISP in an automated way / via external tools.'),
|
||||
'header' => __('Administering MISP via the CLI')
|
||||
),
|
||||
'console_automation_tasks' => array(
|
||||
'data' => array(
|
||||
'pull' => 'MISP/app/Console/cake Server pull [user_id] [server_id] [full|update]',
|
||||
'push' => 'MISP/app/Console/cake Server push [user_id] [server_id]',
|
||||
'cacheFeed' => 'MISP/app/Console/cake Server cacheFeed [user_id] [feed_id|all|csv|text|misp]',
|
||||
'fetchFeed' => 'MISP/app/Console/cake Server fetchFeed [user_id] [feed_id|all|csv|text|misp]',
|
||||
'enrichment' => 'MISP/app/Console/cake Event enrichEvent [user_id] [event_id] [json_encoded_module_list]'
|
||||
'Pull' => 'MISP/app/Console/cake Server pull [user_id] [server_id] [full|update]',
|
||||
'Push' => 'MISP/app/Console/cake Server push [user_id] [server_id]',
|
||||
'Cache feeds for quick lookups' => 'MISP/app/Console/cake Server cacheFeed [user_id] [feed_id|all|csv|text|misp]',
|
||||
'Fetch feeds as local data' => 'MISP/app/Console/cake Server fetchFeed [user_id] [feed_id|all|csv|text|misp]',
|
||||
'Run enrichment' => 'MISP/app/Console/cake Event enrichEvent [user_id] [event_id] [json_encoded_module_list]'
|
||||
),
|
||||
'description' => __('If you would like to automate tasks such as caching feeds or pulling from server instances, you can do it using the following command line tools. Simply execute the given commands via the command line / create cron jobs easily out of them.'),
|
||||
'header' => __('Automating certain console tasks')
|
||||
),
|
||||
'worker_management_tasks' => array(
|
||||
'data' => array(
|
||||
'Get list of workers' => 'MISP/app/Console/cake Admin getWorkers [all|dead]',
|
||||
'Start a worker' => 'MISP/app/Console/cake Admin startWorker [queue_name]',
|
||||
'Restart a worker' => 'MISP/app/Console/cake Admin restartWorker [worker_pid]',
|
||||
'Kill a worker' => 'MISP/app/Console/cake Admin killWorker [worker_pid]',
|
||||
),
|
||||
'description' => __('The background workers can be managed via the CLI in addition to the UI / API management tools'),
|
||||
'header' => __('Managing the background workers')
|
||||
)
|
||||
);
|
||||
|
||||
|
|
@ -4709,6 +4719,37 @@ class Server extends AppModel
|
|||
return true;
|
||||
}
|
||||
|
||||
public function restartWorker($pid)
|
||||
{
|
||||
if (Configure::read('MISP.background_jobs')) {
|
||||
$this->ResqueStatus = new ResqueStatus\ResqueStatus(Resque::redis());
|
||||
$workers = $this->ResqueStatus->getWorkers();
|
||||
$pid = intval($pid);
|
||||
if (!isset($workers[$pid])) {
|
||||
return __('Invalid worker.');
|
||||
}
|
||||
$currentWorker = $workers[$pid];
|
||||
$this->killWorker($pid, false);
|
||||
$this->startWorker($currentWorker['queue']);
|
||||
return true;
|
||||
}
|
||||
return __('Background workers not enabled.');
|
||||
}
|
||||
|
||||
public function startWorker($queue)
|
||||
{
|
||||
$validTypes = array('default', 'email', 'scheduler', 'cache', 'prio');
|
||||
if (!in_array($queue, $validTypes)) {
|
||||
return __('Invalid worker type.');
|
||||
}
|
||||
if ($queue != 'scheduler') {
|
||||
shell_exec(APP . 'Console' . DS . 'cake CakeResque.CakeResque start --interval 5 --queue ' . $queue .' > /dev/null 2>&1 &');
|
||||
} else {
|
||||
shell_exec(APP . 'Console' . DS . 'cake CakeResque.CakeResque startscheduler -i 5 > /dev/null 2>&1 &');
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public function cacheServerInitiator($user, $id = 'all', $jobId = false)
|
||||
{
|
||||
$params = array(
|
||||
|
|
|
|||
Loading…
Reference in New Issue