Telescope

Available Listeners

• Request Monitor
• Exception Monitor
• Data Query Monitor
• gRPC Request Monitor
• Redis Monitor
• Log Monitor
• Command Line Monitor
• Event Monitor
• HTTP Client Monitor
• Cache Monitor
• Scheduled Task Monitor

Installation

composer require friendsofhyperf/telescope:~3.1.0

Use the vendor:publish command to publish its public resources

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

Run the migrate command to execute database changes to create and store the data required by Telescope

php bin/hyperf.php migrate

Usage

Choose either the listener or middleware

Request Listener

Add the listener in the config/autoload/listeners.php configuration file

<?php

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

Middleware

Add the global middleware in the config/autoload/middlewares.php configuration file

To record HTTP requests, use the http middleware

<?php

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

To record gRPC requests, use the grpc middleware

<?php

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

View Dashboard

http://127.0.0.1:9501/telescope

Database Configuration

Manage the database connection configuration in config/autoload/telescope.php, defaulting to the default connection

'connection' => env('TELESCOPE_DB_CONNECTION', 'default'),

Tags

You may wish to attach your own custom tags to entries. To do this, you can use the Telescope::tag method.

Batch Filtering

You may want to record entries only under certain special conditions. To do this, you can 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;
        });

    }
}