Eolink Apikit 如何對所有 API 異常請求實(shí)時(shí)監(jiān)控 ?

API 監(jiān)控適合業(yè)務(wù)在互聯(lián)網(wǎng)上粥喜,并且用戶來自多個(gè)不同的地區(qū),且對API的要求較高的場合,用于解決以下的問題:

  1. 發(fā)現(xiàn)由于網(wǎng)絡(luò)中斷或者是API響應(yīng)異常等導(dǎo)致的服務(wù)不可用;
  2. 及時(shí)對異常的API進(jìn)行告警;
  3. 記錄監(jiān)控的日志肠虽,方便排查幔戏。

Eolink Apikit 除了提供 API 的管理和自動(dòng)化測試等功能,還提供 API 監(jiān)控服務(wù)税课,可以為 API 設(shè)置定時(shí)撥測闲延,并且支持多節(jié)點(diǎn)監(jiān)控,可以從多個(gè)不同的地區(qū)節(jié)點(diǎn)來模擬用戶的請求進(jìn)行監(jiān)控韩玩。


1垒玲、創(chuàng)建流程監(jiān)控

API 流程監(jiān)控可以同時(shí)對多個(gè) API 進(jìn)行監(jiān)控,你可以設(shè)置多個(gè) API 的監(jiān)控順序找颓,數(shù)據(jù)關(guān)聯(lián)等信息合愈,滿足對重點(diǎn)業(yè)務(wù)場景、操作流程的監(jiān)控击狮。

進(jìn)入場景監(jiān)控設(shè)置頁面佛析,點(diǎn)擊 添加流程 按鈕,進(jìn)入流程編輯頁面彪蓬。

在流程編輯頁面中設(shè)置流程的名稱寸莫、監(jiān)控環(huán)境、監(jiān)控頻率档冬、監(jiān)控節(jié)點(diǎn)等信息膘茎。


2、為流程添加 API

1. 添加 API

進(jìn)入流程編輯頁后酷誓,點(diǎn)擊添加 監(jiān)控步驟 按鈕披坏,在下拉菜單中可以選擇從 Eolinker API Management(API 管理產(chǎn)品)中導(dǎo)入 API 信息,或者手動(dòng)創(chuàng)建監(jiān)控 API盐数。

2. 設(shè)置 API 監(jiān)控信息

點(diǎn)擊 新建空白API步驟 的按鈕刮萌,進(jìn)入 API 的編輯頁后,你可以設(shè)置 API 的基本信息娘扩、請求信息着茸、校驗(yàn)規(guī)則等內(nèi)容。

API監(jiān)控的基礎(chǔ)信息包括:

  • API請求地址
  • API分組琐旁、名稱
  • 超時(shí)限制:當(dāng)API的響應(yīng)時(shí)間超出設(shè)定的限制時(shí)間時(shí)涮阔,系統(tǒng)將會(huì)自動(dòng)中斷該次監(jiān)控請求,并且報(bào)請求超時(shí)異常灰殴。

3. 請求頭部

你可以輸入或?qū)胝埱箢^部敬特。批量導(dǎo)入的數(shù)據(jù)格式為 key : value 掰邢,一行一條 header 信息,如:

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

4. 請求體

請求體支持以下類型:Form-data(表單)伟阔、JSON辣之、XML、Raw(自定義文本類型數(shù)據(jù))皱炉。

5. Query 參數(shù)

Query參數(shù)指的是地址欄中跟在問號 ? 后面的參數(shù)怀估,如以下地址中的 user_name 參數(shù):

shop/query?shop_id=001

批量導(dǎo)入的數(shù)據(jù)格式為 ?key=value ,通過 & 分隔多個(gè)參數(shù)合搅,如:

api.eolinker.com/user/login?user_name=jackliu&user_password=hello

6. REST 參數(shù)

REST參數(shù)指的是地址欄被斜杠 / 分隔的參數(shù)多搀,如以下地址中的 user_nameuser_password 參數(shù)灾部。

/user/login/{user_name}/{user_password}

注意:只需要在URL中使用 {} 將REST參數(shù)括起來康铭,下方的請求參數(shù)名中不需要使用 {}

7. 權(quán)限校驗(yàn)

如果訪問API時(shí)需要先進(jìn)行身份驗(yàn)證赌髓,可以在權(quán)限校驗(yàn)處填寫校驗(yàn)的信息从藤。


3、設(shè)置 API 之間的數(shù)據(jù)關(guān)系

同一個(gè)流程里的不同 API 之間可以進(jìn)行數(shù)據(jù)關(guān)聯(lián)锁蠕。比如一個(gè)監(jiān)控流程里有兩個(gè) API:

  • 門店創(chuàng)建(/shop/create):創(chuàng)建門店后呛哟,會(huì)得到返回參數(shù) shop_id
  • 門店查詢(/shop/query):根據(jù) shop_id 來查詢具體的門店匿沛。

我們先設(shè)置門店創(chuàng)建API的請求參數(shù)和預(yù)設(shè)返回結(jié)果扫责。進(jìn)入用戶登錄API的編輯頁面:

然后我們設(shè)置門店查詢API。門店查詢API只有一個(gè)請求參數(shù) shop_id逃呼,shop_id 的參數(shù)值通過門店創(chuàng)建API的返回結(jié)果獲得鳖孤。進(jìn)入門店查詢API的編輯頁面,設(shè)置門店查詢API的請求參數(shù)抡笼,點(diǎn)擊參數(shù)值的輸入框時(shí)苏揣,上方會(huì)出現(xiàn)兩個(gè)按鈕,點(diǎn)擊 引用參數(shù)值 按鈕:

