Go PHP 性能分析之 Pyroscope 的进阶使用

seth-shi 的个人博客 / 3 / 2 / 创建于 3年前 / 更新于 3年前

安装

网上很多的教程都是直接一条Docker命令安装运行docker run -it -p 4040:4040 --restart=always pyroscope/pyroscope:latest server
只像上面那样安装的话, 很多配置不能用, 比如数据页面直接展示不需要登录, 不能限制API上报(只允许某些机器上报: 通过Key来限制), 容器销毁后不能保存数据
这里我使用docker-compose.yml来配置

version: "3"
services:
  pyroscope:
    image: "pyroscope/pyroscope:latest"
    ports:
      - "4040:4040"
    command:
      - "server"
    environment:
      ## 限制必须使用 API 秘钥上传
      - PYROSCOPE_AUTH_INGESTION_ENABLED=true
      ## 设置账号密码登录后台
      - PYROSCOPE_AUTH_INTERNAL_ENABLED=true    
    volumes:
      ## 设置数据共享目录
      - ./data:/var/lib/pyroscope

配置好之后, 直接在当前目录运行docker-compose up -d, 然后访问127.0.0.1:4040即可进入登录页面
此时需要输入账号密码方可进入(admin, admin), 进入系统后可以自行修改账号密码
然后添加秘钥 (设置 -> API Keys -> Add Key), 这里稍微要注意的是, Role必须选择Agent才可以上报数据

`Go`使用

Go 有两种模式, 拉取模式类似Prometheus, 由于是自己个人的项目,我选择使用推送的模式

项目增加依赖
go get github.com/pyroscope-io/client/pyroscope
项目中启动服务

package main

import "github.com/pyroscope-io/client/pyroscope"


func main() {

    pyroscope.Start(pyroscope.Config{
        // 项目名字, 只能英文不能中文
        ApplicationName: "remeber-dream-api",
        // 按实际自己 pyroscope 服务的地址
        ServerAddress:   "127.0.0.1:4040",
        Logger:          pyroscope.StandardLogger,
        // 如果开启了 PYROSCOPE_AUTH_INGESTION_ENABLED, 
        // 并且按照以上步骤添加了 Key, 那么把 Key 放到此处即可
        AuthToken: "xxxx",

        // by default all profilers are enabled,
        // but you can select the ones you want to use:
        ProfileTypes: []pyroscope.ProfileType{
            pyroscope.ProfileCPU,
            pyroscope.ProfileAllocObjects,
            pyroscope.ProfileAllocSpace,
            pyroscope.ProfileInuseObjects,
            pyroscope.ProfileInuseSpace,
        },
    })

    // your code goes here
}

`PHP`使用

看了一下文档中PHP 直接使用的话, 只能在命令行下分析, 貌似对php-fpm支持不太好
由于我的项目使用的是laravel-s, 所以可以使用(以后如果有php-fpm的再更新上)
镜像文件

FROM phpswoole/swoole:php7.4

# 修改中国镜像源
RUN sed -i "s@http://deb.debian.org@http://mirrors.aliyun.com@g" /etc/apt/sources.list && rm -Rf /var/lib/apt/lists/* && apt-get update

# 快速安装 PHP 扩展
COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/

RUN install-php-extensions pcntl redis pdo_mysql gd

WORKDIR /var/www
COPY . .
RUN chmod -R 0777 storage && chmod -R 0777 bootstrap/cache && composer install

RUN php artisan migrate && php artisan storage:link && php artisan moon:copy

RUN php artisan laravels publish --no-interaction


# this copies pyroscope binary from pyroscope image to your image:
COPY --from=pyroscope/pyroscope:latest /usr/bin/pyroscope /usr/bin/pyroscope

## 建议在 docker run --env 注入环境变量
#ENV PYROSCOPE_SERVER_ADDRESS=
#ENV PYROSCOPE_APPLICATION_NAME=
#ENV PYROSCOPE_AUTH_TOKEN=
## docker run -d --cap-add=sys_ptrace --env PYROSCOPE_SERVER_ADDRESS=xx --env PYROSCOPE_APPLICATION_NAME=xx --env PYROSCOPE_AUTH_TOKEN=xx -p 80:5200 --name monday-shop-service monday-shop

CMD ["pyroscope", "exec", "php", "bin/laravels", "start", "--env=product"]

注意点

不能使用alpine的镜像, 否则容器启动不起来
注入容器的环境变量, 建议通过docker run注入, 这样子可以不用把秘钥等写在Dockerfile
运行的时候把pyroscope exec写在要运行的命令前面, 参考pyroscope.io/docs/php/
最后上一张效果图

因为压测的是一个有缓存的接口, 可以看到时间基本都消耗在路由匹配和Redis的存取当中

字段解释

名	含义
inuse_objects	已分配但尚未释放的对象数量
alloc_objects	已分配的对象总数(不论已释放的对象)
inuse_space	已分配但尚未释放的内存数量
alloc_space	分配的内存总量(不管释放了多少内存)