friendsofhyperf/sentry

The sentry component for Hyperf.

v3.1.22.6 2024-04-16 15:00 UTC

Requires

• hyperf/command: ~3.1.0
• hyperf/context: ~3.1.0
• hyperf/coroutine: ~3.1.0
• hyperf/di: ~3.1.0
• hyperf/event: ~3.1.0
• hyperf/exception-handler: ~3.1.0
• hyperf/framework: ~3.1.0
• hyperf/http-server: ~3.1.0
• hyperf/support: ~3.1.0
• hyperf/tappable: ~3.1.0
• phpmyadmin/sql-parser: ^5.9
• sentry/sentry: ^4.4.0

Suggests

• elasticsearch/elasticsearch: Required to use the elasticsearch client (^7.0|^8.0).
• hyperf/amqp: Required to use the amqp event (~3.1.9).
• hyperf/crontab: Required to use the crontab event (~3.1.7).
• hyperf/database: Required to use the crontab event (~3.1.0).

MIT

• huangdijia

• php
• sentry
• hyperf
• v3.1

README

The sentry component for Hyperf.

Installation

composer require friendsofhyperf/sentry

Publish

php bin/hyperf.php vendor:publish friendsofhyperf/sentry

Register Logger Handler

<?php

# use it send customer log to sentry
//\FriendsOfHyperf\Helpers\logs('project-name', 'sentry')->warning('this is a test warning issue!');

return [
    // ...
    'sentry' => [
        'handler' => [
            'class' => FriendsOfHyperf\Sentry\SentryHandler::class,
            'constructor' => [
                'level' => \Monolog\Level::Debug,
            ],
        ],
        'formatter' => [
            'class' => \Monolog\Formatter\LineFormatter::class,
            'constructor' => [
                'format' => null,
                'dateFormat' => null,
                'allowInlineLineBreaks' => true,
            ]
        ],
    ],
    // ...
];

Sentry Running log

<?php

# config/autoload/sentry.php
return [
    // ...
    'logger' => Hyperf\Contract\StdoutLoggerInterface::class,
    // ...
];

Annotation

<?php
namespace App;

use FriendsOfHyperf\Sentry\Annotation\Breadcrumb;

class Foo
{
    #[Breadcrumb(category: 'foo')]
    public function bar($a = 1, $b = 2)
    {
        return __METHOD__;
    }
}

Tracing

SENTRY_TRACING_ENABLE_AMQP=true
SENTRY_TRACING_ENABLE_ASYNC_QUEUE=true
SENTRY_TRACING_ENABLE_COMMAND=true
SENTRY_TRACING_ENABLE_CRONTAB=true
SENTRY_TRACING_ENABLE_KAFKA=true
SENTRY_TRACING_ENABLE_MISSING_ROUTES=true
SENTRY_TRACING_ENABLE_REQUEST=true
SENTRY_TRACING_SPANS_COROUTINE=true
SENTRY_TRACING_SPANS_DB=true
SENTRY_TRACING_SPANS_ELASTICSEARCH=true
SENTRY_TRACING_SPANS_GUZZLE=true
SENTRY_TRACING_SPANS_RPC=true
SENTRY_TRACING_SPANS_REDIS=true
SENTRY_TRACING_SPANS_SQL_QUERIES=true

Sentry Develop Docs

• https://github.com/open-telemetry/semantic-conventions/tree/main
• https://develop.sentry.dev/sdk/performance/span-operations/#database

Contact

• Twitter
• Gmail

License

MIT