Docs

RPCORA 文档中心
从单请求到链路回放

按真实上手路径组织:连接服务、解析 schema、构造请求、保存链路、查看 Doctor 诊断和脱敏报告。

Quickstart Five minute path
  1. 01Enter gRPC target
  2. 02Discover service.method
  3. 03Save request and replay chain
127.0.0.1:50051 user.UserService/GetUser metadata.authorization = Bearer ...
Quickstart

推荐上手顺序

第一次使用先跑通一条最小路径,再逐步加入 Auth、Metadata、环境变量和 Chains。

01

先在 APIs 中调通一个 gRPC 请求。

02

确认地址是 host:port,例如 127.0.0.1:50051 或 grpc.internal.company:443。

03

如果 Reflection 失败,导入本地 Proto 目录或 Git Proto 仓库。

04

保存请求后进入 Chains,按顺序添加已保存请求。

05

在上游步骤配置提取器,例如 body.token -> session.token。

06

下游请求通过 {{session.token}} 使用运行时变量,再运行整条链路。

建议路径 APIs 调通单请求 -> 保存请求 -> Chains 编排步骤 -> Doctor 查看诊断证据。
Concepts

先理解四个核心概念

APIs

单请求调试入口

选择 service.method,配置 Payload、Metadata、Auth、TLS,并查看响应、状态和耗时。

Schema

Reflection 或 Proto

Reflection 用于直接发现服务;Proto 用于 Reflection 不可用或需要固定 schema 的场景。

Chains

把请求串成路径

保存后的 unary 请求可以按顺序执行,并把上游响应提取为下游运行时变量。

Doctor

诊断失败原因

围绕地址、TLS、Metadata、schema 来源和 gRPC 状态生成可继续定位的证据。

Target & Schema

地址填写 gRPC target,schema 决定请求结构

地址应该是 gRPC target,不是 HTTP URL

正确: 127.0.0.1:50051 api.example.com:443 grpc.internal.company:8443 错误: /v1/user/login /api/order/create https://api.example.com/v1/user/login

Reflection 与 Proto 怎么选

R
Reflection开发环境或开启 Server Reflection 的服务,输入地址后可直接发现服务和方法。
P
Proto生产、第三方或禁用 Reflection 的服务,导入本地 Proto 目录或 Git Proto 仓库。
Chain Replay

把已跑通请求变成可复现链路

Chains 适合登录后访问、创建后查询、生成后校验这类有上下文依赖的路径。

Step 1保存上游请求

先在 APIs 中确认响应结构稳定,例如登录接口返回 token。

Step 2配置变量提取

从 Body、Metadata、Trailers 或 Status 中提取值,例如 body.token -> session.token。

Step 3注入下游请求

下游 Payload、Metadata 或 Auth 使用 {{session.token}} 这类运行时变量。

Step 4运行整条链路

失败时查看失败步骤、上下文解析结果和 Doctor 诊断。

Doctor

诊断结果按证据组织

Target地址格式、端口、连接状态。
TLSplaintext、TLS、证书和 mTLS 配置。
Metadata鉴权头、租户、trace 信息和全局 Metadata。
SchemaReflection 状态、Proto fallback 和 message 类型。
StatusgRPC status、耗时、响应体、Headers 和 Trailers。
Report面向协作排障的脱敏 Markdown 证据。
Requirements

运行要求

  • Node.js 20.x 或更高版本用于本地开发。
  • 桌面运行环境面向 macOS、Windows、Linux。
  • 调试目标应提供真实 gRPC 服务地址,例如 127.0.0.1:50051。
  • Reflection 可用时体验最好;禁用 Reflection 时需要 Proto 文件或 Git Proto 仓库。
FAQ

常见问题

RPCORA 适合什么场景?

适合本地、内网和微服务研发中的 gRPC 调试,尤其是需要 Reflection/Proto、Metadata/Auth、运行时变量和多步链路回放的场景。

没有开启 Server Reflection 还能用吗?

可以。Reflection 不可用时,导入本地 Proto 目录或 Git Proto 仓库后,仍然可以选择服务方法、生成请求结构并执行调用。

为什么要用 Chains?

很多业务接口依赖登录、鉴权、租户、用户 ID 或 trace 上下文。Chains 可以把已保存请求按顺序执行,并把上游结果注入下游请求。

敏感 token 会怎么处理?

RPCORA 是本地优先的桌面工作台,工作区、请求、环境、历史和设置优先保存在本机。分享报告时应使用脱敏内容。