在“建立監控項目”頁面的API監控中,點擊<建立項目>按鈕建立API監控項目,需要設定以下內容:

設定基本資訊

管理API請求

設定初始變數

設定監控

設定告警


設定基本資訊

在“基本資訊”中設定監控項目的基本資訊,如下圖所示。

1、監控項目名稱

輸入監控項目名稱,以便於查找和區分監控對象。

您需要為監控項目設定一個有代表性的名稱,例如您需要監控在淘寶中提交訂單的業務流程,則可設定監控項目名稱為“淘寶-提交訂單”。

2、描述

輸入對監控項目的說明和備註資訊等。

3、項目是否加入分類

為方便管理自己建立的監控項目,您可為目前監控項目選擇一個項目分類。

您還可以點擊<建立分類>按鈕,新增一個項目分類作為目前監控項目的分類。


管理API請求

在“請求管理”中新增並管理需要監控的API請求,如下圖所示。

1460105028636676.png

您能夠直接匯入腳本來新增API請求,也可手動新增和設定API請求。新增API請求後,可直接複製已新增的請求來建立新的請求。

1、透過匯入腳本新增API請求

為快速建立多筆API請求,點擊<匯入腳本>按鈕,在打開的對話框中直接輸入腳本內容並匯入。匯入成功後,監控專家根據匯入的腳本自動建立對應的API請求。

點擊<查看範例>按鈕了解腳本樣式,腳本支援postman格式,您可以直接使用postman中產生的腳本。

2、手動新增API請求

點擊<新增API監控請求>按鈕,打開請求編輯頁面,如下圖所示。

根據實際需要設定各項內容,詳細說明見下表。

設定項

說明

目標URL

選擇請求方式並填寫監控目標的URL,目前支援的請求方式包括:GET、POST、PUT、DELETE、HEAD和OPTIONS。

認證

點擊<新增認證>按鈕新增身份認證資訊,目前支援的認證方式包括:Basic Auth、OAuth1.0、OAuth2和Digest。

  • 選擇Basic Auth和Digest認證時,需要填寫帳號名稱和密碼,在訪問API時使用。

  • 選擇OAuth1.0和OAuth2認證時,需要在請求API時自動獲取Access_Token和secret,然後透過URL進行傳遞。

1460105094512031.png  設定正確的認證資訊後,才能成功訪問API,從而監控API請求。

HTTP標頭

點擊<新增HTTP標頭>按鈕新增HTTP請求標頭,定義請求需要獲取的內容,包括請求頭及對應的值。

參數

點擊<新增URL參數>按鈕新增URL參數,定義需要傳遞的參數,包括參數名和對應的值。

設定的URL中已經包含了參數時,直接點擊<自動解析參數>按鈕獲取參數即可。您也可以重新編輯或刪除參數。

結果匹配

點擊<新增斷言>按鈕新增斷言,設定斷言的屬性名、比較條件和目標值,從而檢查API請求獲取內容是否與預期內容相匹配。

  • 位置:目前支援的獲取位置包括:JSON Body、XML Body、Text Body、Response Headers和狀態碼,例如選擇“JSON Body”。

  • 屬性名:設定要檢查的屬性名,例如輸入“id”。

  • 比較條件:設定目標值與獲取內容的比較條件,包括為空、不為空、等於、不等於、包含、不包含、是數字、小於、小於等於、大於、大於等於、數值等於等條件,例如選擇“等於”。

  • 目標值:設定判斷獲取內容是否正確的一個標準值。

    點擊<自定義>按鈕輸入一個值;

    點擊<變數>按鈕可直接選擇一個已定義的初始化變數作為目標值,初始化變數需要在“初始變數”中提前定義。例如選擇已定義的變數“$a”。

則設定的斷言的為:在JSON Body中,id的屬性值等於變數“$a”的值,依次判斷獲取內容是否正確。

1460105094512031.png   新增斷言後才能判斷API請求的正確性,匹配則正確性為“是”,否則為“否”。

變數

點擊<提取變數值>按鈕,設定獲取位置、屬性名並選擇初始化變數,則可動態提取屬性值並賦給初始化變數。Text Body支援提取字串,能夠提取動態輸出的數據。

新增請求時間間隔

輸入發送API請求的時間間隔,例如設定“10s”,則發送一次API請求後,等待10s發送第二次API請求。

初始化變數相關內容的詳情說明請參考“設定初始變數”部分。

3、複製API請求

為避免重覆設定,新增API請求後,您可點擊<>圖示複製目前API請求作為一筆新的API請求,點擊<>圖示根據需要修改相應內容即可。

4、測試API監控請求

新增API請求後,為保證正常監控,需檢查是否能請求成功。點擊<測試>按鈕來測試請求並查看測試結果,如下圖所示。

