builtin services

学习bRPC强大的内置服务。

什么是内置服务？

内置服务以多种形式展现服务器内部状态，提高你开发和调试服务的效率。brpc通过HTTP协议提供内置服务，可通过浏览器或curl访问，服务器会根据User-Agent返回纯文本或html，你也可以添加?console=1要求返回纯文本。我们在自己的开发机上启动了一个长期运行的例子(只能百度内访问)，你可以点击后随便看看。如果服务端口被限（比如百度内不是所有的端口都能被笔记本访问到），可以使用rpc_view转发。

下面是分别从浏览器和终端访问的截图，注意其中的logo是百度内部的名称，在开源版本中是brpc。

从浏览器访问

从命令行访问

安全模式

出于安全考虑，直接对外服务需要隐藏内置服务（包括经过nginx或其他http server转发流量的），具体方法请阅读这里。

主要服务

/status: 显示所有服务的主要状态。

/vars: 用户可定制的，描绘各种指标的计数器。

/connections: 所有连接的统计信息。

/flags: 所有gflags的状态，可动态修改。

/rpcz: 查看所有的RPC的细节。

cpu profiler: 分析cpu热点。

heap profiler: 分析内存占用。

contention profiler: 分析锁竞争。

其他服务

/version: 查看服务器的版本。用户可通过Server::set_version()设置Server的版本，如果用户没有设置，框架会自动为用户生成，规则：brpc_server_<service-name1>_<service-name2> ...

/health: 探测服务的存活情况。

/protobufs: 查看程序中所有的protobuf结构体。

/vlog: 查看程序中当前可开启的VLOG (对glog无效)。

/dir: 浏览服务器上的所有文件，方便但非常危险，默认关闭。

/threads: 查看进程内所有线程的运行状况，调用时对程序性能影响较大，默认关闭。

修改于 2024年10月7日: Oncall report (1b7065e)