paopao-ce/docs/proposal/016-关于使用pyroscope用于性能调试的设计.md

编号	作者	发表时间	变更时间	版本	状态
016	北野	2023-02-15	2023-02-16	v1.1	提议

概述

Pyroscope 是一个开源的持续性能剖析平台。它能够帮你：

• 找出源代码中的性能问题和瓶颈
• 解决 CPU 利用率高的问题
• 理解应用程序的调用树（call tree）
• 追踪随一段时间内变化的情况

需求

• 开发环境下启用Pyroscope，但是部署环境下禁用。

方案

设计要点

• 使用//go:build pyroscope 可选编译app集成Pyroscope功能
• config.yaml中添加Pyroscope 功能来启用Pyroscope

设计细节

• 参考实现(PR):
  add Pyroscope support #199

疑问

1. 为什么要引入Pyroscope？
   用于开发环境下对paopao-ce进行性能优化。

2. 如何开启这个功能？

• 构建时将 pyroscope 添加到TAGS中:

  make run TAGS='pyroscope'   
  

• 在配置文件config.yaml中的Features中添加Pyroscope功能项开启该功能：

  ...
  # features中加上 Friendship
  Features:
    Default: ["Meili", "LoggerMeili", "Base", "Sqlite3", "BigCacheIndex", "MinIO", "Pyroscope"]
    Base: ["Redis", "PhoneBind"]
  ...
  

参考文档

• pyroscope
• pyroscope client

更新记录

v1.0(2023-02-15) - 北野

• 初始文档

v1.1(2023-02-16) - 北野

• 添加参考实现