Python 探針的實現(xiàn)原理
探針的實現(xiàn)主要涉及以下幾個知識點:
sys.meta_path
sitecustomize.py
sys.meta_path
sys.meta_path 這個簡單的來說就是可以實現(xiàn) import hook 的功能，
當執(zhí)行 import 相關(guān)的操作時，會觸發(fā) sys.meta_path 列表中定義的對象。
關(guān)于 sys.meta_path 更詳細的資料請查閱 python 文檔中 sys.meta_path 相關(guān)內(nèi)容以及
PEP 0302 。
sys.meta_path 中的對象需要實現(xiàn)一個 find_module 方法，
這個 find_module 方法返回 None 或一個實現(xiàn)了 load_module 方法的對象
(代碼可以從 github 上下載 part1) :
import sys
class MetaPathFinder:
def find_module(self, fullname, path=None):
print('find_module {}'.format(fullname))
return MetaPathLoader()
class MetaPathLoader:
def load_module(self, fullname):
print('load_module {}'.format(fullname))
sys.modules[fullname] = sys
return sys
sys.meta_path.insert(0, MetaPathFinder())
if __name__ == '__main__':
import http
print(http)
print(http.version_info)
load_module 方法返回一個 module 對象，這個對象就是 import 的 module 對象了。
比如我上面那樣就把 http 替換為 sys 這個 module 了。
$ python meta_path1.py
find_module http
load_module http
sys.version_info(major=3, minor=5, micro=1, releaselevel='final', serial=0)
通過 sys.meta_path 我們就可以實現(xiàn) import hook 的功能：
當 import 預定的 module 時，對這個 module 里的對象來個貍貓換太子，
從而實現(xiàn)獲取函數(shù)或方法的執(zhí)行時間等探測信息。
上面說到了貍貓換太子，那么怎么對一個對象進行貍貓換太子的操作呢？
對于函數(shù)對象，我們可以使用裝飾器的方式來替換函數(shù)對象(代碼可以從 github 上下載 part2) :
import functools
import time
def func_wrapper(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print('start func')
start = time.time()
result = func(*args, **kwargs)
end = time.time()
print('spent {}s'.format(end - start))
return result
return wrapper
def sleep(n):
time.sleep(n)
return n
if __name__ == '__main__':
func = func_wrapper(sleep)
print(func(3))
執(zhí)行結(jié)果:
$ python func_wrapper.py start func spent 3.004966974258423s 3
下面我們來實現(xiàn)一個計算指定模塊的指定函數(shù)的執(zhí)行時間的功能(代碼可以從 github 上下載 part3) 。
假設(shè)我們的模塊文件是 hello.py:
import time def sleep(n): time.sleep(n) return n
我們的 import hook 是 hook.py:
import functools
import importlib
import sys
import time
_hook_modules = {'hello'}
class MetaPathFinder:
def find_module(self, fullname, path=None):
print('find_module {}'.format(fullname))
if fullname in _hook_modules:
return MetaPathLoader()
class MetaPathLoader:
def load_module(self, fullname):
print('load_module {}'.format(fullname))
# ``sys.modules`` 中保存的是已經(jīng)導入過的 module
if fullname in sys.modules:
return sys.modules[fullname]
# 先從 sys.meta_path 中刪除自定義的 finder
# 防止下面執(zhí)行 import_module 的時候再次觸發(fā)此 finder
# 從而出現(xiàn)遞歸調(diào)用的問題
finder = sys.meta_path.pop(0)
# 導入 module
module = importlib.import_module(fullname)
module_hook(fullname, module)
sys.meta_path.insert(0, finder)
return module
sys.meta_path.insert(0, MetaPathFinder())
def module_hook(fullname, module):
if fullname == 'hello':
module.sleep = func_wrapper(module.sleep)
def func_wrapper(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
print('start func')
start = time.time()
result = func(*args, **kwargs)
end = time.time()
print('spent {}s'.format(end - start))
return result
return wrapper
測試代碼:
>>> import hook >>> import hello find_module hello load_module hello >>> >>> hello.sleep(3) start func spent 3.0029919147491455s 3 >>>
其實上面的代碼已經(jīng)實現(xiàn)了探針的基本功能。不過有一個問題就是上面的代碼需要顯示的
執(zhí)行 import hook 操作才會注冊上我們定義的 hook。
那么有沒有辦法在啟動 python 解釋器的時候自動執(zhí)行 import hook 的操作呢？
答案就是可以通過定義 sitecustomize.py 的方式來實現(xiàn)這個功能。
sitecustomize.py
簡單的說就是，python 解釋器初始化的時候會自動 import PYTHONPATH 下存在的 sitecustomize 和 usercustomize 模塊:
實驗項目的目錄結(jié)構(gòu)如下(代碼可以從 github 上下載 part4)
$ tree
.
├── sitecustomize.py
└── usercustomize.py
sitecustomize.py:
$ cat sitecustomize.py
print('this is sitecustomize')
usercustomize.py:
$ cat usercustomize.py
print('this is usercustomize')
把當前目錄加到 PYTHONPATH 中，然后看看效果:
$ export PYTHONPATH=. $ python this is sitecustomize <---- this is usercustomize <---- Python 3.5.1 (default, Dec 24 2015, 17:20:27) [GCC 4.2.1 Compatible Apple LLVM 7.0.2 (clang-700.1.81)] on darwin Type "help", "copyright", "credits" or "license" for more information. >>>
可以看到確實自動導入了。所以我們可以把之前的探測程序改為支持自動執(zhí)行 import hook (代碼可以從 github 上下載part5) 。
目錄結(jié)構(gòu):
$ tree
.
├── hello.py
├── hook.py
├── sitecustomize.py
sitecustomize.py:
$ cat sitecustomize.py import hook
結(jié)果:
$ export PYTHONPATH=. $ python find_module usercustomize Python 3.5.1 (default, Dec 24 2015, 17:20:27) [GCC 4.2.1 Compatible Apple LLVM 7.0.2 (clang-700.1.81)] on darwin Type "help", "copyright", "credits" or "license" for more information. find_module readline find_module atexit find_module rlcompleter >>> >>> import hello find_module hello load_module hello >>> >>> hello.sleep(3) start func spent 3.005002021789551s 3
不過上面的探測程序其實還有一個問題，那就是需要手動修改 PYTHONPATH 。 用過探針程序的朋友應(yīng)該會記得， 使用 newrelic 之類的探針只需要執(zhí)行一條命令就 可以了： newrelic-admin run-program python hello.py 實際上修改PYTHONPATH 的操作是在 newrelic-admin 這個程序里完成的。
下面我們也要來實現(xiàn)一個類似的命令行程序，就叫 agent.py 吧。
agent
還是在上一個程序的基礎(chǔ)上修改。先調(diào)整一個目錄結(jié)構(gòu)，把 hook 操作放到一個單獨的目錄下， 方便設(shè)置 PYTHONPATH后不會有其他的干擾（代碼可以從 github 上下載 part6 ）。
$ mkdir bootstrap $ mv hook.py bootstrap/_hook.py $ touch bootstrap/__init__.py $ touch agent.py $ tree . ├── bootstrap │ ├── __init__.py │ ├── _hook.py │ └── sitecustomize.py ├── hello.py ├── test.py ├── agent.py
bootstrap/sitecustomize.py 的內(nèi)容修改為:
$ cat bootstrap/sitecustomize.py
import _hook
agent.py 的內(nèi)容如下:
<span class="kn">import</span> <span class="nn">os</span> <span class="kn">import</span> <span class="nn">sys</span> <span class="n">current_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="n">__file__</span><span class="p">))</span> <span class="n">boot_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">current_dir</span><span class="p">,</span> <span class="s">'bootstrap'</span><span class="p">)</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="n">args</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">'PYTHONPATH'</span><span class="p">]</span> <span class="o">=</span> <span class="n">boot_dir</span> <span class="c"># 執(zhí)行后面的 python 程序命令</span> <span class="c"># sys.executable 是 python 解釋器程序的絕對路徑 ``which python``</span> <span class="c"># >>> sys.executable</span> <span class="c"># '/usr/local/var/pyenv/versions/3.5.1/bin/python3.5'</span> <span class="n">os</span><span class="o">.</span><span class="n">execl</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="p">,</span> <span class="n">sys</span><span class="o">.</span><span class="n">executable</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span> <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span> <span class="n">main</span><span class="p">()</span>
test.py 的內(nèi)容為:
$ cat test.py import sys import hello print(sys.argv) print(hello.sleep(3))
使用方法:
$ python agent.py test.py arg1 arg2 find_module usercustomize find_module hello load_module hello ['test.py', 'arg1', 'arg2'] start func spent 3.005035161972046s 3
至此，我們就實現(xiàn)了一個簡單的 python 探針程序。當然，跟實際使用的探針程序相比肯定是有 很大的差距的，這篇文章主要是講解一下探針背后的實現(xiàn)原理。
如果大家對商用探針程序的具體實現(xiàn)感興趣的話，可以看一下國外的 New Relic 或國內(nèi)的 OneAPM, TingYun 等這些 APM 廠商的商用 python 探針的源代碼，相信你會發(fā)現(xiàn)一些很有趣的事情。
相關(guān)文章
python 將numpy維度不同的數(shù)組相加相乘操作
這篇文章主要介紹了python 將numpy維度不同的數(shù)組相加相乘操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-03-03
今天小編就為大家分享一篇Anaconda下安裝mysql-python的包實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-06-06
python實現(xiàn)從wind導入數(shù)據(jù)
今天小編就為大家分享一篇python實現(xiàn)從wind導入數(shù)據(jù)，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-12-12
今天小編就為大家分享一篇pytorch 輸出中間層特征的實例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-08-08
這篇文章介紹了Pytest自定義mark標記篩選用例的方法，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-06-06
這篇文章主要給大家介紹了關(guān)于利用python如何在前程無憂高效投遞簡歷的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用python具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-05-05
Windows系統(tǒng)下安裝tensorflow的配置步驟
這篇文章主要介紹了Windows系統(tǒng)下安裝tensorflow,本文通過圖文并茂的形式給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-07-07
這篇文章介紹了Mac下使用HomeBrew安裝python3的方法，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-06-06
這篇文章主要介紹了python3.7添加dlib模塊的方法,本文通過圖文并茂的形式給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-07-07
Python實現(xiàn)信用卡系統(tǒng)(支持購物、轉(zhuǎn)賬、存取錢)
這篇文章主要介紹了Python實現(xiàn)信用卡系統(tǒng)(支持購物、轉(zhuǎn)賬、存取錢)的相關(guān)資料,非常不錯，具有參考借鑒價值，需要的朋友可以參考下2016-06-06