大阪Ruby会議02での発表資料です https://regional.rubykaigi.org/osaka02/

1. Ruby/Rails
Benchmarking and Profiling
with TDD
2019/09/14 Osaka Ruby Kaigi02
Yasutomo Uemori (wakaba260)

2. me.inspect
=> {
“HN”: "wakaba260",
“name”: "Yasutomo Uemori",
“company”: "株式会社Aiming",
“twitter”: "https://twitter.com/wakaba260yen",
“github”: "https://github.com/yuemori",
“skills”: ["rails api", "docker", "kubernetes", "GCP"]
}

3. 突然ですが

4. Ruby/Railsの
プロファイルや
ベンチマーク

5. とったことある人？

6. 今日の話はこんな人向けの話
- Ruby/Railsのベンチマークやプロファイリングに興味がある
- パフォーマンス改善にどう手を付けていいかわからない
⇛ 主に初心者向けの話

7. Agenda
話すこと
- Benchmark and Performance Testing
- チューニングを行ったときの取り組み
話さないこと
- Rackサーバのチューニング
- 改善をしたときの実装内容

8. Benchmark and
Performance Testing

9. はじめに大事なこと

10. 推測するな
計測せよ

11. プログラミングで時間がかかっている場所を
推測してはいけない。

12. どうやって
計測しよう🤔

13. Testing
そうだ、テストを書こう

14. なぜTestを書くのか
我々は普段からアプリケーションに対しテストを書いている
- エラーがないこと
- バグが修正されたこと
- 仕様どおりに動くこと
こういったことを再現性高く保証するためにテストがある
⇛ パフォーマンスについてもテストを書きたい

15. Red
GreenRefactor
Standard TDD

16. Benchmark
ProfileRefactor
Performance TDD

17. Benchmark
ProfileRefactor
実行速度を計測

18. Benchmark
ProfileRefactor
原因箇所を特定

19. Benchmark
ProfileRefactor
コードを改善

20. Benchmark
ProfileRefactor
改善されたことを確認

21. Benchmark
ProfileRefactor
Measure Measure
Improve

22. Benchmark
ProfileRefactor
Measure Measure
Improve
計測、計測、そして改善

23. 💎今回テストを書くのに使ったgemたち
・Testing：RSpec
・Benchmark：module Benchmark
・Profile：https://github.com/tmm1/stackprof

24. Benchmark
プロファイリングとあわせてベンチマークは必ずとっておこう
- 実際にどのぐらい時間がかかるか？を把握する
- プロファイリングを有効にすると、実行速度自体が下がる
- 一回だけの実行ではばらつきが出やすいのでウォームアップや実
行回数もポイント

25. Benchmark module
・公式のベンチマークライブラリ
・簡単な計測ならこれだけで十分

26. Profiling
速度計測後はプロファイリングを行い、ボトルネックを特定する
- 速度を計測したあと、どこが遅いかを推測で直さない
- 利用しているミドルウェアや外部サービスが遅いなどもある程度わ
かる

27. Stackprof
a sampling call-stack profiler for ruby 2.1+
・mode, interval, outを指定してサンプリング対象のコードを
ブロックで呼び出すだけ
・CPU Clock Time: CPUの利用時間。
Wall Clock Time: 開始から終了までの時間。Railsの場合はこれ
参考：https://scoutapm.com/blog/profiling-rails-with-stackprof

28. Stackprof

29. Stackprof
総サンプリング回数

30. Stackprof
そのメソッドが呼び出しているメソッドの時間も含めた、
TOTALのサンプリング回数

31. Stackprof
純粋にそのメソッドの
サンプリング回数

32. Stackprof
処理に時間がかかっている箇所

33. Stackprof
呼び出している処理のため、
時間がかかっている箇所

34. Stackprof-webnav

35. Stackprof-webnav
行単位で時間がかかっている箇所を表示できる

36. Stackprof-webnav
一番時間がかかっている場所を特定！

37. Stackprof --flamegraph
・上記のようなflamegraphのhtmlを生成してくれる
・呼び出しのスタックトレースや時間などが可視化されるので便利

38. 実践
https://github.com/yuemori/performance_test_app
demo1
demo2

39. 最低限のテストは
出来るようになった

