Pythonプローブの実装原理を詳しく解説

この記事では、Python プローブの実装原理について簡単に説明します。 同時に、この原理を検証するために、指定された関数の実行時間をカウントする簡単なプローブ プログラムも実装します。

プローブの実装には主に次の知識ポイントが含まれます:

sys.meta_path
sitecustomize.py
sys.meta_path

sys.meta_path これは単にインポート フックの機能を実現できることを意味します。 sys.meta_path リストで定義されたオブジェクトは、操作中にトリガーされます。
sys.meta_path の詳細については、Python ドキュメントの sys.meta_path 関連コンテンツと
PEP 0302 を参照してください。

sys.meta_path 内のオブジェクトは find_module メソッドを実装する必要があります。

この find_module メソッドは None を返すか、load_module メソッドを実装するオブジェクトを返します
(コードは github パート 1 からダウンロードできます):

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)

Theload_module メソッドモジュール オブジェクトを返します。このオブジェクトはインポートのモジュール オブジェクトです。

たとえば、上記のように http を sys モジュールに置き換えました。

$ 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 を通じて実現できますインポートフックの機能:
所定のモジュールをインポートする際に、このモジュール内のオブジェクトを変更して、関数やメソッドの実行時間などの検出情報を取得します。

上記では王子様のジャコウネコについて述べましたが、オブジェクトに対して王子様のジャコウネコの操作を実行するにはどうすればよいですか?

関数オブジェクトの場合、デコレーターを使用して関数オブジェクトを置き換えることができます (コードは github パート 2 からダウンロードできます):

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 パート 3 からダウンロードできます)。

モジュールファイルが hello.py:

import time
 
def sleep(n):
  time.sleep(n)
  return n

インポートフックが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
>>>

実際、上記のコードはプローブの基本的な機能が実現されています。ただし、定義したフックを登録するインポートフック操作を実行するには、上記のコードを表示

する必要があるという問題があります。

それでは、Python インタープリターの起動時にインポートフック操作を自動的に実行する方法はありますか?

答えは、この機能は sitecustomize.py を定義することで実現できるということです。

sitecustomize.py

簡単に言えば、Python インタープリターが初期化されると、PYTHONPATH に存在する sitecustomize モジュールと usercustomize モジュールが自動的にインポートされます:

実験的プロジェクトのディレクトリ構造は次のとおりです (コードは github からダウンロードできます)パート4)

$ ツリー

.

§── sitecustomize.py
└── usercustomize.py
sitecustomize.py:

$ 猫 sitecustomize.py

print('これは 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.
>>>

実際に自動的にインポートされていることがわかります。そこで、インポートフックの自動実行をサポートするように以前の検出プログラムを変更できます (コードは 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 などのプローブを使用するには、次の 1 つのコマンドを実行するだけでよいことを覚えているでしょう。 newrelic-admin run-program python hello.py 実際、PYTHONPATH を変更する操作は newrelic-admin プログラム内にあります。に完了しました。

ここで、同様のコマンド ライン プログラムも実装します。agent.py と呼びます。

agent

は以前のプログラムに基づいて変更されたままです。まずディレクトリ構造を調整し、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の内容が変更されますto::

$ 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 中国語 Web サイトに注目してください。