为托管 Federation 启用错误报告
配置带外报告
您可以通过带外报告来配置您的托管网关向 Apollo 发送错误报告。
启用报告
要启用带外错误报告,请将以下环境变量设置到您的网关环境中
APOLLO_OUT_OF_BAND_REPORTER_ENDPOINT=https://outofbandreporter.api.apollographql.com
下次启动网关时,将启用带外错误报告。
ⓘ 注意
如果您以前已启用带外报告,可能已指定了一个现在已弃用的URL。请检查您的配置,确保您已指定上述URL。
工作原理
每当您的网关因错误无法从Apollo获取其 supergraph schema时,带外报告机制会以 GraphQL mutation 的形式将错误报告发送到Apollo。
报告以下作为 GraphQL variables 的信息:
- 网关产生的错误代码和消息
- HTTP请求URL和正文
- HTTP响应状态代码和正文
- 请求的
started-at
和end-at
时间
还提供了以下HTTP头信息
apollographql-client-name
: 网关使用的 GraphQL客户端 的名称apollographql-client-version
: 网关使用的 GraphQL客户端的版本号