21 releases (4 breaking)

0.5.6 May 29, 2024
0.5.5 May 26, 2024
0.4.9 May 17, 2024
0.3.5 May 3, 2024
0.1.2 Mar 29, 2024

#107 in HTTP server

Download history 120/week @ 2024-03-18 125/week @ 2024-03-25 256/week @ 2024-04-01 3/week @ 2024-04-08 264/week @ 2024-04-15 392/week @ 2024-04-22 850/week @ 2024-04-29 33/week @ 2024-05-06 194/week @ 2024-05-13 638/week @ 2024-05-20 178/week @ 2024-05-27 8/week @ 2024-06-03

1,018 downloads per month

Apache-2.0

425KB
11K SLoC

pingap

What is Pingap

A reverse proxy like nginx, built on pingora, simple and efficient.

中文说明

Feature

  • Filter location by host and path
  • Path rewrite with regexp
  • HTTP 1/2 end to end proxy
  • TOML base configuration, file or etcd storage
  • Graceful reload and auto restart after the configuration is changed
  • Template for http access log
  • Admin Web UI configuration
  • Genrate TLS certificates from let's encrypt
  • Notification events: lets_encrypt, backend_unhealthy, diff_config, restart, etc.
  • Http proxy plugins: compression, static serve, limit, stats, mock, etc.

Start

Loads all configurations from /opt/proxy and run in the background. Log appends to /opt/proxy/pingap.log.

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

Graceful restart

Validate the configurations, send quit signal to pingap, then start a new process to handle all requests.

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

Auto restart

Watch the configurations, if one of them changes, graceful restart pingap.

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

Config

All toml configurations are as follows pingap.toml.

Proxy step

graph TD;
    server["HTTP Server"];
    locationA["Location A"];
    locationB["Location B"];
    locationPluginListA["Proxy Plugin List A"];
    locationPluginListB["Proxy Plugin List B"];
    upstreamA1["Upstream A1"];
    upstreamA2["Upstream A2"];
    upstreamB1["Upstream B1"];
    upstreamB2["Upstream B2"];
    locationResponsePluginListA["Response Plugin List A"];
    locationResponsePluginListB["Response Plugin List B"];

    start("New Request") --> server

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

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

    locationA -- "Exec Proxy Plugins" --> locationPluginListA

    locationB -- "Exec Proxy Plugins" --> locationPluginListB

    locationPluginListA -- "proxy pass: 10.0.0.1:8001" --> upstreamA1

    locationPluginListA -- "proxy pass: 10.0.0.2:8001" --> upstreamA2

    locationPluginListA -- "done" --> response

    locationPluginListB -- "proxy pass: 10.0.0.1:8002" --> upstreamB1

    locationPluginListB -- "proxy pass: 10.0.0.2:8002" --> upstreamB2

    locationPluginListB -- "done" --> response

    upstreamA1 -- "Exec Response Plugins" --> locationResponsePluginListA
    upstreamA2 -- "Exec Response Plugins" --> locationResponsePluginListA

    upstreamB1 -- "Exec Response Plugins" --> locationResponsePluginListB
    upstreamB2 -- "Exec Response Plugins" --> locationResponsePluginListB

    locationResponsePluginListA --> response
    locationResponsePluginListB --> response

    response["HTTP Response"] --> stop("Logging");

Performance

CPU: M2, Thread: 1

Ping no accces log:

wrk 'http://127.0.0.1:6188/ping' --latency

Running 10s test @ http://127.0.0.1:6188/ping
  2 threads and 10 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency    67.10us   67.52us   4.63ms   99.53%
    Req/Sec    74.82k     2.57k   85.56k    92.57%
  Latency Distribution
     50%   69.00us
     75%   76.00us
     90%   83.00us
     99%  105.00us
  1504165 requests in 10.10s, 196.52MB read
Requests/sec: 148928.76
Transfer/sec:     19.46MB

More Performance

Rust version

Our current MSRV is 1.74

License

This project is Licensed under Apache License, Version 2.0.

Dependencies

~91–130MB
~2.5M SLoC