WerkzeugでFlaskを使ったPythonのWebAppをプロファイリングする

Comments

前回の記事に引き続きISUCONのために調べたことをまとめてみます.

うちのチームは使用言語にPythonを選択していたので,ISUCON2やISUCON3の予選でも使われていたFlaskというフレームワークを使ったWSGI Application用のプロファイラを探したところWerkzeugのWSGI Application Profilerというものがあったので使ってみました.

Flask

Flaskは,WerkzeugをベースにしてJinja2をテンプレートに使った軽量なWAFです.

Werkzeug

WerkzeugはWSGI Applicationのutility libraryで,フレームワークという程ではないですがWSGIの実装を助けるようなrequest/responseオブジェクトの支援ツールやテスター,デバッガなどが含まれています.

そしてこのWerkzeugの中にはbuiltin moduleであるprofileやcProfileを使ったWSGI Application Profilerも含まれています.今回はこのModuleを使ってprofilingを行います.

導入

Gitレポジトリからクローンしてきて,setup.pyを実行するだけです.

1
2
$ git clone https://github.com/mitsuhiko/werkzeug
# python setup.py install

プロファイリングを行う

それでは実際にプロファイリングを行ってみましょう.ここではサンプルアプリケーションとして,/にアクセスするとHello World!と表示する単純なプログラムを用意します.まずFlaskをインストールしておきます.

1
# pip install flask

それではflaskを使ったapp.pyを作ります.

app.py
1
2
3
4
5
6
7
8
9
from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return "Hello World!"

if __name__ == '__main__':
    app.run()

次にプロファイリングするコードを書きます.

profiler.py
1
2
3
4
5
6
7
#!flask/bin/python
from werkzeug.contrib.profiler import ProfilerMiddleware, MergeStream
from app import app

app.config['PROFILE'] = True
app.wsgi_app = ProfilerMiddleware(app.wsgi_app)
app.run(debug = True)

それでは実行してみましょう.

1
2
3
$ python profiler.py
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with reloader

http://127.0.0.1:5000/にアクセスします.すると以下のようにプロファイリング結果が標準出力に出力されます.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with reloader
--------------------------------------------------------------------------------
PATH: '/'
         301 function calls in 0.001 seconds

   Ordered by: internal time, call count

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
        1    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/Werkzeug-0.10_devdev_20131113-py2.7.egg/werkzeug/wrappers.py:734(__init__)
       10    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/Werkzeug-0.10_devdev_20131113-py2.7.egg/werkzeug/local.py:67(__getattr__)
       10    0.000    0.000    0.000    0.000 {method 'decode' of 'str' objects}

    ...snip...

        1    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/Werkzeug-0.10_devdev_20131113-py2.7.egg/werkzeug/wrappers.py:60(_warn_if_string)
        1    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/flask/sessions.py:189(is_null_session)
        1    0.000    0.000    0.000    0.000 {method 'disable' of '_lsprof.Profiler' objects}


--------------------------------------------------------------------------------

127.0.0.1 - - [13/Nov/2013 14:21:51] "GET / HTTP/1.1" 200 -

プロファイリング結果の各項目の説明は以下のようになります.

項目 説明
ncalls 関数の呼び出し回数
tottime 関数の実行にかかった時間
percall tottime/ncalls
cumtime 関数内で別の関数を呼んでいた場合,その関数も含めた時間
percall cumtime/ncalls
filename:lineno(function) ファイル名:行数(関数名)

sort_by=['calls']で結果をncallsでソート,restrictions=[10]で出力を10件に制限する,などというようにオプションを指定することもできます.

