grpcpulse 0.1.0

Benchmark and compare gRPC endpoints side by side — latency, throughput, and stream lag
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# grpcpulse

A CLI tool and Rust library to benchmark and compare gRPC endpoints side by side.
Measures latency, throughput, and stream lag — built for comparing Solana RPC providers
(Shyft, Helius, Triton) or any gRPC service.

## Install

```bash
cargo install grpcpulse
```

## Modes

### Latency — round-trip benchmark

Fires N concurrent requests and reports p50/p95/p99 latency per endpoint:

```bash
grpcpulse latency \
  --endpoint "shyft=https://grpc.shyft.to|x-token:YOUR_TOKEN" \
  --endpoint "my-node=http://localhost:10000" \
  --requests 100 \
  --concurrency 10 \
  --warmup 5
```

```
+----------+---------+---------+---------+---------+--------+
| Endpoint | p50     | p95     | p99     | Max     | Errors |
+============================================================+
| my-node  | 4.12ms  | 8.34ms  | 12.01ms | 25.40ms | 0.0%   |
| shyft    | 93.10ms | 127ms   | 128ms   | 128ms   | 0.0%   |
+----------+---------+---------+---------+---------+--------+
```

### Stream — Solana slot lag comparison

Subscribes to Geyser slot streams on all endpoints simultaneously and measures
which provider delivers each slot first:

```bash
grpcpulse stream \
  --endpoint "shyft-ams=https://grpc.ams.shyft.to|x-token:YOUR_TOKEN" \
  --endpoint "shyft-sgp=https://grpc.sgp.shyft.to|x-token:YOUR_TOKEN" \
  --slots 50
```

```
+-----------+------+-------+--------------+------------+
| Endpoint  | Wins | Win % | Avg Lag (ms) | Slots Seen |
+=======================================================+
| shyft-ams |   36 | 69.2% |        16.53 |         52 |
| shyft-sgp |   16 | 30.8% |         2.38 |         52 |
+-----------+------+-------+--------------+------------+

Fastest: shyft-ams (36/50 slots, avg 0.00ms ahead)
```

## Auth headers

Pass headers per endpoint using `|key:value` after the URL:

```bash
--endpoint "shyft=https://grpc.shyft.to|x-token:abc123"
```

Or globally with `-H` (applies to all endpoints):

```bash
-H "authorization:Bearer mytoken"
```

## Use as a library

```rust
use grpcpulse::bench::{run, BenchConfig};
use grpcpulse::endpoint::Endpoint;
use grpcpulse::report::print_table;

#[tokio::main]
async fn main() {
    let endpoints = vec![
        Endpoint::new("shyft", "https://grpc.shyft.to")
            .with_header("x-token", "YOUR_TOKEN"),
        Endpoint::new("local", "http://localhost:10000"),
    ];

    let results = run(endpoints, BenchConfig::default()).await;
    print_table(&results);
}
```

## Options

### `grpcpulse latency`

| Flag | Description | Default |
|---|---|---|
| `--endpoint` | `name=url` or `name=url\|key:value` | required |
| `-H` | Global header `key:value` | — |
| `--requests` | Requests per endpoint | 100 |
| `--concurrency` | Parallel requests per batch | 10 |
| `--warmup` | Warmup requests (results discarded) | 5 |

### `grpcpulse stream`

| Flag | Description | Default |
|---|---|---|
| `--endpoint` | `name=url` or `name=url\|key:value` | required |
| `-H` | Global header `key:value` | — |
| `--slots` | Number of slots to collect | 50 |

## License

MIT