Python 探針實現原理

本文將簡單講述一下 Python 探針的實現原理。 同時爲了驗證這個原理，咱們也會一塊兒來實現一個簡單的統計指定函數執行時間的探針程序。

探針的實現主要涉及如下幾個知識點:

• sys.meta_path

• sitecustomize.py

sys.meta_path

sys.meta_path 這個簡單的來講就是能夠實現 import hook 的功能， 當執行 import 相關的操做時，會觸發 sys.meta_path 列表中定義的對象。 關於 sys.meta_path 更詳細的資料請查閱 python 文檔中 sys.meta_path 相關內容以及 PEP 0302 。

sys.meta_path 中的對象須要實現一個 find_module 方法， 這個 find_module 方法返回 None 或一個實現了 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
<module 'sys' (built-in)>
sys.version_info(major=3, minor=5, micro=1, releaselevel='final', serial=0)

經過 sys.meta_path 咱們就能夠實現 import hook 的功能： 當 import 預約的 module 時，對這個 module 裏的對象來個狸貓換太子， 從而實現獲取函數或方法的執行時間等探測信息。

上面說到了狸貓換太子，那麼怎麼對一個對象進行狸貓換太子的操做呢？ 對於函數對象，咱們可使用裝飾器的方式來替換函數對象(代碼能夠從 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))

執行結果:

$ python func_wrapper.py
start func
spent 3.004966974258423s
3

下面咱們來實現一個計算指定模塊的指定函數的執行時間的功能(代碼能夠從 github 上下載 part3) 。

假設咱們的模塊文件是 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`` 中保存的是已經導入過的 module
        if fullname in sys.modules:
            return sys.modules[fullname]

        # 先從 sys.meta_path 中刪除自定義的 finder
        # 防止下面執行 import_module 的時候再次觸發此 finder
        # 從而出現遞歸調用的問題
        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
>>>

其實上面的代碼已經實現了探針的基本功能。不過有一個問題就是上面的代碼須要顯示的 執行 import hook 操做纔會註冊上咱們定義的 hook。

那麼有沒有辦法在啓動 python 解釋器的時候自動執行 import hook 的操做呢？ 答案就是能夠經過定義 sitecustomize.py 的方式來實現這個功能。

sitecustomize.py

簡單的說就是，python 解釋器初始化的時候會自動 import PYTHONPATH 下存在的 sitecustomize 和 usercustomize 模塊:

實驗項目的目錄結構以下(代碼能夠從 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.
>>>

能夠看到確實自動導入了。因此咱們能夠把以前的探測程序改成支持自動執行 import hook (代碼能夠從 github 上下載 part5) 。

目錄結構:

$ tree
.
├── hello.py
├── hook.py
├── sitecustomize.py

sitecustomize.py:

$ cat sitecustomize.py
import hook

結果:

$ 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 。 用過探針程序的朋友應該會記得， 使用 newrelic 之類的探針只須要執行一條命令就 能夠了： newrelic-admin run-program python hello.py 實際上修改 PYTHONPATH 的操做是在 newrelic-admin 這個程序裏完成的。

下面咱們也要來實現一個相似的命令行程序，就叫 agent.py 吧。

agent

仍是在上一個程序的基礎上修改。先調整一個目錄結構，把 hook 操做放到一個單獨的目錄下， 方便設置 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 的內容修改成:

$ cat bootstrap/sitecustomize.py
import _hook

agent.py 的內容以下:

import os
import sys

current_dir = os.path.dirname(os.path.realpath(__file__))
boot_dir = os.path.join(current_dir, 'bootstrap')


def main():
    args = sys.argv[1:]
    os.environ['PYTHONPATH'] = boot_dir
    # 執行後面的 python 程序命令
    # sys.executable 是 python 解釋器程序的絕對路徑 ``which python``
    # >>> sys.executable
    # '/usr/local/var/pyenv/versions/3.5.1/bin/python3.5'
    os.execl(sys.executable, sys.executable, *args)

if __name__ == '__main__':
    main()

test.py 的內容爲:

$ 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

至此，咱們就實現了一個簡單的 python 探針程序。固然，跟實際使用的探針程序相比確定是有 很大的差距的，這篇文章主要是講解一下探針背後的實現原理。

若是你們對商用探針程序的具體實現感興趣的話，能夠看一下國外的 New Relic 或國內的 OneAPM, 聽雲 等這些 APM 廠商的商用 python 探針的源代碼。

P.S. 本文首發於 個人博客 ;)
P.S. 本文涉及的代碼能夠從 Github 上獲取 ;)