Utopia Logger library is simple and lite library for logging information, such as errors or warnings. This library aims to be as simple and easy to learn and use as possible. This library is maintained by the Appwrite team.
Although the library was built for the Utopia Framework project, it is completely independent, dependency-free and can be used with any other PHP project or framework.
Install using composer:
composer require utopia-php/logger<?php
require_once '../vendor/autoload.php';
use Utopia\Logger\Adapter\AppSignal;
use Utopia\Logger\Adapter\Raygun;
use Utopia\Logger\Adapter\Sentry;
use Utopia\Logger\Log;
use Utopia\Logger\Log\Breadcrumb;
use Utopia\Logger\Log\User;
use Utopia\Logger\Logger;
// Prepare log
$log = new Log();
$log->setAction("controller.database.deleteDocument");
$log->setEnvironment("production");
$log->setNamespace("api");
$log->setServer("digitalocean-us-001");
$log->setType(Log::TYPE_WARNING);
$log->setVersion("0.11.5");
$log->setMessage("Document efgh5678 not found");
$log->setUser(new User("efgh5678"));
$log->addBreadcrumb(new Breadcrumb(Log::TYPE_DEBUG, "http", "DELETE /api/v1/database/abcd1234/efgh5678", \microtime(true) - 500));
$log->addBreadcrumb(new Breadcrumb(Log::TYPE_DEBUG, "auth", "Using API key", \microtime(true) - 400));
$log->addBreadcrumb(new Breadcrumb(Log::TYPE_INFO, "auth", "Authenticated with * Using API Key", \microtime(true) - 350));
$log->addBreadcrumb(new Breadcrumb(Log::TYPE_INFO, "database", "Found collection abcd1234", \microtime(true) - 300));
$log->addBreadcrumb(new Breadcrumb(Log::TYPE_DEBUG, "database", "Permission for collection abcd1234 met", \microtime(true) - 200));
$log->addBreadcrumb(new Breadcrumb(Log::TYPE_ERROR, "database", "Missing document when searching by ID!", \microtime(true)));
$log->addTag('sdk', 'Flutter');
$log->addTag('sdkVersion', '0.0.1');
$log->addTag('authMode', 'default');
$log->addTag('authMethod', 'cookie');
$log->addTag('authProvider', 'MagicLink');
$log->addExtra('urgent', false);
$log->addExtra('isExpected', true);
// Sentry
$adapter = new Sentry(\getenv("[YOUR_SENTRY_KEY]"), \getenv("[YOUR_SENTRY_PROJECT_ID]"));
$logger = new Logger($adapter);
$logger->addLog($log);
// AppSignal
$adapter = new AppSignal(\getenv("[YOUR_APPSIGNAL_KEY]"));
$logger = new Logger($adapter);
$logger->addLog($log);
// Raygun
$adapter = new Raygun(\getenv("[YOUR_RAYGUN_KEY]"));
$logger = new Logger($adapter);
$logger->addLog($log);Below is a list of supported adapters, and thier compatibly tested versions alongside a list of supported features and relevant limits.
| Adapter | Status |
|---|---|
| Sentry | ✅ |
| AppSignal | ✅ |
| Raygun | ✅ |
✅ - supported, 🛠 - work in progress
To run all unit tests, use the following Docker command:
docker run --rm -e TEST_RAYGUN_KEY=KKKK -e TEST_APPSIGNAL_KEY=XXXX -e TEST_SENTRY_KEY=YYYY -e TEST_SENTRY_PROJECT_ID=ZZZZ -v $(pwd):$(pwd):rw -w $(pwd) php:8.0-cli-alpine sh -c "vendor/bin/phpunit --configuration phpunit.xml tests"Make sure to replace
TEST_SENTRY_KEYandTEST_SENTRY_PROJECT_IDenvironment variables value with actual keys from Sentry. If your Sentry DSN ishttps://[email protected]/anything, thenTEST_SENTRY_KEY=somethingandTEST_SENTRY_PROJECT_ID=anything. OptionallyTEST_SENTRY_HOSTcan be added to specify a self-hosted Sentry instance.
Make sure to replace
TEST_APPSIGNAL_KEYwith key found in Appsignal -> Project -> App Settings -> Push & deploy -> Push Key
Make sure to replace
TEST_RAYGUN_KEYwith key found in Raygun -> Project -> Application Settings -> Api Key
To run static code analysis, use the following Psalm command:
docker run --rm -v $(pwd):$(pwd):rw -w $(pwd) php:8.0-cli-alpine sh -c "vendor/bin/psalm --show-info=true"Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
Eldad Fux
Matej Bačo
Christy Jacob
The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php