当前位置: 首页 > news >正文

Log::build()->pushContext(‘tenant_id‘, $tenantId)->info(‘email.sent‘, $context);的庖丁解牛

Log::build()->pushContext('tenant_id', $tenantId)->info('email.sent', $context);是 Laravel 10+ 引入的日志上下文链式构建器(Logging Context Builder),用于在单次日志调用中注入临时上下文,而不污染全局日志配置。


一、核心目的:隔离上下文,避免全局污染

1.传统方法的问题

// ❌ 全局注入上下文(影响后续所有日志)Log::withContext(['tenant_id'=>$tenantId]);Log::info('email.sent',$context);// 后续 Log::info() 也会携带 tenant_id → 数据污染

2.Log::build()的解决方案

// ✅ 仅当前日志携带 tenant_idLog::build()->pushContext('tenant_id',$tenantId)->info('email.sent',$context);// 后续日志不受影响

本质创建一次性、隔离的日志实例


二、底层执行流程

1.Log::build()

  • 返回Illuminate\Log\LogManager的新实例(非单例)
  • 不共享全局日志通道的上下文

2.pushContext()

  • ['tenant_id' => $tenantId]合并到当前构建器的上下文
  • 支持链式调用
    Log::build()->pushContext('tenant_id',$tenantId)->pushContext('trace_id',$traceId)->info('...');

3.info()

  • 触发日志写入
    1. 合并$context(方法参数)与构建器上下文
    2. 调用底层 Monolog 记录日志
    3. 构建器实例销毁(上下文不保留)

📌关键
上下文仅存在于本次build()链式调用中


三、Monolog 底层实现

1.上下文合并逻辑

  • 最终日志的context=
    构建器上下文+info($message, $context)$context
  • 示例
    Log::build()->pushContext('tenant_id',123)->info('email.sent',['to'=>'a@example.com']);
    • 最终 context
      ['tenant_id'=>123,'to'=>'a@example.com']

2.无全局状态变更

  • Laravel 全局日志实例app('log')) 的上下文保持不变
  • 线程安全:多请求并发时上下文不交叉污染

四、典型使用场景

1.多租户应用

// 处理租户请求时$tenant=Tenant::current();Log::build()->pushContext('tenant_id',$tenant->id)->info('user.login',['user_id'=>$user->id]);
  • 日志系统可按tenant_id过滤

2.链路追踪(Distributed Tracing)

$traceId=request()->header('X-Trace-Id');Log::build()->pushContext('trace_id',$traceId)->info('api.request',['path'=>$request->path()]);
  • 关联同一请求的多个服务日志

3.队列任务上下文

// app/Jobs/SendEmail.phppublicfunctionhandle(){Log::build()->pushContext('job_id',$this->job->getJobId())->info('email.processing',['to'=>$this->email]);}
  • 避免队列任务日志混杂

五、与全局上下文的对比

方法作用域适用场景
Log::withContext()全局(当前请求生命周期)请求级上下文(如 user_id)
Log::build()->pushContext()单次日志临时/任务级上下文(如 job_id)

组合使用

// 全局:当前用户Log::withContext(['user_id'=>auth()->id()]);// 临时:当前任务Log::build()->pushContext('job_id',$jobId)->info('task.start');// 日志包含 user_id + job_id

六、生产环境最佳实践

1.字段命名规范

  • 使用 snake_casetenant_id而非tenantId
  • 避免敏感数据
    // ❌ 危险Log::build()->pushContext('password',$password);// ✅ 安全Log::build()->pushContext('user_id',$user->id);

2.性能考量

  • build()有轻微开销(创建新实例)
  • 仅在需要隔离上下文时使用,避免滥用

3.与结构化日志集成

  • 输出 JSON 格式(生产环境):
    // config/logging.php'channels'=>['stack'=>['driver'=>'stack','channels'=>['daily'],'formatter'=>Monolog\Formatter\JsonFormatter::class,],],
  • 日志示例
    {"level":"info","message":"email.sent","context":{"tenant_id":123,"to":"a@example.com"}}

七、总结

问题答案
Log::build()作用创建隔离的日志实例,避免上下文污染
withContext()区别build()是单次,withContext()是全局
典型场景多租户、链路追踪、队列任务
生产建议仅必要时使用 + 字段规范 + JSON 格式

日志上下文 = 数据的维度
Log::build()让你精确控制每个日志事件的维度
而非用全局上下文“污染”整个请求。
这是构建高可观测性系统的关键细节。

http://www.cnnetsun.cn/news/199825.html

相关文章:

  • Anything-LLM能否替代ChatGPT?本地化优势全面分析
  • 3步精通英雄联盟智能助手:League Akari实战全解析
  • Synology Photos人脸识别终极解决方案:让老设备重获AI智能
  • 快速理解PCB原理图设计核心要点:初学者必备知识
  • 网页版三国杀无名杀完整技术手册:从部署到精通的终极指南
  • League Akari:智能游戏助手让英雄联盟体验更高效
  • m4s-converter:让B站缓存视频永久保存的完美方案
  • m4s-converter:一键解锁B站缓存视频的终极神器
  • D2DX终极优化指南:让暗黑破坏神2焕然一新
  • B站缓存视频转换终极指南:3步搞定m4s转mp4
  • 网页版三国杀无名杀快速入门指南:从新手到高手的实战教程
  • 任意波形信号发生器编程入门:零基础指南
  • B站缓存转换:5秒解锁本地播放的终极方案
  • 超简单方案:一键解决B站缓存视频播放难题
  • 5步掌握虚幻引擎资源查看工具:从游戏文件到可用资产的完整转换
  • Typora自动编号功能终极指南:轻松管理专业文档结构
  • 终极桌面待办神器:3分钟搞定任务管理的完整指南
  • 英雄联盟工具包完整使用教程:从安装到精通
  • 终极D2DX配置手册:5分钟解锁暗黑破坏神2高清体验
  • rtl8812AU_8821AU Linux无线驱动终极配置指南
  • Bebas Neue字体革命:5个让设计瞬间升级的秘密武器
  • B站缓存视频一键转换:m4s转mp4的终极解决方案
  • 3分钟快速上手:B站视频缓存转换工具完全指南
  • B站视频永久保存终极指南:一键m4s转mp4完整教程
  • B站视频转换全攻略:解锁m4s缓存文件的终极方案
  • 工业网关USB端口检测不到设备的原因一文说清
  • B站视频转换终极教程:5秒完成m4s到MP4无损转换
  • Markdown Viewer:浏览器中的智能文档阅读革命
  • Visual C++运行库终极修复指南:5分钟解决软件无法启动问题
  • 3分钟极速上手:Firmware Extractor安卓固件提取终极指南