hyperf 追踪

oZhaoQian

已于 2024-01-16 15:14:03 修改

阅读量664

点赞数 10

CC 4.0 BY-SA版权

分类专栏： php 文章标签： php

于 2024-01-16 15:00:31 首次发布

本文链接：https://blog.csdn.net/oZhaoQian/article/details/135623800

php 专栏收录该内容

3 篇文章

订阅专栏

文章讲述了如何在Hyperf框架中利用日志和上下文追踪ID实现会话追踪，通过封装Log类和在HTTP接口中添加追踪ID，以及异常捕捉中间件的应用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

为什么是追踪？

hyperf官网有用链追踪，需要配合其他第三方应用，有些应用怎么简单怎么部署，能不能用日志来实现追踪？

当然可以，通过上下文+封装Log类+接口统一响应

原理

上下文设置会话追踪ID
封装Log类输出日志统一带上会话追踪ID
接口统一响应返回会话追踪ID方便后续查找

封装Log

<?php
declare(strict_types=1);

namespace App;

use Hyperf\Logger\LoggerFactory;
use Hyperf\Context\ApplicationContext;

class Log
{
    public static function get(string $name = 'app')
    {
        return ApplicationContext::getContainer()->get(LoggerFactory::class)->get($name);
    }

    /**
     * 生成追踪ID
     * @return void
     */
    private static function newTraceId()
    {
        Context::set('trace_id' , uniqid());
    }

    // TODO 是否需要增加设置追踪ID的方法，用于队列追踪或其他应用调用链路追踪

    /**
     * 获取追踪ID
     * @return mixed
     */
    public static function getCxtTraceId()
    {
        $traceId = Context::get('trace_id');
        if(empty($traceId)){
            self::newTraceId();
        }
        return $traceId;
    }

    /**
     * 获取日志前缀包含追踪ID
     * @return string
     */
    private static function getSuffix()
    {
        $traceId = self::getCxtTraceId();
        return ' traceId=' . $traceId.' |';
    }

    /**
     * 输出日志
     * @param $message
     * @return mixed
     */
    public static function info($message='')
    {
        $message = self::getSuffix().$message;
        return self::get()->info($message);
    }
}

接口统一响应

<?php

declare(strict_types=1);

namespace App\Controller;

use Hyperf\HttpServer\Contract\RequestInterface;
use Hyperf\HttpServer\Contract\ResponseInterface;
use Psr\Container\ContainerInterface;
use App\Log;
use Hyperf\Di\Annotation\Inject;

abstract class AbstractController
{
    /**
     * @Inject
     * @var ContainerInterface
     */
    protected $container;

    /**
     * @Inject
     * @var RequestInterface
     */
    protected $request;

    /**
     * @Inject
     * @var ResponseInterface
     */
    protected $response;

    protected function success($data = [])
    {
        return $this->response->json([
            'code' => 0,
            'data' => $data,
            'trace_id' => Log::getCxtTraceId()
        ]);
    }

    protected function fail($code, $message = '')
    {
        return $this->response->json([
            'code' => $code,
            'message' => $message,
            'trace_id' => Log::getCxtTraceId()
        ]);
    }
}