40. Problem
?

41. Problem
めんどくさい

42. Problem
めんどくさい
・手動実行に頼っている
・目視確認に頼っている
⇛ 一度直った問題が再発してないかを確認しにくい
⇛ もっと複雑なケースだとテストケースの再現性も問題

43. Performance Spec

44. Performance Spec

45. Performance Spec

46. 詳細
https://github.com/yuemori/performance_test_app

47. 余談
既にそういったgemがあることに後から気づいた
- https://github.com/piotrmurach/rspec-benchmark
- https://github.com/rails/rails-perftest
また必要になったときにはこれらを使うかどうかも検討したい

48. ここまでのまとめ
手早くパフォーマンス改善を行うためにはどうしたらいいか
- パフォーマンスチューニングにおいては計測が重要
- いろんなgemを使って計測を楽にする
- 計測とチューニングのサイクルを確立する

49. パフォーマンス
改善時のとりくみ

50. パフォーマンス改善時の取り組み
- 改善箇所の調査
- パフォーマンステスト
- パフォーマンス改善方法論の共有

51. 社内テスト内容から遅いAPIの調査
- 改善箇所を検討するために遅いAPIはどこかを調査
- アクセスログからレポートを作成
- 指標
- 総リクエスト数
- 平均レスポンス速度
- 最大レスポンス速度
- 50%、90%、99%、99%...のレスポンス速度

52. 社内テスト内容から遅いAPIの調査

53. ・・・どこから手を付けていこう？🤔
社内テスト内容から遅いAPIの調査

54. 社内テスト内容から遅いAPIの調査：チューニングの検討
- サービスとして遅い箇所が問題になるもの
- 例）毎回ログインに時間がかかる
- 共通処理で遅いもの
- 例）毎回呼び出される認証が遅い
- 遅い原因が他の問題を引き起こすもの
- 例）N+1問題が原因なためDBへの負荷が懸念される

55. 呼び出し頻度は少ないが取得系なので、
かなり酷いN+1なことが予想されるので直したい
社内テスト内容から遅いAPIの調査

56. 同じくN+1っぽいが、ほとんど呼ばれないため
優先度を下げる
社内テスト内容から遅いAPIの調査

57. 平均速度は上位に比べると早いが、
速度劣化の仕方が激しいので原因を見ておきたい
社内テスト内容から遅いAPIの調査

58. 気になるほど遅いわけではないが、
呼び出し回数が飛び抜けて高いのでもう少し早くしたい
社内テスト内容から遅いAPIの調査

59. 社内テスト内容から遅いAPIの調査：計測方法
- ログから計測
- 今回はStackdriver + BigQuery + DataPortal
- 構造化ログを出しておくことで集計が容易になる
- サービスの利用
- NewRelicやDatadogなど
- productionではおすすめ
- CIやローカルで実行するのに難がある

60. パフォーマンステスト
- 紹介した実装をベースにテスト環境を整備
- DBのボトルネック調査にクエリレポートを追加実装
- ActiveSupport::Notificationsを使ってクエリをトレース

61. パフォーマンステスト：クエリレポート
- railsの提供するイベントから計測、集計
- テスト時に実行されるSQLのレポートを作成して可視化

62. パフォーマンス改善方法論の共有
チューニングを個人に依存しないようにしたいと考えていた
- 実際にチューニングを行ったときのことをチーム内勉強会で共有
- ドキュメントの作成
⇛ 方法論を共有することでチューニングをチームのものにする 💪

63. パフォーマンス改善方法論の共有：ドキュメントの作成

64. パフォーマンス改善方法論の共有：ドキュメントの作成

65. パフォーマンス改善方法論の共有：レビュー
- パフォーマンス改善のPRを出した時はdescriptionに結果を記載
- 改善時にチェックしたポイントをわかりやすくする
- before/afterを掲載して改善されていることを伝える

66. パフォーマンス改善方法論の共有：レビュー

67. パフォーマンス改善方法論の共有：レビュー

68. まとめ
- パフォーマンス改善の心得：推測するな、計測せよ
- パフォーマンスのテストコードを書いて改善を楽にしよう
- パフォーマンス改善は楽しいので是非Tryしてみてください

69. ご静聴
ありがとうございました