1
0
Fork 0
mirror of synced 2024-05-20 12:42:39 +12:00

Code review updates

This commit is contained in:
Matej Baco 2021-11-24 10:38:32 +01:00
parent 56402c78fe
commit 49e9baf383
19 changed files with 45 additions and 76 deletions

3
.env
View file

@ -44,5 +44,4 @@ _APP_MAINTENANCE_RETENTION_ABUSE=86400
_APP_MAINTENANCE_RETENTION_AUDIT=1209600
_APP_USAGE_STATS=enabled
_APP_LOGGING_PROVIDER=sentry
_APP_LOGGING_CONFIG=9a4ebfef5ab14c8483366039b9de2835;6076895
_APP_LOGGING_SERVERNAME=selfhosted-001
_APP_LOGGING_CONFIG=9a4ebfef5ab14c8483366039b9de2835;6076895

View file

@ -160,8 +160,7 @@ ENV _APP_SERVER=swoole \
_APP_MAINTENANCE_RETENTION_ABUSE=86400 \
_APP_MAINTENANCE_INTERVAL=86400 \
_APP_LOGGING_PROVIDER= \
_APP_LOGGING_CONFIG= \
_APP_LOGGING_SERVERNAME=selfhosted-001
_APP_LOGGING_CONFIG=
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

View file

@ -167,15 +167,6 @@ return [
'required' => false,
'question' => '',
'filter' => ''
],
[
'name' => '_APP_LOGGING_SERVERNAME',
'description' => 'This variable configures name of the server in error logging for identification reasons in scaled solution.',
'introduction' => '0.12.0',
'default' => 'selfhosted-001',
'required' => false,
'question' => '',
'filter' => ''
]
],
],

View file

