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
 
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 的內容如下:

<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">&#39;bootstrap&#39;</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">&#39;PYTHONPATH&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">boot_dir</span>
  <span class="c"># 执行后面的 python 程序命令</span>
  <span class="c"># sys.executable 是 python 解释器程序的绝对路径 ``which python``</span>
  <span class="c"># >>> sys.executable</span>
  <span class="c"># &#39;/usr/local/var/pyenv/versions/3.5.1/bin/python3.5&#39;</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">&#39;__main__&#39;</span><span class="p">:</span>
  <span class="n">main</span><span class="p">()</span>

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, TingYun 等這些APM 廠商的商用python 探針的源代碼，相信你會發現一些很有趣的事情。

更多Python探針的實作原理詳解相關文章請關注PHP中文網！