friendsofhyperf/telescope

An elegant debug assistant for the hyperf framework.

v3.1.50.1 2024-12-14 10:09 UTC

Requires

• php: >=8.1
• friendsofhyperf/ipc-broadcaster: ~3.1.2
• hyperf/command: ~3.1.0
• hyperf/event: ~3.1.0
• hyperf/framework: ~3.1.0
• hyperf/redis: ~3.1.0
• hyperf/support: ~3.1.0
• nesbot/carbon: ^2.71 || ^3.0
• ramsey/uuid: ^4.7

Suggests

• guzzlehttp/guzzle: Required to use Guzzle annotation.(^6.0|^7.0)
• hyperf/command: Required to use Command annotation.(~3.1.0)
• hyperf/database: Required to use Database annotation.(~3.1.48)
• hyperf/db-connection: Required to use db-connection annotation.(~3.1.0)
• hyperf/dispatcher: Required to use BootApplication event.(~3.1.0)
• hyperf/event: Required to use Event annotation.(~3.1.0)
• hyperf/http-message: Required to use http-message annotation.(~3.1.0)

MIT

• huangdijia

• debugging
• swoole
• hyperf
• v3.1

README

An elegant debug assistant for the hyperf framework.

Functions

• request
• exception
• sql
• grpc server/client
• redis
• log
• command
• event
• guzzle
• cache
• rpc server/client
• schedule

Installation

composer require friendsofhyperf/telescope:~3.1.0

Publish

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

Migrate

php bin/hyperf.php migrate

Add Listener

<?php

// config/autoload/listeners.php

return [
    FriendsOfHyperf\Telescope\Listener\SetRequestLifecycleListener::class,
    FriendsOfHyperf\Telescope\Listener\RequestHandledListener::class,
];

Add Middleware

<?php

// config/autoload/middlewares.php

return [
    'grpc' => [
        FriendsOfHyperf\Telescope\Middleware\TelescopeMiddleware::class,
    ],
];

TelescopeMiddleware or RequestHandledListener, you can choose one of them.

Add env

# telescope
TELESCOPE_DB_CONNECTION=default

TELESCOPE_ENABLE_REQUEST=true
TELESCOPE_ENABLE_COMMAND=true
TELESCOPE_ENABLE_GRPC=true
TELESCOPE_ENABLE_LOG=true
TELESCOPE_ENABLE_REDIS=true
TELESCOPE_ENABLE_EVENT=true
TELESCOPE_ENABLE_EXCEPTION=true
TELESCOPE_ENABLE_JOB=true
TELESCOPE_ENABLE_DB=true
TELESCOPE_ENABLE_GUZZLE=true
TELESCOPE_ENABLE_CACHE=true
TELESCOPE_ENABLE_RPC=true

TELESCOPE_SERVER_ENABLE=true

Visit

http://127.0.0.1:9501/telescope

Tagging

you may want to attach your own custom tags to entries. To accomplish this, you may use the Telescope::tag method.

Filtering

You may only want to record entries under certain special conditions. To achieve this, you may use the Telescope::filter method.

Example

use FriendsOfHyperf\Telescope\Telescope;
use Hyperf\Event\Contract\ListenerInterface;
use Hyperf\Framework\Event\BootApplication;
use FriendsOfHyperf\Telescope\IncomingEntry;

class TelescopeInitListener implements ListenerInterface
{
    public function listen(): array
    {
        return [
            BootApplication::class,
        ];
    }

    public function process(object $event): void
    {
        // attach your own custom tags
        Telescope::tag(function (IncomingEntry $entry) {
            if ($entry->type === 'request') {
                return [
                    'status:' . $entry->content['response_status'],
                    'uri:'. $entry->content['uri'],
                ];
            }
        });

        // filter entry
        Telescope::filter(function (IncomingEntry $entry): bool {
            if ($entry->type === 'request'){
                if ($entry->content['uri'] == 'xxxx') {
                    return false;
                }
            }
            return true;
        });

    }
}

You can also do this in middleware.