Skip to content

Latest commit

 

History

History
121 lines (84 loc) · 3.5 KB

README_zh.md

File metadata and controls

121 lines (84 loc) · 3.5 KB
Raw

pingap

Pingap是类似于nginx的反向代理，基于pingora构建，简单而高效。

特性

  • 支持通过host与path筛选对应的location
  • 正则形式重写Path
  • HTTP 1/2的全链路支持
  • 基于TOML格式的配置，可保存至文件或etcd
  • 应用配置更新后，无中断式的优雅更新程序
  • 访问日志的模板化配置
  • WEB形式的管理后台界面
  • 可通过let's encrypt生成tls相关证书，简单易用
  • 支持各种事件的推送：lets_encrypt, backend_unhealthy, diff_config, restart等等
  • 丰富的http转发插件：compression, static serve, limit, stats, mock, 等等

使用手册

使用手册

启用程序

从 /opt/proxy目录中加载所有配置，并以后台程序的形式运行，日志写入至/opt/proxy/pingap.log。

RUST_LOG=INFO pingap -c=/opt/proxy -d --log=/opt/proxy/pingap.log

优雅重启

校验配置是否正确后，发送信号给pingap并启动新的程序接收原有的请求。

RUST_LOG=INFO pingap -c=/opt/proxy -t \
  && pkill -SIGQUIT pingap \
  && RUST_LOG=INFO pingap -c=/opt/proxy -d -u --log=/opt/proxy/pingap.log

应用配置

所有的应用配置可查阅说明： pingap.toml。

请求处理流程

graph TD;
    server["HTTP服务"];
    locationA["Location A"];
    locationB["Location B"];
    locationPluginListA["转发插件列表A"];
    locationPluginListB["转发插件列表B"];
    upstreamA1["上游服务A1"];
    upstreamA2["上游服务A2"];
    upstreamB1["上游服务B1"];
    upstreamB2["上游服务B2"];
    locationResponsePluginListA["响应插件列表A"];
    locationResponsePluginListB["响应插件列表B"];

    start("新的请求") --> server

    server -- "host:HostA, Path:/api/*" --> locationA

    server -- "Path:/rest/*"--> locationB

    locationA -- "顺序执行转发插件" --> locationPluginListA

    locationB -- "顺序执行转发插件" --> locationPluginListB

    locationPluginListA -- "转发至: 10.0.0.1:8001" --> upstreamA1

    locationPluginListA -- "转发至: 10.0.0.2:8001" --> upstreamA2

    locationPluginListA -- "处理完成" --> response

    locationPluginListB -- "转发至: 10.0.0.1:8002" --> upstreamB1

    locationPluginListB -- "转发至: 10.0.0.2:8002" --> upstreamB2

    locationPluginListB -- "处理完成" --> response

    upstreamA1 -- "顺序执行响应插件" --> locationResponsePluginListA
    upstreamA2 -- "顺序执行响应插件" --> locationResponsePluginListA

    upstreamB1 -- "顺序执行响应插件" --> locationResponsePluginListB
    upstreamB2 -- "顺序执行响应插件" --> locationResponsePluginListB

    locationResponsePluginListA --> response
    locationResponsePluginListB --> response

    response["HTTP响应"] --> stop("日志记录");

性能测试

CPU: M2, Thread: 1

wrk 'http://127.0.0.1:6188/stats' --latency
Running 10s test @ http://127.0.0.1:6188/stats
  2 threads and 10 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency    87.92us   60.91us   3.69ms   89.97%
    Req/Sec    57.32k     2.17k   69.69k    91.09%
  Latency Distribution
     50%   93.00us
     75%  100.00us
     90%  106.00us
     99%  133.00us
  1151171 requests in 10.10s, 320.61MB read
Requests/sec: 113977.63
Transfer/sec:     31.74MB

最低支持rust版本

最低支持的rust版本为1.74

开源协议

This project is Licensed under Apache License, Version 2.0.