appwrite/app/init/span.php

<?php

use Appwrite\Extend\Exception;
use Utopia\Console;
use Utopia\DSN\DSN;
use Utopia\Span\Exporter;
use Utopia\Span\Exporter\SentryField;
use Utopia\Span\Span;
use Utopia\Span\Storage;
use Utopia\System\System;

Span::setStorage(new Storage\Coroutine());

$loggingConfig = System::getEnv('_APP_LOGGING_CONFIG', '');
$legacyLoggingProvider = System::getEnv('_APP_LOGGING_PROVIDER', '');
$legacyRealtimeLoggingConfig = System::getEnv('_APP_LOGGING_CONFIG_REALTIME', '');

if (!empty($legacyLoggingProvider)) {
    Console::warning('_APP_LOGGING_PROVIDER is no longer supported. Set _APP_LOGGING_CONFIG to a provider DSN.');
}

if (!empty($legacyRealtimeLoggingConfig)) {
    Console::warning('_APP_LOGGING_CONFIG_REALTIME is no longer supported. Realtime errors use _APP_LOGGING_CONFIG.');
}

if (!empty($loggingConfig) && \str_contains($loggingConfig, ';')) {
    Console::warning('Legacy semicolon-delimited _APP_LOGGING_CONFIG values are no longer supported. Set _APP_LOGGING_CONFIG to a provider DSN.');
}

$addSentryExporter = function (string $loggingConfig, ?callable $sampler = null): void {
    try {
        $loggingProvider = new DSN($loggingConfig);
        $providerName = $loggingProvider->getScheme();

        if ($providerName !== 'sentry') {
            throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Logging provider not supported. Logging is disabled');
        }

        $projectId = $loggingProvider->getUser();
        $apiKey = $loggingProvider->getPassword();
        $host = $loggingProvider->getHost();

        if (empty($projectId) || empty($apiKey) || empty($host)) {
            throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Invalid Sentry DSN. Logging is disabled');
        }

        $dsn = 'https://' . $apiKey . '@' . $host . '/' . $projectId;

        Span::addExporter(
            new Exporter\Sentry(
                dsn: $dsn,
                environment: System::getEnv('_APP_ENV', 'development') === 'production' ? 'production' : 'staging',
                release: System::getEnv('_APP_VERSION', 'UNKNOWN'),
                serverName: System::getEnv('_APP_LOGGING_SERVICE_IDENTIFIER', \gethostname()),
                classifier: fn (string $key): SentryField => match ($key) {
                    'appwrite.error.action',
                    'appwrite.error.publish',
                    'code',
                    'database',
                    'dnsDomain',
                    'embeddingModel',
                    'error.code',
                    'hostname',
                    'locale',
                    'method',
                    'projectId',
                    'service',
                    'type',
                    'url',
                    'userId',
                    'verboseType' => SentryField::Tag,
                    default => SentryField::Context,
                },
            ),
            sampler: $sampler ?? fn (Span $span): bool => $span->getError() !== null
                && $span->get('appwrite.error.publish') === true
                && $span->get('appwrite.error.experimental') !== true,
        );
    } catch (Throwable $th) {
        Console::warning('Failed to initialize logging provider: ' . $th->getMessage());
    }
};

if (!empty($loggingConfig)) {
    $addSentryExporter($loggingConfig);
}

$experimentalLoggingConfig = System::getEnv('_APP_EXPERIMENT_LOGGING_CONFIG', '');
if (!empty($experimentalLoggingConfig)) {
    $sampleRate = 0.01;
    try {
        $sample = (new DSN($experimentalLoggingConfig))->getParam('sample', $sampleRate);
        if (\is_numeric($sample)) {
            $sampleRate = \min(1, \max(0, (float) $sample));
        }
    } catch (Throwable) {
    }

    $addSentryExporter(
        loggingConfig: $experimentalLoggingConfig,
        sampler: fn (Span $span): bool => $span->getError() !== null
            && $span->get('appwrite.error.publish') === true
            && $span->get('appwrite.error.experimental') === true
            && \mt_rand() / \mt_getrandmax() <= $sampleRate,
    );
}

if (System::getEnv('_APP_ENV', 'development') === 'development') {
    Span::addExporter(new Exporter\Pretty(), function (Span $span): bool {
        if (\str_starts_with($span->getAction(), 'listener.')) {
            return $span->getError() !== null;
        }
        return true;
    });
}