Pythonプローブの実現原理

プローブの実現は主に以下のいくつかの知識点に関連している。
sys.meta_パス
sitecustomize.py
sys.meta_パス
sys.meta_pathという簡単な言葉で言えば、import Hookの機能を実現することができます。
import関連の操作を行うと、sys.meta_がトリガされます。パスリストで定義されているオブジェクト。
sys.meta_についてpathより詳細な資料はpython文書中のsys.meta_を参照してください。path関連内容及び
PEP 0302。
sys.meta_pathの対象はfind_を実現する必要があります。module方法、
このfind_module方法はNoneに戻ります。またはロードを実現しました。moduleメソッドの対象
（コードはgithubからpart 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)

ロード.module方法はmoduleオブジェクトに戻ります。このオブジェクトはimportのmoduleオブジェクトです。
例えば上のようにhttpをsysというmoduleに変えました。
$python meta_path 1.py
find_module http
ロード.module http
 
sys.version_info（major=3、minor=5、micro=1、releaselever='final'serial=0）
sys.meta_を通じてpathはimport hookの機能を実現できます。
importが予約したmoduleの時に、このmoduleの対象にタヌキの太子が来て、
これにより、関数や方法の実行時間などのプローブ情報の取得が可能となります。
上ではタヌキが太子にかわると言いましたが、どうやって相手をタヌキに変えますか？
関数オブジェクトに対しては、関数オブジェクトを置き換えるために装飾器を使用することができます。

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

指定されたモジュールの指定された関数の実行時間を計算する機能を実行します。
私たちのモジュールファイルが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モジュールがあります。
実験項目のディレクトリ構造は以下の通りです。
$tree
..。
_;——sitecustomize.py
一羽——usercustomize.py
sitecustomize.py:
$cat sitecustomize.py
print('this is sitecustomize')
usercustomize.py:
$cat usercustomize.py
print('this is usercustomize')
現在のディレクトリをPYTHOPATHに追加して、効果を見てください。

$ 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
..。
ハロー.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

しかし、上の探査プログラムにはもう一つの問題があります。それは手動でPYTHONSPATHを修正する必要があります。プローブプログラムを使ったことがある友達は、newrelicなどのプローブを使ってコマンドを実行するだけでいいです。newrelic-admin run-program python hello.pyは実際にPYTHOnPATHを修正した操作はnewrelic-adminというプログラムで完成しました。
私たちも似たようなコマンドラインを実行します。これをagent.pyといいます。
メッセージ
それとも前のプログラムをもとに修正しますか？まず一つのディレクトリ構造を調整して、Hook操作を単独のディレクトリに置いて、PYTHONSPATHを設定してもいいです。他の干渉はありません。

$ 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 boot strap/sitecustomize.py
import.ヤフー
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">'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">#       python     </span>
  <span class="c"># sys.executable   python            ``which python``</span>
  <span class="c"># &gt;&gt;&gt; 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の内容は：

$ 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プローブのソースコードを見てもいいです。