深度解析 API 监控那些事儿

本文涉及的产品
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
云解析 DNS,旗舰版 1个月
简介:

API已成为经济生态

API是随着互联网和云计算的兴起而催生的产物。像云供应商亚马逊、互联网巨头Google、社交媒体Twitter,他们的服务都是通过API的方式来提供的。API这个概念在2005年从国外就开始火起来了,同时歪果仁提出了“API经济”的概念。

图:2012年数据

IBM中间件总经理Marie L. Wieck在一次采访中指出,到2018年API经济的市场规模预计将达到2.2万亿美元,而在未来2-3年中,开展API项目的企业数量有望增长150%。API监控可持续考察API的正确性、可用性和响应时间,是API管理的重要部分。

图:IBM的API经济整合方案

国内API监控兴起

随着越来越多的国内零售商、媒体、政府和金融服务公司开始公开Web API,每天都有大量的API增长。API已经成为扩展产品、获取客户,帮助合作伙伴提供高价值服务以及扩张生态系统的关键渠道。令人惊讶的是,API监控工具,却远远少于其他系统的监控工具。

稳定的API能帮助企业提高收入,降低成本。随着移动应用的爆发增长,未来API将会使用的越来越多,不论是提供API的服务商还是使用API的公司,都不希望发生这样的情景:

  • 利用第三方公司提供的应用程序API失败,导致业务中断,交易失败。
  • 旅游网站通过API获取机票和酒店库存信息并抽取佣金,API调用失败导致失去一个客户或是一次机会。
  • 其他数据源信息的API调用失败,影响自己的内容整合。
  • 公司内部产品之间API不稳定导致业务下滑。
  • ……

公司提供出去的API稳定性直接影响业务收入。

于是,云智慧监控宝率先推出“API监控服务”,用于有效监控API服务稳定性和正确性。我们希望API能够达到,在Web上每一个想要使用API的人都能调用它,并得到他们所想的结果。

云智慧监控宝API监控原理

云智慧作为国内最专业的应用性能管理服务商,是业内第一家提供API监控的应用性能管理服务商。通过监控宝切入API监控领域,是为了保障服务的“可用性”,保障的是“所有用户”。因为前端出现问题,影响的是服务的易用性,受影响的往往是一部分用户;而后端API出现问题,影响的是服务的可用性,受影响的将会是全部用户。

现在我们手机里安装的是各种原生APP,这些APP都是典型的三层架构,要确保API的正常运行,不但要监控单个API请求,还应该监控连续请求构成的事务,同时通过多监测点监控API的可用性、正确性和响应时间,来确保接口运行时的一致性、完整性、正确性和及时性。

监控宝API监控的正确性是以断言来判断的,当没有断言或者多监测点部分正确,下图解释了怎么去界定API的正确性。

再如API的响应时间,对1点多次,多点1次,多点多次,以及不正确,不可用,我们怎么计算响应时间?如何处理这种非正常数据?在新版API监控中都进行算法上的优化,保证用户得到最精确的结果。

图:监控宝如何定义API响应时间

图:监控宝如何定义API是否可用

云智慧监控宝的API监控,我们详细定义了很多监控指标,比如可用性包括了超时设定,返回码和监测点部分可用情况下的API可用性。为什么返回码不再是原来的200呢,因为除了200以外,用户还有很多不同数值的正常返回码。

API 请求,请求返回码为 1XX、 2XX 或 3XX 时,都视为请求成功。

API 事务,其所有请求都成功时,则视为成功;否则返回其顺序请求的第一个非成功码(1XX、2XX、 3XX 之外的返回码)。

API 请求未设置断言时,请求返回码默认为 200(请求成功)。

新版API监控优化上线

云智慧监控宝的API监控发布以来,获得了大量用户的认可,但也得到了很多修改意见,这次我们对API进行了一次重要的改善。

这次云智慧推出的新版API监控,主要是为了解决API监控现存的几个主要问题:数据展现不直观、不能完整分析业务、指标算法不完善、不能联系告警、告警及时性不强等。

