8000 GitHub - catatsuy/private-isu: a web application performance improvement training
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

catatsuy/private-isu

BranchesTags

Repository files navigation

private-isu

「ISUCON」は、LINE株式会社の商標または登録商標です。

本リポジトリが書籍の題材になりました。詳しくは以下のURLをご覧ください。

ハッシュタグ： #ISUCON本

タイムライン

2016年に作成した社内ISUCONリポジトリを2021年に手直ししました。2022年に書籍の題材になりました。

［2016年開催時のブログ］

過去ISUCON公式で練習問題として推奨されたことがある。

［2021年開催時のブログ］

ディレクトリ構成

├── ansible_old  # [非推奨] 旧バージョンのベンチマーカー・portal用ansible
├── benchmarker  # ベンチマーカーのソースコード
├── portal       # [非推奨] 旧バージョンのportal
├── provisioning # 競技者用・ベンチマーカーインスタンスセットアップ用ansible
└── webapp       # 各言語の参考実装
  • manual.mdは当日マニュアル。一部社内イベントを意識した記述があるので注意すること。
  • public_manual.md は事前公開レギュレーション

OS

Ubuntu 24.04

対応言語と状況

本環境では、以下の言語による参考実装が提供されています。

  • Ruby (デフォルトで起動)
  • Go
  • PHP
  • Python
  • Node.js

起動方法

重要: 以下のいずれの手順を実行する前にも、まずプロジェクトのルートディレクトリで make init を実行して初期データを準備してください。

  • Ruby、Go、PHP、Python、Node.jsの5言語の参考実装が用意されており、デフォルトではRubyが起動します。
    • AMIまたはVagrantで他の言語の参考実装を動作させる場合は、manual.mdを参照してください。
  • 起動方法として、AMI、Docker Compose、Vagrantが用意されています。
    • ローカル環境で手軽に動作させることも比較的簡単です。
    • Ansibleを利用すれば、その他の環境でも動作するはずです。
    • cloud-initも利用可能

AMI

セキュリティアップデートは行われないため、自己責任で利用してください。

  • 競技者用インスタンスでは、セキュリティグループでTCP/80番ポートへのアクセスを許可する必要があります。
    • EC2インスタンス作成時のネットワーク設定で「インターネットからのHTTPトラフィックを許可する」といったオプションにチェックを入れても構いません。
  • ベンチマーカー用インスタンスには、コンピューティング最適化インスタンスなど、十分なスペックのマシンを利用することを推奨します。

ベンチマーカーインスタンス上での実行方法

$ sudo su - isucon
$ /home/isucon/private_isu.git/benchmarker/bin/benchmarker -u /home/isucon/private_isu.git/benchmarker/userdata -t http://<target IP>

競技者用インスタンス上でのベンチマーカー実行方法

$ sudo su - isucon
$ /home/isucon/private_isu/benchmarker/bin/benchmarker -u /home/isucon/private_isu/benchmarker/userdata -t http://localhost

起動直後はRubyの参考実装が動作しています。他の言語を使用する場合は、manual.mdを参照して必要な作業を行ってください。

現在配布しているAMIは、競技者用インスタンスにベンチマーカーを同梱したものです。

以下のAMI IDで起動できます（リージョンは ap-northeast-1 （アジアパシフィック (東京)））。これは特定日時のスナップショットのため、より新しいAMIが利用可能になっている場合があります。AWSコンソールで最新情報を確認することをお勧めします。推奨インスタンスタイプは、競技者用がc7a.large、ベンチマーカー用がc7a.xlargeです。

競技者用 (Ubuntu 24.04, amd64): catatsuy_private_isu_amd64_20250615

手元で動かす

注意: いずれの手順も、ディスク容量に十分な空きがあるマシン上で行ってください。

  • アプリケーションは、各言語の実行環境とMySQL、memcachedがインストールされていれば動作するはずです。
  • ベンチマーカーは、Goの実行環境とuserdataディレクトリがあれば動作します。
  • DockerおよびVagrantを使用する場合は、メモリを潤沢に搭載したマシンで実行してください。

MacやLinux上で適当に動かす

MySQLとmemcachedを起動した上で、以下の手順を実行してください。

  • Ruby以外の言語については、それぞれの言語の実行方法を別途確認してください。
  • MySQLのrootユーザーにパスワードが設定されていない前提です。設定されている場合は、適宜手順を読み替えてください。
bunzip2 -c webapp/sql/dump.sql.bz2 | mysql -uroot

cd webapp/ruby
bundle install --path=vendor/bundle
bundle exec foreman start
cd ../..