請求成功即可用,所有請求都成功時,監控項目(即整個業務流程)的狀態為正常且可用,點擊<查看結果>查看請求的返回結果。

新增斷言時才能測試請求的正確性,所有請求都正確時監控項目的正確性為“是”,點擊<查看斷言>查看斷言詳情。


設定初始變數

使用變數時需要提前初始化變數,即為變數賦預設值。在“初始變數”中新增並管理初始變數,如下圖所示。

1460105347505664.png

點擊<新增初始化變數>按鈕新增一個變數,設定變數名稱和變數值。變數名稱必須以$符號開頭,並且是純字母組成。

除自定義變數外,您可以使用系統變數,系統變數可用於所有監控項目的API請求,點擊<查看系統函數>按鈕查看可用的系統變數,詳細說明見下表。

變數

使用方式

輸出說明

timestamp

${timestamp()}  

${timestamp(s)}   

${timestamp(ms)}   

Unix時間戳,例如對應的結果為:

20160222121928

1456113541

1456113598686

random()

${random(1,100)}

隨機數,例如1到100之間的一個數。

uuid

${uuid}

通用唯一識別碼 (Universally Unique   Identifier),例如99386c08-6da7-4833-bb31-e70ce747c921

base64()

${base64($username)}

base64編碼值,例如5L2O5aOw6K+0,可以是變數。

md5()

${md5($pwd)}

MD5加密值,例如50b7fe4da64720232c25bc7c6d66f6c5可以是變數。

初始化變數後,您可利用變數來儲存值,動態地提取HTTP回應數據,並在多個請求之間動態地傳遞數據和狀態。比如,新增請求1時,可透過設定變數$a來動態提取Response Header中的Date值。然後在新增請求2時,使用變數$a作為斷言的目標值。


設定監控

在“監控設定”中設定監控選項和自定義告警線,如下圖所示。

1460105674713391.png

1、設定監控選項

設定監控選項的詳細說明見下表。

設定項

說明

監測點

選擇需要監控的監測點。

監控頻率

監控專家執行監控的時間間隔,例如選擇“2”,則監控專家每隔2分鐘就執行一次監控。

重試幾次告警

監控專家發現故障後需要重試幾次才需要發送告警通知,重試時間間隔目前為1分鐘。例如,設定重試1次,那麼監控專家第一次發現故障時,會在1分鐘後重試1次,如果仍然失敗,則發送告警通知。

連續告警提醒

監控專家發送連續告警提醒的時間間隔。例如選擇“4”,則您的監控項目出現故障時,在第一次告警以後,每隔4分鐘,監控專家都將給您發送一次告警。

1460105094512031.png   要實現連續告警提醒,還需要在【設定常規告警通知】中開啟對相應用戶的“連續提醒”功能。

2、設定自定義告警線

您能夠自己定義故障判斷規則,針對監控的指標設定一個閾值作為告警線。在監控過程中,監控專家發現指標超出、低於或是等於您設定的告警閾值時,便會發送告警提醒您。

目前支援的自定義的指標包括目前回應時間、當日可用率(常規)、當日正確率(常規)、目前可用性和目前正確性。點擊<>圖示設定告警線,各選項的詳細說明見下表。

設定項

說明

監控指標描述

為目前指標選擇判定條件,輸入一個數值作為觸發告警的閾值。例如“目前回應時間大於1000ms”。

針對分散式監測點

選擇告警條件針對的監測點:

  • 任意幾個監測點:需要指定監測點個數。

  • 指定常規監測點:需要在監測點列表中選擇特定的監測點。

  • 指定行動監測點:後續將增加行動監測點。

連續觸發幾次告警

連續觸發告警閾值多少次就發送告警通知。例如選擇“2”,則連續2兩次觸發告警閾值,監控專家就發送告警通知。

是否立即開啟

選擇“開啟”啟用目前告警線;選擇“關閉”則不使用目前告警線。


五、設定告警

在“告警設定”中設定常規告警方式,如下圖所示。

1460105868121680.png

選擇告警用戶及對應的告警方式即可,設定的項目公開範圍決定了可選擇的用戶。但請注意以下事項:

  • 在設定常規告警通知時,請確保您選擇的告警接收用戶已在【用戶中心→通知設定】的對應通知方式中開啟了“接收告警通知”選項,並已經完成了以下操作,以保證及時接收監控專家發送的告警通知:

    填寫用於接收告警通知的Email和行動電話號碼。

    下載並安裝行動端APP。

    開通並綁定了微信。

  • 告警方式對應的復選框後顯示“1460105885455696.png”圖示時,說明目前用戶沒有設定該告警方式,您需要提醒該用戶盡快設定以免影響接收告警通知。

  • 選擇“連續告警”時,請確保您已在“設定監控選項”中設定了連續告警提醒頻率,否則無法實現連續告警。

本次設定的告警方式將作為下次建立監控項目的預設通知方式。