在彈窗中選擇要綁定的API以及返回參數(shù)名稱:

點(diǎn)擊 確認(rèn) 按鈕即可將用戶創(chuàng)建API的返回結(jié)果綁定到門店查詢API的請求參數(shù)中推姻。

在執(zhí)行流程監(jiān)控的時(shí)候平匈,系統(tǒng)會(huì)自動(dòng)將門店創(chuàng)建API的 shop_id 的返回參數(shù)動(dòng)態(tài)綁定到門店查詢API的請求參數(shù)中:


4、改變流程的 API 順序

拖動(dòng) API 列表可以改變 API 的執(zhí)行順序藏古。但是如果 API 之間存在數(shù)據(jù)關(guān)聯(lián)增炭,則拖動(dòng)步驟有可能會(huì)破壞 API 之間的數(shù)據(jù)關(guān)聯(lián),導(dǎo)致無法正常獲得綁定的參數(shù)值拧晕。


5隙姿、開啟流程監(jiān)控

流程創(chuàng)建好之后,可以在流程頁面的上方點(diǎn)擊 開啟監(jiān)控 按鈕厂捞,來開啟流程的監(jiān)控:

也可以在流程列表输玷,操作欄出點(diǎn)擊 更多 按鈕队丝,在下拉菜單選擇 開啟監(jiān)控

還可以通過流程列表頂部的 批量操作 按鈕,來開啟監(jiān)控:


生產(chǎn)環(huán)境可能存在同時(shí)運(yùn)行多個(gè)版本的代碼欲鹏,并且每個(gè)版本的代碼都有可能獨(dú)立迭代机久,最終分化出不同的版本。如果我們需要對歷史版本的API進(jìn)行自動(dòng)化測試赔嚎,或者通過監(jiān)控來驗(yàn)證線上的穩(wěn)定性膘盖,那么我們可以給每一個(gè)版本的API創(chuàng)建一個(gè)項(xiàng)目。因?yàn)樵?Eolink Apikit 中尽狠,我們可以為每一個(gè)項(xiàng)目設(shè)置監(jiān)控,并且可以獨(dú)立運(yùn)行測試用例叶圃,滿足復(fù)雜的API治理的需求袄膏。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市掺冠,隨后出現(xiàn)的幾起案子沉馆,更是在濱河造成了極大的恐慌,老刑警劉巖德崭,帶你破解...
    沈念sama閱讀 221,635評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件斥黑,死亡現(xiàn)場離奇詭異,居然都是意外死亡眉厨,警方通過查閱死者的電腦和手機(jī)锌奴,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,543評論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來憾股,“玉大人鹿蜀,你說我怎么就攤上這事》颍” “怎么了茴恰?”我有些...
    開封第一講書人閱讀 168,083評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長斩熊。 經(jīng)常有香客問我往枣,道長,這世上最難降的妖魔是什么粉渠? 我笑而不...
    開封第一講書人閱讀 59,640評論 1 296
  • 正文 為了忘掉前任分冈,我火速辦了婚禮,結(jié)果婚禮上霸株,老公的妹妹穿的比我還像新娘丈秩。我一直安慰自己,他們只是感情好淳衙,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,640評論 6 397
  • 文/花漫 我一把揭開白布蘑秽。 她就那樣靜靜地躺著饺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪肠牲。 梳的紋絲不亂的頭發(fā)上幼衰,一...
    開封第一講書人閱讀 52,262評論 1 308
  • 那天,我揣著相機(jī)與錄音缀雳,去河邊找鬼渡嚣。 笑死,一個(gè)胖子當(dāng)著我的面吹牛肥印,可吹牛的內(nèi)容都是我干的识椰。 我是一名探鬼主播,決...
    沈念sama閱讀 40,833評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼深碱,長吁一口氣:“原來是場噩夢啊……” “哼腹鹉!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起敷硅,我...
    開封第一講書人閱讀 39,736評論 0 276
  • 序言:老撾萬榮一對情侶失蹤功咒,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后绞蹦,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體力奋,經(jīng)...
    沈念sama閱讀 46,280評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡胁后,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,369評論 3 340
  • 正文 我和宋清朗相戀三年晶渠,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了妄痪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片闺兢。...
    茶點(diǎn)故事閱讀 40,503評論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡趴久,死狀恐怖贱纠,靈堂內(nèi)的尸體忽然破棺而出鸳谜,到底是詐尸還是另有隱情本刽,我是刑警寧澤挪蹭,帶...
    沈念sama閱讀 36,185評論 5 350
  • 正文 年R本政府宣布亭饵,位于F島的核電站,受9級特大地震影響梁厉,放射性物質(zhì)發(fā)生泄漏辜羊。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,870評論 3 333
  • 文/蒙蒙 一词顾、第九天 我趴在偏房一處隱蔽的房頂上張望八秃。 院中可真熱鬧,春花似錦肉盹、人聲如沸昔驱。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,340評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽骤肛。三九已至纳本,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間腋颠,已是汗流浹背繁成。 一陣腳步聲響...
    開封第一講書人閱讀 33,460評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留淑玫,地道東北人巾腕。 一個(gè)月前我還...
    沈念sama閱讀 48,909評論 3 376
  • 正文 我出身青樓,卻偏偏與公主長得像絮蒿,于是被迫代替她去往敵國和親尊搬。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,512評論 2 359

推薦閱讀更多精彩內(nèi)容