cd benchmarker
make
./bin/benchmarker -t "http://localhost:8080" -u ./userdata
# ./bin/benchmarker -t "http://<競技者用インスタンスのグローバルIPアドレス>/" -u ./userdata

# Output
# {"pass":true,"score":1710,"success":1434,"fail":0,"messages":[]}

Docker Compose

アプリケーションは以下の手順で実行できます。webapp/sql/dump.sql.bz2が配置されていないとMySQLに初期データがインポートされないため注意してください。

cd webapp
docker compose up

（もし docker compose up でうまく動作しない場合は、代わりに docker compose up を試してみてください）

デフォルトはRubyの参考実装です。他の言語に変更する場合は、docker-compose.ymlファイル内のappサービスのbuild設定を変更してください。PHPの参考実装を利用する場合は、それに加えて以下の作業が必要です。

cd webapp/etc
mv nginx/conf.d/default.conf nginx/conf.d/default.conf.org
mv nginx/conf.d/php.conf.org nginx/conf.d/php.conf

ベンチマーカーは以下の手順で実行できます。

cd benchmarker
docker build -t private-isu-benchmarker .
docker run --network host -i private-isu-benchmarker /bin/benchmarker -t http://host.docker.internal -u /opt/userdata
# Linuxの場合
docker run --network host --add-host host.docker.internal:host-gateway -i private-isu-benchmarker /bin/benchmarker -t http://host.docker.internal -u /opt/userdata

動作しない場合は、ip aコマンドなどでdocker0インタフェースに割り当てられたホスト側のIPアドレスを確認し、host.docker.internalの代わりにそのIPアドレスを指定してください。例えば、以下の出力の場合は172.17.0.1を指定します。

3: docker0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN group default
    link/ether 02:42:ca:63:0c:59 brd ff:ff:ff:ff:ff:ff
    inet 172.17.0.1/16 brd 172.17.255.255 scope global docker0
       valid_lft forever preferred_lft forever
    inet6 fe80::42:caff:fe63:c59/64 scope link
       valid_lft forever preferred_lft forever

Vagrant

ローカルマシンにAnsibleをインストールし、vagrant upを実行すると、プロビジョニングが自動的に行われます。

benchノードからappノードのIPアドレスを指定して負荷をかけてください。

# appノードのIPアドレスを調べる
$ vagrant ssh app
$ ip a

3: enp0s8: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP group default qlen 1000
    link/ether 08:00:27:37:2b:2c brd ff:ff:ff:ff:ff:ff
    inet 172.28.128.6/24 brd 172.28.128.255 scope global dynamic enp0s8
       valid_lft 444sec preferred_lft 444sec
    inet6 fe80::a00:27ff:fe37:2b2c/64 scope link
       valid_lft forever preferred_lft forever

# benchノードで負荷を実行する
$ vagrant ssh bench
$ sudo su - isucon
$ /home/isucon/private_isu.git/benchmarker/bin/benchmarker -u /home/isucon/private_isu.git/benchmarker/userdata -t http://172.28.128.6

起動直後はRubyの参考実装が動作しています。他の言語を使用する場合は、manual.mdを参照して必要な作業を行ってください。

cloud-init を利用して環境を構築する

matsuu氏が提供するcloud-initに対応したISUCON過去問題環境構築用のcloud-config集を利用して、競技者用およびベンチマーカーインスタンスを構築できます。

cloud-initに対応した多様な環境（例: AWS、Azure、Google Cloud、Oracle Cloud、さくらのクラウド、Multipass、VMwareなど）、つまりクラウドからローカル環境まで幅広く対応しています。

Apple Silicon搭載のマシン上でローカル環境を構築する場合、Multipassの利用を推奨します。

https://github.com/matsuu/cloud-init-isucon/tree/main/private-isu

ISUCON過去問題の環境を「さくらのクラウド」で構築する | さくらのナレッジ https://knowledge.sakura.ad.jp/31520/

Cloud Formationを利用して構築する

https://gist.github.com/tohutohu/024551682a9004da286b0abd6366fa55 を参照

競技者用・ベンチマーカーインスタンスのセットアップ方法

自身でインスタンスをセットアップしたい場合は、provisioning/ディレクトリ以下のスクリプトを参照してください。

事例集

他の言語実装

About

a web application performance improvement training

Topics

isucon

Resources

Readme

License

MIT license
Activity

Stars

523 stars

Watchers

4 watching

Forks

306 forks
Report repository

Releases

1 tags

Packages

No packages published

Contributors 18
+ 4 contributors

Languages
0