全部产品
云市场

通过日志服务查看API调用日志

更新时间:2018-03-29 11:27:57

API网关日志服务实现无缝集成,通过日志服务您可以进行实时日志查询、下载、多维度统计分析等,您也可以将日志投递到OSS或者MaxCompute

业务示意图

1 功能简介

1.1 日志在线查询

可根据日志中任意关键字进行快速的精确、模糊检索,可用于问题定位或者统计查询。

1.2 详细调用日志

您可以检索API调用的详细日志包含:

日志项 描述
apiGroupUid API的分组ID
apiGroupName API分组名称
apiUid API的ID
apiName API名称
apiStageUid API环境ID
apiStageName API环境名称
httpMethod 调用的HTTP方法
path 请求的PATH
domain 调用的域名
statusCode HttpStatusCode
errorMessage 错误信息
appId 调用者应用ID
appName 调用者应用名称
clientIp 调用者客户端IP
exception 后端返回的具体错信息
providerAliUid API提供者帐户ID
region 区域,如:cn-hangzhou
requestHandleTime 请求时间,UTC
requestId 请求ID,全局唯一
requestSize 请求大小,单位:字节
responseSize 返回数据大小,单位:字节
serviceLatency 后端延迟,毫秒

1.4 自定义分析图表

您可以根据统计需求将任意日志项自定义统计图表,以满足您日常的业务需要。

1.3 预置分析报表

为能让您快速使用,API网关预定义了一些统计图表(全局)。包括:请求量大小、成功率、错误率、延时情况、调用API的APP数量,错误情况统计、TOP 分组、TOP API、Top 延迟等等。

2 使用日志服务查看API日志

2.1 配置日志服务

使用此功能前,请确保您已经开通了日志服务,并创建Project和Logstore,点击开始创建

您可以在API网关的控制台上来配置,也可以在日志服务控制台上来配置。

2.1.1 在API网关控制台配置

1)打开API网关控制台-【开放API】-【日志管理】,选择您服务所在的区域,下图以华北1为例:

创建

2)点击”创建日志配置”,进入日志配置界面

配置

3)选择您所需要输入的日志服务的Project或者Logstore,若无法选择,请点击“授权日志写操作”,点击后会进行授权操作

授权

4)确认后,完成网关与日志服务的关联

5)开启索引后完成配置

2.1.1.2 在日志服务控制台配置

您可以参照:API网关访问日志

配置完成后,您的API调用记录即可进入日志服务的Logstore中

2.2 查看日志

你可以点击API网关控制台-【开放API】-【日志管理】-“访问日志”,跳转到日志控制台,根据日志服务的查询语法,在线检索调用日志。如图:

查看

你也可以登录日志服务控制台查看日志,可参照:查询日志

2.3 查询预定义报表

预定义报表,是API网关为了方便用户统计查询,而预置的一些统计报表,可以点击API网关控制台-【开放API】-【日志管理】-“日志统计”来访问。也可以在日志服务控制台来查看:

日志

2.4 自定义查询报表

你可以根据自身业务需要自定义查询报表,请参照定义方法:仪表盘

3 维护日志

您打开API网关控制台-【开放API】-【日志管理】,进行“修改配置”或者删除配置。

  • 修改配置:为更换新日志服务的Project或者Logstore,更换后的API调用日志将会写入新的Logstore,但历史数据仍会保留在原Logstore中,不会跟随迁移。
  • 删除配置:为删除API网关与日志服务的映射关系,删除后将不会再同步API调用日志到日志服务,但并不会删除Logstore中已有的数据。