图:新版API监控概览页 

1、完整的API“事务”监控能力

实时掌握每一次API接口响应时间、可用性和正确性

API事务中,若其中的1个API请求不可用,则整体业务的API事务变得不可用。API监控可以从业务视角做完整的API事务监控。

2、连续告警,保障业务的可用性

告警方式新增“当前可用性”和“当前正确性”告警指标;新增了“连续告警”的 通知方式。

3、可视化数据展现更直观

新的API监控详情页,采用了类似网站监控的呈现方式,各监测点状况可在地图上直观呈现。详情页可快速查看TOP5的最低可用率、最长故障时间、最多故障次数、最低正确率、最长错误时间、最多错误次数、最慢响应时间、最快响应时间数据图表,以及各监测点的相应监控数据。

 

4、可监控更多请求方式

  • 支持API的get、post、put、delete、head、options六种请求。
  • 支持Basic Auth, OAuth1.0, OAuth2, Digest认证方式。
  • 支持添加HTTP头Header和Value。
  • 支持添加URL参数。
  • 支持JSON、XML、Text、Response Status验证及脚本导入。

API监控怎么用

以这几天北京雾霾红色预警为例,很多APP都非常贴心的提供了PM2.5污染指数这个天气预报的公开接口,怎么监控这种接口呢?

1、创建和配置API监控项目

在“创建监控项目”页面的API监控中,点击<创建项目>按钮创建API监控项目,需要设置监控项目的基本信息、API请求、初始变量、监控选项和告警方式。

在“基本信息”中设置监控项目的基本信息,如下图所示。

 

在“请求管理”中添加并管理需要监控的API请求,如下图所示。

2、测试API监控请求

添加API请求后,为保证正常监控,需检查是否能请求成功。点击<测试>按钮来测试请求并查看测试结果,如下图所示。

这是一种单请求API,对这种API的监控非常简单,开发者只要设置断言判断接口数据的正确性就可以了。监控宝API监控在新建请求时,可以直接点“测试”按钮,即时确认API设置的正确性,我们的断言支持jsonPath和xPath语言。

对于多步请求的API,我们提出了的“事务”概念,这种API监控怎么处理呢?这种多步连续的API,往往后面的请求会从前面的API结果去取变量,整个流程组合起来才能构成完整业务。

在第一个请求,我们可以设置初始变量,然后由后面的请求来取。

然后对每一个请求,在需要的地方添加参数,添加变量。

后面的请求,就可以直接动态提取变量。

我上面取的是监控宝API的token请求。 

3、查看API监控项目数据

在监控项目列表中,点击监控项目查看监控项目详情,如下图所示。

在监控项目详情页面,您能够:

  • 查看监控项目的基本信息,包括当前监控项目的名称、事务流程和监控频率。点击“事务流程”选择API请求,查看单个API请求的监控详情。
  • 查看概览、可用率统计、正确率统计、响应时间统计、告警消息等信息。
  • 执行快捷设置,包括设置自定义告警和告警通知。
  • 管理监控项目,包括添加分类、开启/暂停监控、修改监控和删除监控项目。

4、查看告警消息

在“告警消息“页面查看所有告警消息记录,包括故障信息、提醒消息和系统消息。

告警消息以天为单位显示,最新告警消息显示在最上方。您可在上方的时间栏中自定义时间范围。

告警消息分类说明

 

来云智慧监控宝,亲自体验API监控吧。



本文来自云栖社区合作伙伴“Linux中国”

原文发布时间为:2013-04-02.

