管理员可使用可进行 PromQL 查询的指标 API 直接查询和获取原始指标,这些原始指标可用于第三方查看器或运行在集群内外的图形应用程序,例如 Grafana。
指标 API 使用 Prometheus 监控系统从 GIS 服务 Pod 收集这些指标,并将信息保留在时间序列数据库中。 指标查看器将指标 API 注册为数据存储,这样便可查询指标 API 获取使用情况统计数据。
指标 API 显示在管理员目录中的使用情况统计数据 API。 要访问指标 API,请按照以下步骤操作:
- 转至管理员目录中的使用情况统计数据 API:https://organization.example.com/<context>/admin/usagestatistics。
- 单击 Rest Metrics API。
随即在新选项卡中打开指标 API 应用程序。
- 登录到 Prometheus Web 页面。
默认情况下,将使用系统生成的凭据进行登录。 登录到 Prometheus 仪表盘前,配置组织并更新凭据。 要更新这些凭据,使用 admin/usagestatistics 中的更新凭据操作。 新密码必须至少包含 8 个字符,并且必须至少包含以下各项中的一项:
- ASCII 字母 A 到 Z(大写或小写)
- 数字 0 到 9
- 受支持的特殊字符(# ! % & , - . / : ; < = > @ _ ` ~ ^ ? \ * + \ | $ 和空白字符)
指标 API 收集的原始指标
指标 API 收集的原始指标在下面的表格中进行介绍:
序号 | 指标名称 | 描述 | 类型 |
---|---|---|---|
1 | 请求 | 可用于查找请求率的请求。 | 计数器 |
2 | requests_succeeded | 可用于查找请求成功率的成功请求。 | 计数器 |
3 | requests_failed | 可用于查找请求失败率的失败请求。 | 计数器 |
4 | requests_usage_timedout | 可用于查找使用超时请求率的使用超时请求。 | 计数器 |
5 | requests_wait_timedout | 可用于查找等待超时请求率的等待超时请求。 | 计数器 |
6 | requests_response_time_seconds | 相应时间,单位为秒。 样本、观测值和计数器在下列存储段中:0.05、0.1、0.25、0.5、0.75、1、2.5、5、7.5、10 和 Inf。 | 直方图 |
7 | gp_job_wait_time_seconds | 选择运行的地理处理作业花费的时间(以秒为单位)。 样本、观测值和计数器在下列存储段中:0.05、0.1、0.25、0.5、0.75、1、2.5、5、7.5、10 和 Inf。 | 直方图 |
指标 API 捕获的标注
除了指标 API 收集的各个原始指标,还将收集下表中介绍的标注,并可使用 PromQL 查询和结果过滤器查询指标 API 的指标。
标注名称 | 描述 |
---|---|
nodeName | 处理请求的机器名称和服务 Pod。 |
podName | 处理请求的服务 Pod 名称。 |
apiType | 收集指标的 API。 当前的可能值为 service,表示一个服务请求。 |
folderName | 创建服务的文件夹名称。 |
serviceName | 服务名称,包括服务所在的文件夹名称。 |
serviceType | 服务类型,例如 MapService 或 FeatureService。 |
操作 | 请求的操作,例如查询或导出。 注:操作信息仅可用于 REST 请求。 SOAP 请求仅返回 soap 的一个值。 |
orgId | 组织 ID。 |
username | 发起请求的用户的用户名。 |