utopia-php / logger
Utopia Logger library is simple and lite library for logging information, such as errors or warnings. This library is aiming to be as simple and easy to learn and use.
Installs: 61 214
Dependents: 2
Suggesters: 0
Security: 0
Stars: 9
Watchers: 6
Forks: 17
Open Issues: 10
Requires
- php: >=8.0
Requires (Dev)
- laravel/pint: 1.2.*
- phpstan/phpstan: 1.9.x-dev
- phpunit/phpunit: ^9.3
- vimeo/psalm: 4.0.1
- dev-main
- 0.6.2
- 0.6.1
- 0.6.0
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.0
- 0.3.x-dev
- 0.3.2
- 0.3.1
- 0.3.0
- 0.2.0
- 0.1.0
- dev-feat-mask-fields
- dev-chore-remove-expectException
- dev-feat-tests-on-github
- dev-tmp-logs
- dev-fix-sentry-warning
- dev-fix-sentry-constructor
- dev-fix-warning
- dev-feat-introduce-linter-job
- dev-doc-update-contributing
- dev-feat-logowl-adapter
- dev-fix-build-badge
- dev-dev
This package is auto-updated.
Last update: 2024-10-14 16:16:22 UTC
README
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.
Getting Started
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\Adapter\LogOwl; 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("[YOUR_SENTRY_DSN]"); $logger = new Logger($adapter); $logger->addLog($log); // AppSignal $adapter = new AppSignal("[YOUR_APPSIGNAL_KEY]"); $logger = new Logger($adapter); $logger->addLog($log); // Raygun $adapter = new Raygun("[YOUR_RAYGUN_KEY]"); $logger = new Logger($adapter); $logger->addLog($log); // Log Owl $adapter = new LogOwl("[YOUR_SERVICE_TICKET]"); $logger = new Logger($adapter); $logger->addLog($log);
Adapters
Below is a list of supported adapters, and thier compatibly tested versions alongside a list of supported features and relevant limits.
✅ - supported, 🛠 - work in progress
Tests
If you need to install dependencies, run:
docker run --rm --interactive --tty \
--volume $PWD:/app \
composer update --ignore-platform-reqs --optimize-autoloader --no-plugins --no-scripts --prefer-dist
To run all unit tests, prepare the .env
file using .env.example
as a template. Then, run:
docker run --rm --interactive --tty --env-file .env \ --volume $PWD:/app \ composer test
Make sure to replace
TEST_SENTRY_DSN
with actual keys from Sentry.
Make sure to replace
TEST_APPSIGNAL_KEY
with key found in Appsignal -> Project -> App Settings -> Push & deploy -> Push Key
Make sure to replace
TEST_RAYGUN_KEY
with key found in Raygun -> Project -> Application Settings -> Api Key
To run static code analysis, use the following Psalm command:
docker run --rm --interactive --tty \
--volume $PWD:/app \
composer check
System Requirements
Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
Copyright and license
The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php