探索更简单的接口日志实现

一、问题

在实际的产品实现和开发过程中我们会接触到各种各样的接口,有我们请求第三方的,有我们自己作为接口提供方的。某些情况下,为了接口数据排错,数据分析,以及业务优化,对接口数据进行日志监控很有必要。

在诸多的接口请求或响应中,当接口数量变多或业务变复杂之后,在实际的操作中需要对接口数据进行排查,快速定位到异常接口并查出接口的请求和响应参数,以此来复盘分析可能出现的问题。

例如:某订单支付业务出现异常,导致下单失败。现在需要对该问题进行排查,以确定是因为接口问题导致的支付异常,还是实际的业务逻辑错误导致的支付异常,亦或是其他情况引起的。此时,我需要知道是谁请求了我的接口,若能根据相关的条件(支付账户,支付时间,支付人等)快速查出当时的接口请求和响应日志,那么就能快速定位到问题所在,最起码也能最大程度的还原当时的场景,反之,没有相关的接口监控日志,要想还原场景,重现问题,就变得很麻烦。

那么,如何设计一套简单易用的接口数据监控组件呢? 我们继续往下看。

二、思路

先整理一下接口流程和实现思路:

设想:如果我们能在A点和B点记录下接口的相关数据(主要是请求数据a和响应数据b),那么我们就能对该接口进入和流出的数据进行日志监控了。

最简单的方式就是在A点和B点分别埋下日志锚点,接口流程走到此处记录下相关数据。这确实可行,但是稍显麻烦,意味着要想捕获接口数据,每个接口都需要至少两段代码,对开发者而言,无异于重复造轮子。

那我们再深入思考一下,既然是需要对接口进入的数据流和返回的数据进行监控,又是在.Net平台下,那我们很容易想到另外一种讨巧的方式,使用C#原生的Attribute特性去监控每个接口(Method)的数据。

值得注意的是,在系统尚未接入ELK日志平台,且系统业务还未达到十分庞大的量级前,如何简单并高效的记录各接口日志数据满足当前业务需求才是关键。

所以,对于接口组件起码要满足以下2点:

(1)对于开发者而言,调用你的日志组件要足够简单,最大程度的降低学习成本;

(2)对于业务而言,记录的接口日志数据要足够详细,查找分析数据要足够方便。

结合米多来发平台早期的业务发展和项目需要,我们需要设计出一套合理的接口日志组件提供给普通开发者使用。前面已经说了,基于平台和编程语言的考虑,我们决定使用Attribute来设计一套底层接口日志组件。

三、简单实现

说做就做,根据以上的构思,一步步实现:

  1. 设计一张数据库接口日志表,用以保存分析接口数据,主要字段如下图:
  1. 新建一个接口日志帮助类LogFilterAttribute,因为我们只需要对接口数据进行监控,所以该类只需要作用在方法(Method)上,所以简要设置目标属性,如图:
  1. 重写OnActionExecuting方法,用以在接口收到请求后捕获请求内容:
  1. 重写OnActionExecuted方法,用以在接口业务逻辑执行完成后捕获接口返回的响应内容:
  1. 经过以上步骤,我们已经完成了基于Attribute实现的接口内容的捕获和记录。在需要记录接口日志数据的接口方法上,直接添加Attribute标记,设置相关的参数,即可实现接口数据捕获,使用非常简单,如图:
  1. 试着请求该接口,然后查看数据库中记录的接口日志数据如下:
  1. 通过查看数据库中记录的数据,即可快速定位到每个接口的请求日志,如果还需要记录接口的其他数据,则直接在OnActionExecuting和OnActionExecuted方法里面扩展即可。

  2. 为了避免每次都要去打开数据库客户端查询接口日志数据,还可以添加一个接口日志管理的功能模块,将接口日志可视化,这一部分不展开讲解,实现效果如图:

接口可视化-列表
接口可视化-详情
  1. 以上便实现了一个简单的接口日志数据管理组件的开发。

四、其他

由于业务型的平台业务量增长速度都比较快,达到一定数量级之后,如果还是采用这种方式,数据库的性能可能就会受到影响,当系统接口业务量过大时,为了避免频繁读写数据库,可以将得到的日志数据接入ELK平台,或者高并发的时候,对于日志数据实时性要求不高的接口,可以先写入消息队列,再移到数据库中,又或者进行读写分离等。

这个利用Attribute特性制作的接口日志监控组件,还可以扩展出很多有意思的东西,做出更多精细化的日志组件,此处不展开赘述。

对于开发者来说,使用的时候打一个标签就能完成接口日志的记录,对于业务而言,能够快速查到每个接口的分析数据,就已经完成了我们最开始的目标。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,183评论 6 516
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,850评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 168,766评论 0 361
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,854评论 1 299
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,871评论 6 398
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,457评论 1 311
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,999评论 3 422
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,914评论 0 277
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,465评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,543评论 3 342
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,675评论 1 353
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,354评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,029评论 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,514评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,616评论 1 274
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,091评论 3 378
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,685评论 2 360

推荐阅读更多精彩内容