Azure Application Insights REST API使用教程
本文是Azure Application Insights REST API的簡單介紹,并會包含一個通過Python消費API的示例/小工具。
新加入的team中的一項工作是制作日常的運維報表,制作方式是手工前往portal.azure.com,在網頁中多次執行不同的查詢語句、導出excel,之后再人工進行合并、分組、匯總、分析等等。這是一個繁瑣的過程,其中大部分步驟其實不值得花費人工,應該交給程序。為了自動化這一過程,降低報表的制作成本,我嘗試使用了Azure Application Insights REST API查詢數據,使用python客戶端進行處理、輸出。下面把相關的一些知識和經驗寫在這里。
本文鏈接:https://www.cnblogs.com/hhelibeb/p/11543295.html
原創內容,轉載請注明
Application Insights
Application Insights是Azure平臺的監控功能的一部分,用于收集、分析和處理來自Azure或其它本地環境的遙測數據。它包含強有力的分析工具,可以幫助你發現問題、診斷問題、理解用戶在app上的行為,可以支持你持續地改進應用的性能和可用性。它可以和DevOps過程集成,和很多開發工具有連接點。
它支持多種語言和框架,比如.NET, Java, 和Node.js等。
更多信息,參考:What is Application Insights?
Application Insights REST API
除了在Azure中使用外,Application Insights收集的數據也可以通過REST API獲取,這使得你可以用自己的其它應用來使用相關數據。API可以分為3種:
Metrics:?用于查詢聚合結果,比如一定時間范圍內的系統異??倲盗?。
Events:?使用OData語法訪問event數據,支持$filter, $orderBy, $search, $apply, $top, $skip and $format,可以返回單獨的event數據或者event集的聚合數據。
Query:?允許用戶發送和在Application Insights Analytics中一樣的Query查詢數據,返回數據的同時也會返回數據的schema。這是我用到的類型。
格式
API的格式如下,
其中,
hostname:?api.applicationinsights.io
resource: Application ID ,也就是你的Application Insights app的唯一標識符,可以在app的API Access選項中看到,見下圖。(注意:這不是Instrumentation Key,不要用錯)
api-version:?路徑中需要包含API versions,Beta或v1。
area: 3中查詢類型之一metrics, events或query。
path:?查詢的詳細信息,比如要查詢哪個metric。?
parameters:?和path相關的具體參數。
(這里是有關Public API format的部分,此外還有Azure API format)
認證
需要使用上文提到的Application ID和下面提到的API Key來訪問API,否則調用接口會失敗,返回認證錯誤的消息,比如,
AuthorizationRequiredError:"Valid authentication was not provided"。
在API Access選項下選擇Create API key,填寫描述并勾選"Read telemetry"。
點擊Generate key,會得到一個key字符串。注意,在這里必須保存key,因為關閉頁面之后,無法通過任何方式再查詢到生成的key。如果key丟失,只能重建另一個key。
訪問
有了Application ID和API key,就可以訪問API了。
這個頁面有一個很好的例子,可以參考:
GET/Query
可以用postman之類的工具測試http請求。
自己寫的query工具
因為程序可能需要對不同的Application Insight的不同的API執行不同的Query,因此,基本的處理思路是在配置文件中配置相關信息,程序從配置文件中讀取需要執行的全部query,逐一查詢后,返回結果列表。
下面是json格式的配置文件(profile.json)和python代碼。
配置文件
說明,
host:固定值http://api.applicationinsights.io
apps:Application Insight相關數據。
apis:Api相關數據。
queries:需要執行的query。
default_filter:默認的查詢條件,目前只有默認時間功能,例子里的條件是最近7個整天。
查詢
查詢代碼如下:
基本思路是從配置文件加載queries,逐個放入任務列表中,最后統一并發執行、獲取結果。
其中使用了request發送http請求、asyncio實現并發。
總結
本文是我關于Azure Application Insights REST API的知識和實踐的總結。這不是Azure Application Insights REST API的全部,可以參考微軟文檔以獲取更多信息。
總結
以上是生活随笔為你收集整理的Azure Application Insights REST API使用教程的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: .NET生态系统概览
- 下一篇: 微软开源新字体Cascadia Code