917 lines
37 KiB
PHP
917 lines
37 KiB
PHP
<?php
|
|
|
|
use Appwrite\ClamAV\Network;
|
|
use Appwrite\Event\Event;
|
|
use Appwrite\Extend\Exception;
|
|
use Appwrite\Utopia\Response;
|
|
use Utopia\App;
|
|
use Utopia\Config\Config;
|
|
use Utopia\Database\Document;
|
|
use Utopia\Domains\Validator\PublicDomain;
|
|
use Utopia\Pools\Group;
|
|
use Utopia\Queue\Client;
|
|
use Utopia\Queue\Connection;
|
|
use Utopia\Registry\Registry;
|
|
use Utopia\Storage\Device;
|
|
use Utopia\Storage\Device\Local;
|
|
use Utopia\Storage\Storage;
|
|
use Utopia\Validator\Domain;
|
|
use Utopia\Validator\Integer;
|
|
use Utopia\Validator\Multiple;
|
|
use Utopia\Validator\Text;
|
|
use Utopia\Validator\WhiteList;
|
|
|
|
App::get('/v1/health')
|
|
->desc('Get HTTP')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'get')
|
|
->label('sdk.description', '/docs/references/health/get.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
|
|
->inject('response')
|
|
->action(function (Response $response) {
|
|
|
|
$output = [
|
|
'name' => 'http',
|
|
'status' => 'pass',
|
|
'ping' => 0
|
|
];
|
|
|
|
$response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
|
|
});
|
|
|
|
App::get('/v1/health/version')
|
|
->desc('Get version')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'public')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_VERSION)
|
|
->inject('response')
|
|
->action(function (Response $response) {
|
|
$response->dynamic(new Document([ 'version' => APP_VERSION_STABLE ]), Response::MODEL_HEALTH_VERSION);
|
|
});
|
|
|
|
App::get('/v1/health/db')
|
|
->desc('Get DB')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getDB')
|
|
->label('sdk.description', '/docs/references/health/get-db.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
|
|
->inject('response')
|
|
->inject('pools')
|
|
->action(function (Response $response, Group $pools) {
|
|
|
|
$output = [];
|
|
|
|
$configs = [
|
|
'Console.DB' => Config::getParam('pools-console'),
|
|
'Projects.DB' => Config::getParam('pools-database'),
|
|
];
|
|
|
|
foreach ($configs as $key => $config) {
|
|
foreach ($config as $database) {
|
|
try {
|
|
$adapter = $pools->get($database)->pop()->getResource();
|
|
|
|
$checkStart = \microtime(true);
|
|
|
|
if ($adapter->ping()) {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'pass',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
} else {
|
|
$failure[] = $database;
|
|
}
|
|
} catch (\Throwable $th) {
|
|
$failure[] = $database;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!empty($failure)) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'DB failure on: ' . implode(", ", $failure));
|
|
}
|
|
|
|
$response->dynamic(new Document([
|
|
'statuses' => $output,
|
|
'total' => count($output),
|
|
]), Response::MODEL_HEALTH_STATUS_LIST);
|
|
});
|
|
|
|
App::get('/v1/health/cache')
|
|
->desc('Get cache')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getCache')
|
|
->label('sdk.description', '/docs/references/health/get-cache.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
|
|
->inject('response')
|
|
->inject('pools')
|
|
->action(function (Response $response, Group $pools) {
|
|
|
|
$output = [];
|
|
|
|
$configs = [
|
|
'Cache' => Config::getParam('pools-cache'),
|
|
];
|
|
|
|
foreach ($configs as $key => $config) {
|
|
foreach ($config as $database) {
|
|
try {
|
|
$adapter = $pools->get($database)->pop()->getResource();
|
|
|
|
$checkStart = \microtime(true);
|
|
|
|
if ($adapter->ping()) {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'pass',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
} else {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'fail',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
}
|
|
} catch (\Throwable $th) {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'fail',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$response->dynamic(new Document([
|
|
'statuses' => $output,
|
|
'total' => count($output),
|
|
]), Response::MODEL_HEALTH_STATUS_LIST);
|
|
});
|
|
|
|
App::get('/v1/health/queue')
|
|
->desc('Get queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueue')
|
|
->label('sdk.description', '/docs/references/health/get-queue.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
|
|
->inject('response')
|
|
->inject('pools')
|
|
->action(function (Response $response, Group $pools) {
|
|
|
|
$output = [];
|
|
|
|
$configs = [
|
|
'Queue' => Config::getParam('pools-queue'),
|
|
];
|
|
|
|
foreach ($configs as $key => $config) {
|
|
foreach ($config as $database) {
|
|
try {
|
|
$adapter = $pools->get($database)->pop()->getResource();
|
|
|
|
$checkStart = \microtime(true);
|
|
|
|
if ($adapter->ping()) {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'pass',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
} else {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'fail',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
}
|
|
} catch (\Throwable $th) {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'fail',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$response->dynamic(new Document([
|
|
'statuses' => $output,
|
|
'total' => count($output),
|
|
]), Response::MODEL_HEALTH_STATUS_LIST);
|
|
});
|
|
|
|
App::get('/v1/health/pubsub')
|
|
->desc('Get pubsub')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getPubSub')
|
|
->label('sdk.description', '/docs/references/health/get-pubsub.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
|
|
->inject('response')
|
|
->inject('pools')
|
|
->action(function (Response $response, Group $pools) {
|
|
|
|
$output = [];
|
|
|
|
$configs = [
|
|
'PubSub' => Config::getParam('pools-pubsub'),
|
|
];
|
|
|
|
foreach ($configs as $key => $config) {
|
|
foreach ($config as $database) {
|
|
try {
|
|
$adapter = $pools->get($database)->pop()->getResource();
|
|
|
|
$checkStart = \microtime(true);
|
|
|
|
if ($adapter->ping()) {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'pass',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
} else {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'fail',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
}
|
|
} catch (\Throwable $th) {
|
|
$output[] = new Document([
|
|
'name' => $key . " ($database)",
|
|
'status' => 'fail',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
]);
|
|
}
|
|
}
|
|
}
|
|
|
|
$response->dynamic(new Document([
|
|
'statuses' => $output,
|
|
'total' => count($output),
|
|
]), Response::MODEL_HEALTH_STATUS_LIST);
|
|
});
|
|
|
|
App::get('/v1/health/time')
|
|
->desc('Get time')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getTime')
|
|
->label('sdk.description', '/docs/references/health/get-time.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_TIME)
|
|
->inject('response')
|
|
->action(function (Response $response) {
|
|
|
|
/*
|
|
* Code from: @see https://www.beliefmedia.com.au/query-ntp-time-server
|
|
*/
|
|
$host = 'time.google.com'; // https://developers.google.com/time/
|
|
$gap = 60; // Allow [X] seconds gap
|
|
|
|
/* Create a socket and connect to NTP server */
|
|
$sock = \socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
|
|
|
|
\socket_connect($sock, $host, 123);
|
|
|
|
/* Send request */
|
|
$msg = "\010" . \str_repeat("\0", 47);
|
|
|
|
\socket_send($sock, $msg, \strlen($msg), 0);
|
|
|
|
/* Receive response and close socket */
|
|
\socket_recv($sock, $recv, 48, MSG_WAITALL);
|
|
\socket_close($sock);
|
|
|
|
/* Interpret response */
|
|
$data = \unpack('N12', $recv);
|
|
$timestamp = \sprintf('%u', $data[9]);
|
|
|
|
/* NTP is number of seconds since 0000 UT on 1 January 1900
|
|
Unix time is seconds since 0000 UT on 1 January 1970 */
|
|
$timestamp -= 2208988800;
|
|
|
|
$diff = ($timestamp - \time());
|
|
|
|
if ($diff > $gap || $diff < ($gap * -1)) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Server time gaps detected');
|
|
}
|
|
|
|
$output = [
|
|
'remoteTime' => $timestamp,
|
|
'localTime' => \time(),
|
|
'diff' => $diff
|
|
];
|
|
|
|
$response->dynamic(new Document($output), Response::MODEL_HEALTH_TIME);
|
|
});
|
|
|
|
App::get('/v1/health/queue/webhooks')
|
|
->desc('Get webhooks queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueWebhooks')
|
|
->label('sdk.description', '/docs/references/health/get-queue-webhooks.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::WEBHOOK_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/logs')
|
|
->desc('Get logs queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueLogs')
|
|
->label('sdk.description', '/docs/references/health/get-queue-logs.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::AUDITS_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/certificate')
|
|
->desc('Get the SSL certificate for a domain')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getCertificate')
|
|
->label('sdk.description', '/docs/references/health/get-certificate.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_CERTIFICATE)
|
|
->param('domain', null, new Multiple([new Domain(), new PublicDomain()]), Multiple::TYPE_STRING, 'Domain name')
|
|
->inject('response')
|
|
->action(function (string $domain, Response $response) {
|
|
if (filter_var($domain, FILTER_VALIDATE_URL)) {
|
|
$domain = parse_url($domain, PHP_URL_HOST);
|
|
}
|
|
|
|
$sslContext = stream_context_create([
|
|
"ssl" => [
|
|
"capture_peer_cert" => true
|
|
]
|
|
]);
|
|
$sslSocket = stream_socket_client("ssl://" . $domain . ":443", $errno, $errstr, 30, STREAM_CLIENT_CONNECT, $sslContext);
|
|
if (!$sslSocket) {
|
|
throw new Exception(Exception::HEALTH_INVALID_HOST);
|
|
}
|
|
|
|
$streamContextParams = stream_context_get_params($sslSocket);
|
|
$peerCertificate = $streamContextParams['options']['ssl']['peer_certificate'];
|
|
$certificatePayload = openssl_x509_parse($peerCertificate);
|
|
|
|
|
|
$sslExpiration = $certificatePayload['validTo_time_t'];
|
|
$status = $sslExpiration < time() ? 'fail' : 'pass';
|
|
|
|
if ($status === 'fail') {
|
|
throw new Exception(Exception::HEALTH_CERTIFICATE_EXPIRED);
|
|
}
|
|
|
|
$response->dynamic(new Document([
|
|
'name' => $certificatePayload['name'],
|
|
'subjectSN' => $certificatePayload['subject']['CN'],
|
|
'issuerOrganisation' => $certificatePayload['issuer']['O'],
|
|
'validFrom' => $certificatePayload['validFrom_time_t'],
|
|
'validTo' => $certificatePayload['validTo_time_t'],
|
|
'signatureTypeSN' => $certificatePayload['signatureTypeSN'],
|
|
]), Response::MODEL_HEALTH_CERTIFICATE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/certificates')
|
|
->desc('Get certificates queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueCertificates')
|
|
->label('sdk.description', '/docs/references/health/get-queue-certificates.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::CERTIFICATES_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/builds')
|
|
->desc('Get builds queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueBuilds')
|
|
->label('sdk.description', '/docs/references/health/get-queue-builds.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::BUILDS_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/databases')
|
|
->desc('Get databases queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueDatabases')
|
|
->label('sdk.description', '/docs/references/health/get-queue-databases.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('name', 'database_db_main', new Text(256), 'Queue name for which to check the queue size', true)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (string $name, int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client($name, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/deletes')
|
|
->desc('Get deletes queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueDeletes')
|
|
->label('sdk.description', '/docs/references/health/get-queue-deletes.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::DELETE_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/mails')
|
|
->desc('Get mails queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueMails')
|
|
->label('sdk.description', '/docs/references/health/get-queue-mails.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::MAILS_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/messaging')
|
|
->desc('Get messaging queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueMessaging')
|
|
->label('sdk.description', '/docs/references/health/get-queue-messaging.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::MESSAGING_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/migrations')
|
|
->desc('Get migrations queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueMigrations')
|
|
->label('sdk.description', '/docs/references/health/get-queue-migrations.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::MIGRATIONS_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/functions')
|
|
->desc('Get functions queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueFunctions')
|
|
->label('sdk.description', '/docs/references/health/get-queue-functions.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::FUNCTIONS_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
}, ['response']);
|
|
|
|
App::get('/v1/health/queue/usage')
|
|
->desc('Get usage queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueUsage')
|
|
->label('sdk.description', '/docs/references/health/get-queue-usage.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::USAGE_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
});
|
|
|
|
App::get('/v1/health/queue/usage-dump')
|
|
->desc('Get usage dump queue')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getQueueUsage')
|
|
->label('sdk.description', '/docs/references/health/get-queue-usage-dump.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->inject('queue')
|
|
->inject('response')
|
|
->action(function (int|string $threshold, Connection $queue, Response $response) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client(Event::USAGE_DUMP_QUEUE_NAME, $queue);
|
|
$size = $client->getQueueSize();
|
|
|
|
if ($size >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue size threshold hit. Current size is {$size} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $size ]), Response::MODEL_HEALTH_QUEUE);
|
|
});
|
|
|
|
App::get('/v1/health/storage/local')
|
|
->desc('Get local storage')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getStorageLocal')
|
|
->label('sdk.description', '/docs/references/health/get-storage-local.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
|
|
->inject('response')
|
|
->action(function (Response $response) {
|
|
|
|
$checkStart = \microtime(true);
|
|
|
|
foreach (
|
|
[
|
|
'Uploads' => APP_STORAGE_UPLOADS,
|
|
'Cache' => APP_STORAGE_CACHE,
|
|
'Config' => APP_STORAGE_CONFIG,
|
|
'Certs' => APP_STORAGE_CERTIFICATES
|
|
] as $key => $volume
|
|
) {
|
|
$device = new Local($volume);
|
|
|
|
if (!\is_readable($device->getRoot())) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Device ' . $key . ' dir is not readable');
|
|
}
|
|
|
|
if (!\is_writable($device->getRoot())) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Device ' . $key . ' dir is not writable');
|
|
}
|
|
}
|
|
|
|
$output = [
|
|
'status' => 'pass',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
];
|
|
|
|
$response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
|
|
});
|
|
|
|
App::get('/v1/health/storage')
|
|
->desc('Get storage')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getStorage')
|
|
->label('sdk.description', '/docs/references/health/get-storage.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_STATUS)
|
|
->inject('response')
|
|
->inject('deviceForFiles')
|
|
->inject('deviceForFunctions')
|
|
->inject('deviceForBuilds')
|
|
->action(function (Response $response, Device $deviceForFiles, Device $deviceForFunctions, Device $deviceForBuilds) {
|
|
$devices = [$deviceForFiles, $deviceForFunctions, $deviceForBuilds];
|
|
$checkStart = \microtime(true);
|
|
|
|
foreach ($devices as $device) {
|
|
if (!$device->write($device->getPath('health.txt'), 'test', 'text/plain')) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed writing test file to ' . $device->getRoot());
|
|
}
|
|
|
|
if ($device->read($device->getPath('health.txt')) !== 'test') {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed reading test file from ' . $device->getRoot());
|
|
}
|
|
|
|
if (!$device->delete($device->getPath('health.txt'))) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed deleting test file from ' . $device->getRoot());
|
|
}
|
|
}
|
|
|
|
$output = [
|
|
'status' => 'pass',
|
|
'ping' => \round((\microtime(true) - $checkStart) / 1000)
|
|
];
|
|
|
|
$response->dynamic(new Document($output), Response::MODEL_HEALTH_STATUS);
|
|
});
|
|
|
|
App::get('/v1/health/anti-virus')
|
|
->desc('Get antivirus')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getAntivirus')
|
|
->label('sdk.description', '/docs/references/health/get-storage-anti-virus.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_ANTIVIRUS)
|
|
->inject('response')
|
|
->action(function (Response $response) {
|
|
|
|
$output = [
|
|
'status' => '',
|
|
'version' => ''
|
|
];
|
|
|
|
if (App::getEnv('_APP_STORAGE_ANTIVIRUS') === 'disabled') { // Check if scans are enabled
|
|
$output['status'] = 'disabled';
|
|
$output['version'] = '';
|
|
} else {
|
|
$antivirus = new Network(
|
|
App::getEnv('_APP_STORAGE_ANTIVIRUS_HOST', 'clamav'),
|
|
(int) App::getEnv('_APP_STORAGE_ANTIVIRUS_PORT', 3310)
|
|
);
|
|
|
|
try {
|
|
$output['version'] = @$antivirus->version();
|
|
$output['status'] = (@$antivirus->ping()) ? 'pass' : 'fail';
|
|
} catch (\Throwable $e) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Antivirus is not available');
|
|
}
|
|
}
|
|
|
|
$response->dynamic(new Document($output), Response::MODEL_HEALTH_ANTIVIRUS);
|
|
});
|
|
|
|
App::get('/v1/health/queue/failed/:name')
|
|
->desc('Get number of failed queue jobs')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'health.read')
|
|
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
->label('sdk.namespace', 'health')
|
|
->label('sdk.method', 'getFailedJobs')
|
|
->param('name', '', new WhiteList([
|
|
Event::DATABASE_QUEUE_NAME,
|
|
Event::DELETE_QUEUE_NAME,
|
|
Event::AUDITS_QUEUE_NAME,
|
|
Event::MAILS_QUEUE_NAME,
|
|
Event::FUNCTIONS_QUEUE_NAME,
|
|
Event::USAGE_QUEUE_NAME,
|
|
Event::USAGE_DUMP_QUEUE_NAME,
|
|
Event::WEBHOOK_CLASS_NAME,
|
|
Event::CERTIFICATES_QUEUE_NAME,
|
|
Event::BUILDS_QUEUE_NAME,
|
|
Event::MESSAGING_QUEUE_NAME,
|
|
Event::MIGRATIONS_QUEUE_NAME,
|
|
Event::HAMSTER_CLASS_NAME
|
|
]), 'The name of the queue')
|
|
->param('threshold', 5000, new Integer(true), 'Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.', true)
|
|
->label('sdk.description', '/docs/references/health/get-failed-queue-jobs.md')
|
|
->label('sdk.response.code', Response::STATUS_CODE_OK)
|
|
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
|
|
->label('sdk.response.model', Response::MODEL_HEALTH_QUEUE)
|
|
->inject('response')
|
|
->inject('queue')
|
|
->action(function (string $name, int|string $threshold, Response $response, Connection $queue) {
|
|
$threshold = \intval($threshold);
|
|
|
|
$client = new Client($name, $queue);
|
|
$failed = $client->countFailedJobs();
|
|
|
|
if ($failed >= $threshold) {
|
|
throw new Exception(Exception::HEALTH_QUEUE_SIZE_EXCEEDED, "Queue failed jobs threshold hit. Current size is {$failed} and threshold is {$threshold}.");
|
|
}
|
|
|
|
$response->dynamic(new Document([ 'size' => $failed ]), Response::MODEL_HEALTH_QUEUE);
|
|
});
|
|
|
|
App::get('/v1/health/stats') // Currently only used internally
|
|
->desc('Get system stats')
|
|
->groups(['api', 'health'])
|
|
->label('scope', 'root')
|
|
// ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
|
|
// ->label('sdk.namespace', 'health')
|
|
// ->label('sdk.method', 'getStats')
|
|
->label('docs', false)
|
|
->inject('response')
|
|
->inject('register')
|
|
->inject('deviceForFiles')
|
|
->action(function (Response $response, Registry $register, Device $deviceForFiles) {
|
|
|
|
$cache = $register->get('cache');
|
|
|
|
$cacheStats = $cache->info();
|
|
|
|
$response
|
|
->json([
|
|
'storage' => [
|
|
'used' => Storage::human($deviceForFiles->getDirectorySize($deviceForFiles->getRoot() . '/')),
|
|
'partitionTotal' => Storage::human($deviceForFiles->getPartitionTotalSpace()),
|
|
'partitionFree' => Storage::human($deviceForFiles->getPartitionFreeSpace()),
|
|
],
|
|
'cache' => [
|
|
'uptime' => $cacheStats['uptime_in_seconds'] ?? 0,
|
|
'clients' => $cacheStats['connected_clients'] ?? 0,
|
|
'hits' => $cacheStats['keyspace_hits'] ?? 0,
|
|
'misses' => $cacheStats['keyspace_misses'] ?? 0,
|
|
'memory_used' => $cacheStats['used_memory'] ?? 0,
|
|
'memory_used_human' => $cacheStats['used_memory_human'] ?? 0,
|
|
'memory_used_peak' => $cacheStats['used_memory_peak'] ?? 0,
|
|
'memory_used_peak_human' => $cacheStats['used_memory_peak_human'] ?? 0,
|
|
],
|
|
]);
|
|
});
|