@ -115,7 +115,7 @@ App::post('/v1/storage/files')
$iv = OpenSSL::randomPseudoBytes(OpenSSL::cipherIVLength(OpenSSL::CIPHER_AES_128_GCM));
$data = OpenSSL::encrypt($data, OpenSSL::CIPHER_AES_128_GCM, $key, 0, $iv, $tag);
if (!$device->write($path . "/rewerwerwerw.asdas", $data, $mimeType)) {
if (!$device->write($path, $data, $mimeType)) {
throw new Exception('Failed to save file', 500);
}

View file

@ -291,7 +291,7 @@ App::options(function ($request, $response) {
->noContent();
}, ['request', 'response']);
App::error(function ($error, $utopia, $request, $response, $layout, $project, $logger, $user, $loggerBreadcrumb) {
App::error(function ($error, $utopia, $request, $response, $layout, $project, $logger, $user, $loggerBreadcrumbs) {
/** @var Exception $error */
/** @var Utopia\App $utopia */
/** @var Utopia\Swoole\Request $request */
@ -312,7 +312,7 @@ App::error(function ($error, $utopia, $request, $response, $layout, $project, $l
}
$log->setNamespace("http");
$log->setServer(App::getEnv("_APP_LOGGING_SERVERNAME", "selfhosted-001"));
$log->setServer(\gethostname());
$log->setVersion($version);
$log->setType(Log::TYPE_ERROR);
$log->setMessage($error->getMessage());
@ -327,12 +327,10 @@ App::error(function ($error, $utopia, $request, $response, $layout, $project, $l
'locale' => (string)$request->getParam('locale', $request->getHeader('x-appwrite-locale', '')),
]);
$log->setExtra([
'file' => $error->getFile(),
'line' => $error->getLine(),
'trace' => $error->getTraceAsString(),
'roles' => Authorization::$roles
]);
$log->addExtra('file', $error->getFile());
$log->addExtra('line', $error->getLine());
$log->addExtra('trace', $error->getTraceAsString());
$log->addExtra('roles', Authorization::$roles);
$action = $route->getLabel("sdk.namespace", "UNKNOWN_NAMESPACE") . '.' . $route->getLabel("sdk.method", "UNKNOWN_METHOD");
$log->setAction($action);
@ -340,7 +338,9 @@ App::error(function ($error, $utopia, $request, $response, $layout, $project, $l
$isProduction = App::getEnv('_APP_ENV', 'development') === 'production';
$log->setEnvironment($isProduction ? Log::ENVIRONMENT_PRODUCTION : Log::ENVIRONMENT_STAGING);
$log->setBreadcrumbs($loggerBreadcrumb);
foreach($loggerBreadcrumbs as $loggerBreadcrumb) {
$log->addBreadcrumb($loggerBreadcrumb);
}
$responseCode = $logger->addLog($log);
Console::info('Log pushed with status code: '.$responseCode);
@ -431,7 +431,7 @@ App::error(function ($error, $utopia, $request, $response, $layout, $project, $l
$response->dynamic(new Document($output),
$utopia->isDevelopment() ? Response::MODEL_ERROR_DEV : Response::MODEL_ERROR);
}, ['error', 'utopia', 'request', 'response', 'layout', 'project', 'logger', 'user', 'loggerBreadcrumb']);
}, ['error', 'utopia', 'request', 'response', 'layout', 'project', 'logger', 'user', 'loggerBreadcrumbs']);
App::get('/manifest.json')
->desc('Progressive app manifest file')

View file

@ -174,7 +174,6 @@ $register->set('logger', function () { // Register error logger
if(!Logger::hasProvider($providerName)) {
throw new Exception("Logging provider not supported. Logging disabled.");
return;
}
$classname = '\\Utopia\\Logger\\Adapter\\'.\ucfirst($providerName);
@ -366,7 +365,7 @@ App::setResource('logger', function($register) {
return $register->get('logger');
}, ['register']);
App::setResource('loggerBreadcrumb', function() {
App::setResource('loggerBreadcrumbs', function() {
return [];
});

View file

@ -35,7 +35,7 @@ function logError($register, \Throwable $error, $action) {
$log = new Log();
$log->setNamespace("realtime");
$log->setServer(App::getEnv("_APP_LOGGING_SERVERNAME", "selfhosted-001"));
$log->setServer(\gethostname());
$log->setVersion($version);
$log->setType(Log::TYPE_ERROR);
$log->setMessage($error->getMessage());
@ -45,11 +45,9 @@ function logError($register, \Throwable $error, $action) {
'verbose_type' => get_class($error),
]);
$log->setExtra([
'file' => $error->getFile(),
'line' => $error->getLine(),
'trace' => $error->getTraceAsString(),
]);
$log->addExtra('file', $error->getFile());
$log->addExtra('line', $error->getLine());
$log->addExtra('trace', $error->getTraceAsString());
$log->setAction($action);

View file

@ -108,7 +108,6 @@ services:
- _APP_FUNCTIONS_RUNTIMES
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-realtime:
image: <?php echo $organization; ?>/<?php echo $image; ?>:<?php echo $version."\n"; ?>

View file

@ -12,7 +12,7 @@ Console::success(APP_NAME . ' audits worker v1 has started');
class AuditsV1 extends Worker
{
public function getWorkerName(): string {
public function getName(): string {
return "audits";
}

View file

@ -18,7 +18,7 @@ Console::success(APP_NAME . ' certificates worker v1 has started');
class CertificatesV1 extends Worker
{
public function getWorkerName(): string {
public function getName(): string {
return "certificates";
}

View file

@ -23,7 +23,7 @@ class DeletesV1 extends Worker
{
protected Database $consoleDB;
public function getWorkerName(): string {
public function getName(): string {
return "deletes";
}

View file

@ -101,7 +101,7 @@ class FunctionsV1 extends Worker
public array $allowed = [];
public function getWorkerName(): string {
public function getName(): string {
return "functions";
}

View file

@ -13,7 +13,7 @@ Console::success(APP_NAME . ' mails worker v1 has started' . "\n");
class MailsV1 extends Worker
{
public function getWorkerName(): string {
public function getName(): string {
return "mails";
}

View file

@ -17,7 +17,7 @@ Console::success(APP_NAME . ' tasks worker v1 has started');
class TasksV1 extends Worker
{
public function getWorkerName(): string {
public function getName(): string {
return "tasks";
}

View file

@ -11,7 +11,7 @@ Console::success(APP_NAME . ' usage worker v1 has started');
class UsageV1 extends Worker
{
public function getWorkerName(): string {
public function getName(): string {
return "usage";
}

View file

@ -11,7 +11,7 @@ Console::success(APP_NAME . ' webhooks worker v1 has started');
class WebhooksV1 extends Worker
{
public function getWorkerName(): string {
public function getName(): string {
return "webhooks";
}

4
composer.lock generated
View file

@ -2066,7 +2066,7 @@
"source": {
"type": "git",
"url": "https://github.com/utopia-php/logger",
"reference": "11f94f7f1ac2df226094271be3f2736fe26d8eec"
"reference": "5d8cc1bbbfc738ae28ede0d438a1d5318011cf6a"
},
"require": {
"php": ">=7.4"
@ -2113,7 +2113,7 @@
"utopia",
"warnings"
],
"time": "2021-11-23T12:13:29+00:00"
"time": "2021-11-24T09:10:10+00:00"
},
{
"name": "utopia-php/orchestration",

View file

@ -131,7 +131,6 @@ services:
- _APP_FUNCTIONS_RUNTIMES
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-realtime:
entrypoint: realtime
@ -178,7 +177,6 @@ services:
- _APP_USAGE_STATS
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-usage:
entrypoint: worker-usage
@ -203,7 +201,6 @@ services:
- _APP_STATSD_PORT
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-audits:
entrypoint: worker-audits
@ -231,7 +228,6 @@ services:
- _APP_DB_PASS
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-webhooks:
entrypoint: worker-webhooks
@ -256,7 +252,6 @@ services:
- _APP_REDIS_PASS
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-tasks:
entrypoint: worker-tasks
@ -286,7 +281,6 @@ services:
- _APP_DB_PASS
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-deletes:
entrypoint: worker-deletes
@ -318,7 +312,6 @@ services:
- _APP_DB_PASS
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-certificates:
entrypoint: worker-certificates
@ -349,7 +342,6 @@ services:
- _APP_DB_PASS
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-functions:
entrypoint: worker-functions
@ -391,7 +383,6 @@ services:
- DOCKERHUB_PULL_PASSWORD
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-worker-mails:
entrypoint: worker-mails
@ -422,7 +413,6 @@ services:
- _APP_SMTP_PASSWORD
- _APP_LOGGING_PROVIDER
- _APP_LOGGING_CONFIG
- _APP_LOGGING_SERVERNAME
appwrite-maintenance:
entrypoint: maintenance

View file

@ -11,7 +11,7 @@ abstract class Worker
{
public array $args = [];
abstract public function getWorkerName(): string;
abstract public function getName(): string;
abstract public function init(): void;
@ -28,12 +28,12 @@ abstract class Worker
$logger = $register->get('logger');
$version = App::getEnv('_APP_VERSION', 'UNKNOWN');
$workerType = $this->getWorkerName();
$workerType = $this->getName();
$log = new Log();
$log->setNamespace("worker-" . $workerType);
$log->setServer(App::getEnv("_APP_LOGGING_SERVERNAME", "selfhosted-001"));
$log->setServer(\gethostname());
$log->setVersion($version);
$log->setType(Log::TYPE_ERROR);
$log->setMessage($error->getMessage());
@ -44,12 +44,10 @@ abstract class Worker
'verbose_type' => get_class($error),
]);
$log->setExtra([
'file' => $error->getFile(),
'line' => $error->getLine(),
'trace' => $error->getTraceAsString(),
'args' => $this->args
]);
$log->addExtra('file', $error->getFile());
$log->addExtra('line', $error->getLine());
$log->addExtra('trace', $error->getTraceAsString());
$log->addExtra('args', $this->args);
$action = 'worker.' . $workerType . '.setUp';
$log->setAction($action);
@ -74,12 +72,12 @@ abstract class Worker
global $register;
$logger = $register->get('logger');
$version = App::getEnv('_APP_VERSION', 'UNKNOWN');
$workerType = $this->getWorkerName();
$workerType = $this->getName();
$log = new Log();
$log->setNamespace("worker-" . $workerType);
$log->setServer(App::getEnv("_APP_LOGGING_SERVERNAME", "selfhosted-001"));
$log->setServer(\gethostname());
$log->setVersion($version);
$log->setType(Log::TYPE_ERROR);
$log->setMessage($error->getMessage());
@ -90,11 +88,9 @@ abstract class Worker
'verbose_type' => get_class($error),
]);
$log->setExtra([
'file' => $error->getFile(),
'line' => $error->getLine(),
'trace' => $error->getTraceAsString()
]);
$log->addExtra('file', $error->getFile());
$log->addExtra('line', $error->getLine());
$log->addExtra('trace', $error->getTraceAsString());
$action = 'worker.' . $workerType . '.perform';
$log->setAction($action);
@ -119,12 +115,12 @@ abstract class Worker
global $register;
$logger = $register->get('logger');
$version = App::getEnv('_APP_VERSION', 'UNKNOWN');
$workerType = $this->getWorkerName();
$workerType = $this->getName();
$log = new Log();
$log->setNamespace("worker-" . $workerType);
$log->setServer(App::getEnv("_APP_LOGGING_SERVERNAME", "selfhosted-001"));
$log->setServer(\gethostname());
$log->setVersion($version);
$log->setType(Log::TYPE_ERROR);
$log->setMessage($error->getMessage());
@ -135,11 +131,9 @@ abstract class Worker
'verbose_type' => get_class($error),
]);
$log->setExtra([
'file' => $error->getFile(),
'line' => $error->getLine(),
'trace' => $error->getTraceAsString()
]);
$log->addExtra('file', $error->getFile());
$log->addExtra('line', $error->getLine());
$log->addExtra('trace', $error->getTraceAsString());
$action = 'worker.' . $workerType . '.tearDown';
$log->setAction($action);