profiler.py
1
2
3
...snip...
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, sort_by=['calls'], restrictions=[10])
app.run(debug = True)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
--------------------------------------------------------------------------------
PATH: '/'
         301 function calls in 0.001 seconds

   Ordered by: call count
   List reduced from 138 to 10 due to restriction <10>

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
       35    0.000    0.000    0.000    0.000 {isinstance}
       14    0.000    0.000    0.000    0.000 {thread.get_ident}
       11    0.000    0.000    0.000    0.000 {method 'get' of 'dict' objects}
       10    0.000    0.000    0.000    0.000 {method 'decode' of 'str' objects}
       10    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/Werkzeug-0.10_devdev_20131113-py2.7.egg/werkzeug/local.py:67(__getattr__)
       10    0.000    0.000    0.000    0.000 {len}
        8    0.000    0.000    0.000    0.000 {getattr}
        6    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/flask/signals.py:35(<lambda>)
        6    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/Werkzeug-0.10_devdev_20131113-py2.7.egg/werkzeug/local.py:157(top)
        6    0.000    0.000    0.000    0.000 {method 'lower' of 'str' objects}


--------------------------------------------------------------------------------

127.0.0.1 - - [13/Nov/2013 15:11:02] "GET / HTTP/1.1" 200 -

また,以下のようにMergeStream()を使えば,標準出力にログを流しながらファイルに書き出すこともできます.

profiler.py
1
2
3
4
5
6
7
8
9
10
#!flask/bin/python
from werkzeug.contrib.profiler import ProfilerMiddleware, MergeStream
from app import app
import sys

f = open('profiler.log', 'w')
stream = MergeStream(sys.stdout, f)
app.config['PROFILE'] = True
app.wsgi_app = ProfilerMiddleware(app.wsgi_app, stream, sort_by=['calls'], restrictions=[10])
app.run(debug = True)

それでは再帰関数を呼んでみて,きちんとプロファイリングできているか確認してみましょう.以下のようにapp.pyを変更し,20番目のフィボナッチ数を出力するようにしてみます.

app.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
from flask import Flask
app = Flask(__name__)

def fib(n):
    if n <= 2:
        return 1
    else:
        return fib(n-1) + fib(n-2)

@app.route('/')
def fibonacci():
    n = 20
    return str(n) + "th Fibonacci number is " + str(fib(n)) +"."

if __name__ == '__main__':
    app.run()

profiler.pyを実行し,http://127.0.0.1:5000/にアクセスします.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
--------------------------------------------------------------------------------
PATH: '/'
         13830 function calls (302 primitive calls) in 0.008 seconds

   Ordered by: call count
   List reduced from 139 to 10 due to restriction <10>

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
  13529/1    0.007    0.000    0.007    0.007 /home/kenta/Documents/flask/app.py:4(fib)
       35    0.000    0.000    0.000    0.000 {isinstance}
       14    0.000    0.000    0.000    0.000 {thread.get_ident}
       11    0.000    0.000    0.000    0.000 {method 'get' of 'dict' objects}
       10    0.000    0.000    0.000    0.000 {method 'decode' of 'str' objects}
       10    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/Werkzeug-0.10_devdev_20131113-py2.7.egg/werkzeug/local.py:67(__getattr__)
       10    0.000    0.000    0.000    0.000 {len}
        8    0.000    0.000    0.000    0.000 {getattr}
        6    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/flask/signals.py:35(<lambda>)
        6    0.000    0.000    0.000    0.000 /usr/local/lib/python2.7/dist-packages/Werkzeug-0.10_devdev_20131113-py2.7.egg/werkzeug/local.py:157(top)


--------------------------------------------------------------------------------

127.0.0.1 - - [13/Nov/2013 17:58:24] "GET / HTTP/1.1" 200 -

fib()が時間がかかっているのが確認できると思います.ちなみにncallsの13529/1は,(再帰も含めた呼び出し回数)/(再帰でない大元の呼び出し回数)となっています.

おわりに

今回はFlaskを使ったWSGI Applicationのプロファイリング方法を紹介しました.この結果をもとに時間のかかっている処理を特定・改善すれば,Applicationの高速化が図れます.

ちなみに,前回の記事で紹介したkibanaで表示できるように,Fluentdのプラグインも書いてみました.

fluent-plugin-werkzeug-profiler – Github

fluent-plugin-werkzeug-profilerを書いた

このエントリーをはてなブックマークに追加

Comments

fluent-plugin-werkzeug-profilerを書いた Fluentd + ElasticSearch + Kibana3で簡単に様々なログを可視化・解析する