管理接口

云眼About 1 min

管理接口

云眼 Agent 的管理 API 提供系统信息,可用于检查代理服务的可用性、运行时信息和操作指标

📘 注意

默认情况下,管理员侦听器在端口 8088 上配置。

信息

终端节点提供有关云眼代理实例的基本信息。/info

示例请求:

Shell

curl localhost:8088/info

示例响应:

JSON

{ "version": "v0.10.0", "author": "云眼 Inc.", "app_name": "eyeofcloud" }

健康检查

终结点用于确定服务可用性。/health

示例请求:

Shell

curl localhost:8088/health

示例响应:

JSON

{ "status": "ok" }

当且仅当所有配置的侦听器都已打开并且可以访问所有外部依赖服务时,云眼 Agent 才会返回响应。HTTP 200 - OK

不正常的服务将返回带有描述性消息的响应,以帮助诊断问题。 HTTP 503 - Unavailable

将代理置于负载均衡器后面以指示特定实例是否可以接收入站请求时,可以使用此终端节点。

指标

终结点公开正在运行的云眼代理的遥测数据。核心运行时指标通过 Go expvar 包open in new window公开。各种统计信息的文档可以作为 mstatsopen in new window 包的一部分找到。/metrics

示例请求:

Shell

curl localhost:8088/metrics

示例响应:

JSON

{ "cmdline": [ "bin/eyeofcloud" ], "memstats": { "Alloc": 924136, "TotalAlloc": 924136, "Sys": 71893240, "Lookups": 0, "Mallocs": 4726, "HeapAlloc": 924136, ... "Frees": 172 }, ... }

还为各个服务终结点提供了自定义指标,并遵循以下模式:

Shell

"timers.<metric-name>.counts": 0, "timers.<metric-name>.responseTime": 0, "timers.<metric-name>.responseTimeHist.p50": 0, "timers.<metric-name>.responseTimeHist.p90": 0, "timers.<metric-name>.responseTimeHist.p95": 0, "timers.<metric-name>.responseTimeHist.p99": 0,

Last update:
Contributors: zhangweixue