相关文章
|
1月前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
70 2
|
2天前
|
数据采集 JSON API
如何利用Python爬虫淘宝商品详情高级版(item_get_pro)API接口及返回值解析说明
本文介绍了如何利用Python爬虫技术调用淘宝商品详情高级版API接口(item_get_pro),获取商品的详细信息,包括标题、价格、销量等。文章涵盖了环境准备、API权限申请、请求构建和返回值解析等内容,强调了数据获取的合规性和安全性。
|
1天前
|
JSON 自然语言处理 Java
OpenAI API深度解析:参数、Token、计费与多种调用方式
随着人工智能技术的飞速发展,OpenAI API已成为许多开发者和企业的得力助手。本文将深入探讨OpenAI API的参数、Token、计费方式,以及如何通过Rest API(以Postman为例)、Java API调用、工具调用等方式实现与OpenAI的交互,并特别关注调用具有视觉功能的GPT-4o使用本地图片的功能。此外,本文还将介绍JSON模式、可重现输出的seed机制、使用代码统计Token数量、开发控制台循环聊天,以及基于最大Token数量的消息列表限制和会话长度管理的控制台循环聊天。
20 7
|
14天前
|
机器学习/深度学习 搜索推荐 API
淘宝/天猫按图搜索(拍立淘)API的深度解析与应用实践
在数字化时代,电商行业迅速发展,个性化、便捷性和高效性成为消费者新需求。淘宝/天猫推出的拍立淘API,利用图像识别技术,提供精准的购物搜索体验。本文深入探讨其原理、优势、应用场景及实现方法,助力电商技术和用户体验提升。
|
16天前
|
监控 数据管理 测试技术
API接口自动化测试深度解析与最佳实践指南
本文详细介绍了API接口自动化测试的重要性、核心概念及实施步骤,强调了从明确测试目标、选择合适工具、编写高质量测试用例到构建稳定测试环境、执行自动化测试、分析测试结果、回归测试及集成CI/CD流程的全过程,旨在为开发者提供一套全面的技术指南,确保API的高质量与稳定性。
|
26天前
|
JSON API 数据格式
二维码操作[二维码解析基础版]免费API接口教程
此接口用于解析标准二维码内容,支持通过BASE64编码或远程图片路径提交图片。请求需包含用户ID、用户KEY、图片方式及图片地址等参数,支持POST和GET方式。返回结果包括状态码和消息内容,适用于图片元素简单的二维码解析。
|
7天前
|
供应链 搜索推荐 数据挖掘
1688搜索词推荐API接口:开发应用与收益全解析
在电商数据驱动时代,1688搜索词推荐API接口为开发者、供应商及电商从业者提供强大工具,优化业务流程,提升竞争力。该接口基于1688平台的海量数据,提供精准搜索词推荐,助力电商平台优化搜索体验,提高供应商商品曝光度与销售转化率,同时为企业提供市场分析与商业洞察,促进精准决策与成本降低。通过集成此API,各方可实现流量增长、销售额提升及运营优化,推动电商行业的创新发展。
17 0
|
13天前
|
监控 搜索推荐 测试技术
电商API的测试与用途:深度解析与实践
在电子商务蓬勃发展的今天,电商API成为连接电商平台、商家、消费者和第三方开发者的重要桥梁。本文深入探讨了电商API的核心功能,包括订单管理、商品管理、用户管理、支付管理和物流管理,并介绍了有效的测试技巧,如理解API文档、设计测试用例、搭建测试环境、自动化测试、压力测试、安全性测试等。文章还详细阐述了电商API的多样化用途,如商品信息获取、订单管理自动化、用户数据管理、库存同步、物流跟踪、支付处理、促销活动管理、评价管理、数据报告和分析、扩展平台功能及跨境电商等,旨在为开发者和电商平台提供有益的参考。
21 0
|
29天前
|
JSON API 开发者
微店(Weidian)商品详情API接口解析实战
微店(Weidian)是一个基于社交关系的电商平台,为商家提供了一整套的电商解决方案。微店API接口允许开发者通过编程方式访问和操作微店平台上的数据,从而可以创建自动化的工具、应用或集成服务。
|
2月前
|
缓存 Java 程序员
Map - LinkedHashSet&Map源码解析
Map - LinkedHashSet&Map源码解析
76 0

推荐镜像

更多