通过本次最佳实践内容,您可以看到ARMS OpenAPI可以灵活的被集成到客户链路监控场景,并对其进行可视化图形展示监控信息。
1. 背景信息
应用实时监控服务ARMS(Application Real-Time Monitoring Service)是一款应用性能管理产品,能帮助你实现全栈式的性能监控和端到端的全链路追踪诊断,让应用运维更加高效。
本次最佳实践是基于调用ARMS OpenAPI的形式来实现客户应用场景链路监控的可视化图形展示,使用环境为专有云V3.10版本ASCM控制台,调用ARMS OpenAPI接口通过工具Postman进行测试,在第二章节详细介绍了测试环境及测试工具。第三章节通过一个查询所有应用ARMS OpenAPI接口描述调用过程,并且包含该接口需要请求传入的参数接口列表。最后一章节将对一个复杂应用场景,获取链路监控信息使用到ARMSOpenAPI接口,对每个接口列表字段、调用过程及返回结果详细介绍。
最佳实践价值
通过调用ARMS OpenAPI在应用场景的使用,直观给阅读者了解到ARMS产品的能力,及ARMS提供一套OpenAPI可以容易的集成到客户应用中,快速实现复杂的微服务链路监控能力,由ARMS监控服务能力涵盖范围能力比较广,包含浏览器、小程序、APP、分布式应用和容器环境,因此完整的监控能力,开发过程中不需要集成多开源组件的形式,使微服务程序监控功能开发简单,让应用运维变得容易。
2. 环境
在使用ARMS前您需要按照以下内容对当前的系统环境进行检查。
本次最佳实践基于专有云企业版V3.10.0版本ARMS。
说明:ARMS OpenAPI各个版本变化不大,使用方式保持一致,所以此文档也适用于公共云产品或专有云V3.7.0以上版本。专有云V3.10.0控制台称为ASCM,V3.10.0之前版本为Apsara Stack。
1.登录ASCM控制台。
2.将鼠标指向页面上方导航栏中的产品,单击企业级分布式应用服务EDAS。
图1:ASCM
说明:由于ARMS监控应用数据,需要EDAS产品配合。本次测试先通过EDAS部署一个标准的Spring Boot应用,开通ARMS监控并得到监控数据。
图 2:EDAS控制台
图 3:ARMS控制台
3.测试工具检查。
本实践将会在专有云环境中创建win64虚拟机,然后在虚拟机中安装Postman进行测试。
图4:Postman测试
3. Open API使用
调用URL确认
OpenAPI接口均为REST服务,首先确认服务的URL。
每个专有云环境域名不同,会导致URL不同。请根据具体环境信息修改URL信息,前缀及端口不变。
http://arms.console.example.com:8099/
名称 | 接口 |
数据集API | /dataset/GeneralQuery.json |
关键应用性能指标 | /metric/Metric.json |
报警信息 | 无 |
应用监控-应用拓扑 | /trace/Dependecies.json |
事件集 | /eventset/EventList.json |
调用示例-查看所有应用:
API说明
URL:http://arms.console.example.com:8099/trace/Services.json
参数列表
字段名称 | 字段类型 | 字段含义 | 是否必选 | 备注 |
_userId | String | 用户id | 是 | 用户名称(如arms_admin) |
返回格式示例
{
"code": 200,
"data": {
"details": [
{
"pid": "string", //应用对应的pid
"regionId": "string",
"serviceName": "string" //应用名称
}
],
"services":[ //应用名称列表
"string",
"string"
]
},
"success": true
}
Postman调用结果
参数设置:_userId= 121827433423****
图5:Postman调用结果
4. 应用描述
从ARMS中取得应用拓扑数据、曲线图、应用监控指标数据,将通过大屏DataV展示。