在使用python日志異步發送到遠程服務器的方式--你是這樣的嗎!


在python中使用日志最常用的方式就是在控制台和文件中輸出日志了,logging模塊也很好的提供的相應的類,使用起來也非常方便,但是有時我們可能會有一些需求,如還需要將日志發送到遠端,或者直接寫入數據庫,這種需求該如何實現呢?

一、StreamHandler和FileHandler

首先我們先來寫一套簡單輸出到cmd和文件中的代碼


首先初始化一個logger, 並且設置它的日志級別是DEBUG,然后添初始化了 cmd_handler和 file_handler, 最后將它們添加到logger中, 運行腳本,會在cmd中打印出 [2020-09-23 10:45:56] [DEBUG] 今天天氣不錯 且會寫入到當前目錄下的debug.log文件中.

二、添加HTTPHandler

如果想要在記錄時將日志發送到遠程服務器上,可以添加一個 HTTPHandler , 在python標准庫logging.handler中,已經為我們定義好了很多handler,有些我們可以直接用,本地使用tornado寫一個接收日志的接口,將接收到的參數全都打印出來


結果在服務端我們收到了很多信息


可以說是信息非常之多,但是卻並不是我們想要的樣子,我們只是想要類似於 [2020-09-23 10:45:56] [DEBUG] 今天天氣不錯 這樣的日志.

logging.handlers.HTTPHandler 只是簡單的將日志所有信息發送給服務端,至於服務端要怎么組織內容是由服務端來完成. 所以我們可以有兩種方法,一種是改服務端代碼,根據傳過來的日志信息重新組織一下日志內容, 第二種是我們重新寫一個類,讓它在發送的時候將重新格式化日志內容發送到服務端.

我們采用第二種方法,因為這種方法比較靈活, 服務端只是用於記錄,發送什么內容應該是由客戶端來決定。

我們需要重新定義一個類,我們可以參考 logging.handlers.HTTPHandler 這個類,重新寫一個httpHandler類

每個日志類都需要重寫emit方法,記錄日志時真正要執行是也就是這個emit方法


上面代碼中有一行定義發送的參數 msg = self.format(record)

這行代碼表示,將會根據日志對象設置的格式返回對應的內容.

之后再將內容通過requests庫進行發送,無論使用get 還是post方式,服務端都可以正常的接收到日志

{'log': [b'[2020-09-23 11:39:45] [DEBUG] \xe4\xbb\x8a\xe5\xa4\xa9\xe5\xa4\xa9\xe6\xb0\x94\xe4\xb8\x8d\xe9\x94\x99']}

將bytes類型轉一下就得到了 [2020-09-23 11:43:50] [DEBUG] 今天天氣不錯

三、異步的發送遠程日志

現在我們考慮一個問題,當日志發送到遠程服務器過程中,如果遠程服務器處理的很慢,會耗費一定的時間,那么這時記錄日志就會都變慢

修改服務器日志處理類,讓其停頓5秒鍾,模擬長時間的處理流程


此時我們再打印上面的日志


得到的輸出為


我們注意到,它們的時間間隔也是5秒。

那么現在問題來了,原本只是一個記錄日志,現在卻成了拖累整個腳本的累贅,所以我們需要異步的來處理遠程寫日志。

3.1 使用多線程處理

首先想的是應該是用多線程來執行發送日志方法


這種方法是可以達到不阻塞主目的,但是每打印一條日志就需要開啟一個線程,也是挺浪費資源的。我們也可以使用線程池來處理

3.2 使用線程池處理

python 的 concurrent.futures 中有ThreadPoolExecutor, ProcessPoolExecutor類,是線程池和進程池,就是在初始化的時候先定義幾個線程,之后讓這些線程來處理相應的函數,這樣不用每次都需要新創建線程

線程池的基本使用


如果線程池中有n個線程,當提交的task數量大於n時,則多余的task將放到隊列中.

再次修改上面的emit函數


這里為什么要只初始化一個只有一個線程的線程池? 因為這樣的話可以保證先進隊列里的日志會先被發送,如果池子中有多個線程,則不一定保證順序了。

3.3 使用異步aiohttp庫來發送請求

上面的CustomHandler類中的emit方法使用的是requests.post來發送日志,這個requests本身是阻塞運行的,也正上由於它的存在,才使得腳本卡了很長時間,所們我們可以將阻塞運行的requests庫替換為異步的aiohttp來執行get和post方法, 重寫一個CustomHandler中的emit方法


這時代碼執行崩潰了


服務端也沒有收到發送日志的請求。

究其原因是由於emit方法中使用 async with session.post 函數,它需要在一個使用async 修飾的函數里執行,所以修改emit函數,使用async來修飾,這里emit函數變成了異步的函數, 返回的是一個 coroutine 對象,要想執行coroutine對象,需要使用await, 但是腳本里卻沒有在哪里調用 await emit() ,所以崩潰信息中顯示 coroutine 'CustomHandler.emit' was never awaited .

既然emit方法返回的是一個coroutine對象,那么我們將它放一個loop中執行


執行依然報錯


意思是需要的是一個coroutine,但是傳進來的對象不是。

這似乎就沒有辦法了,想要使用異步庫來發送,但是卻沒有可以調用await的地方.

解決辦法是有的,我們使用 asyncio.get_event_loop() 獲取一個事件循環對象, 我們可以在這個對象上注冊很多協程對象,這樣當執行事件循環的時候,就是去執行注冊在該事件循環上的協程, 我們通過一個小例子來看一下


我們使用 loop = asyncio.get_event_loop() 創建了一個事件循環對象loop, 並且在loop上創建了兩個task, 並且給task1添加了一個回調函數,在task1它執行結束以后,將loop停掉.

注意看上面的代碼,我們並沒有在某處使用await來執行協程,而是通過將協程注冊到某個事件循環對象上,然后調用該循環的 run_forever() 函數,從而使該循環上的協程對象得以正常的執行.

上面得到的輸出為


可以看到,使用事件循環對象創建的task,在該循環執行run_forever() 以后就可以執行了.

如果不執行 loop.run_forever() 函數,則注冊在它上面的協程也不會執行


上面的代碼將loop.run_forever() 注釋掉,換成time.sleep(5) 停5秒, 這時腳本不會有任何輸出,在停了5秒以后就中止了.

回到之前的日志發送遠程服務器的代碼,我們可以使用aiohttp封裝一個發送數據的函數, 然后在emit中將這個函數注冊到全局的事件循環對象loop中,最后再執行loop.run_forever() .



這時腳本就可以正常的異步執行了.

loop.create_task(self.submit(msg)) 也可以使用 asyncio.ensure_future(self.submit(msg), loop=loop) 來代替,目的都是將協程對象注冊到事件循環中.

但這種方式有一點要注意,loop.run_forever() 將會一直阻塞,所以需要有個地方調用 loop.stop() 方法. 可以注冊到某個task的回調中.

 

此文轉載文,著作權歸作者所有,如有侵權聯系小編刪除!

原文地址:https://www.tuicool.com/articles/FjY3iez

 

需要源代碼或者想了解更多內容(點擊這里下載)


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM