Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
ActiveSupport::Notifications supporting instrum...
Search
Sponsored
·
Ship Features Fearlessly
Turn features on and off without deploys. Used by thousands of Ruby developers.
→
Y.Matsuda
November 08, 2024
Programming
1.2k
1
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
ActiveSupport::Notifications supporting instrumentation of Rails apps with OpenTelemetry
Y.Matsuda
November 08, 2024
Transcript
35 slides
@ymtdzzz OpenTelemetryによるRailsアプリの計装を 支えるActiveSupport::Notifications 2024.11.08 Fri.Kaigi on Rails 2024事後勉強会 @SmartHR
Yosuke MATSUDA (@ymtdzzz) 株式会社SmartHR プロダクトエンジニア 2
お久しぶりです&はじめまして 3 出典:モノリスでも使える! OpenTelemetryでRailsアプリのパフォーマンス分析を始めてみよう from Kaigi on Rails 2024
やっぱり今日も OpenTelemetry (トレース)
おさらい:トレースとは 5
6 トレース:追跡の単位(リクエストなど) おさらい:トレースとは
7 スパン:処理の単位 おさらい:トレースとは
8 トレースを出力すること:計装 • 自動計装: トレースを自動で出力させる(Gem毎に用 意) • 手動計装: トレースを手動で出力する
9 今日の話はこっち • 自動計装: トレースを自動で出力させる(Gem毎に用 意) • 手動計装: トレースを手動で出力する Railsの自動計装の仕組みはどうなって
いるのか?
10 OpenTelemetry:計装の技術標準 • 仕様(OpenTelemetry Specification) • 実装(言語別 SDK、計装ライブラリ) ※他にも色々ありますが、今回は割愛
計装のために利用する OpenTelemetryライブラリ 11
計装のために利用する OpenTelemetryライブラリ 12 普段私たちが使うのは 計装ライブラリ とRuby SDK
Ruby SDK?計装ライブラリ?
どちらも計装のためのライブラリ • Ruby SDK(opentelemetry-ruby) ◦ トレース設定(出力先やサービス名の設定など) ◦ 手動でスパンを出力したい場合に利用 • 計装ライブラリ
(opentelemetry-ruby-contrib/instrumentation) ◦ Gemに合わせたスパンを自動で出力してくれる ◦ たくさんあります(faraday, grape, mongo, pg, …) 14
どちらも計装のためのライブラリ • Ruby SDK(opentelemetry-ruby) ◦ トレース設定(出力先やサービス名の設定など) ◦ 手動でスパンを出力したい場合に利用 • 計装ライブラリ
(opentelemetry-ruby-contrib/instrumentation) ◦ Gemに合わせたスパンを自動で出力してくれる ◦ たくさんあります(faraday, grape, mongo, pg, …) 15 今日のテーマ
ところで:スパンを手動で生成したいケース 16 出典:Tuning GraphQL on Rails (p.37) from Kaigi on
Rails 2024
Railsの計装ライブラリを覗いてみよう
ここの話 18 自動でスパン(トレース) 出してやんよ!
ActionMailerの計装ライブラリ 19 https://github.com/open-telemetry/opentelemetry-ruby-contrib/ tree/main/instrumentation z
セットアップはこれだけ OpenTelemetry::SDK.configure do |c| # サービス名や出力先などの初期設定は省略 c.use 'OpenTelemetry::Instrumentation::ActionMailer' end 20
• これだけで勝手にスパンが出始める ◦ OpenTelemetry::SDK.configure ◦ ブロック内でConfigurator#use 何が起こっている?
前提知識: ActiveSupport::Notifications 21 • Rails内部のイベントを subscribe し、計測を行う仕組み • ActiveSupport::Notifications.sub scribeでRailsのイベントに
hookし て処理を走らせる 出典)Active Support Instrumentation で計測 - Railsガイド
処理を追ってみる (超スピードで)
まずはRailtieでconfigのinitialize直後にsubscribe 23 スパン生成用の Subscription Handlerでsubscribe Subscribeしたいイベント名 (今回は ActionMailer)
計装ライブラリの登録( Ruby SDK) 24 useで、指定した計装ライブラリを 配列にpush 計装ライブラリの installを呼び出し
ActionMailerの計装ライブラリの installを見てみる 25 イベントの payloadをスパンの attributeに詰める処理
計装ライブラリの独自 Subscription Handlerでイベントの開始と終了時に スパン生成処理を差し込む 26 Subscriberが読み込まれる流れについては時間の都合上省略 🙏 transform_payloadも最終的 にここで実行される( payloadの
Span Attributeへのセット) start, finishによりイベントの前 処理、後処理でスパンを生成す る
• Railsのイベントを ActiveSupport::Notificationsでsubscribe • 独自のSubscription Handlerを利用 ◦ イベントのstart, finishでスパンの生成とattributeセット •
Configuratorでuseしたinstrumentation libraryのinstall実行 ◦ hook時の処理(transform_payloadなど)を設定し有効化 Railsの計装ライブラリの実装ざっくりまとめ 27 Railsの仕組みに上手く乗っかっているこ とがわかりました!
モンキーパッチは使ってないの?
使っています(例: ActiveRecord) 29
モンキーパッチといえば …… 30 出典:現実のRuby/Railsアップグレード (p.33) from Kaigi on Rails 2024
Railsの計装ライブラリでもモンキーパッチをやめる動き 31 Github issue: opentelemetry-ruby-contrib #218
発端:ActionPackの計装ライブラリ 32 Github PR: opentelemetry-ruby-contrib #123 計装ライブラリのモンキーパッチが原因でリクエスト内容が意図せ ず書き換わってしまう問題
まとめ 33 • OpenTelemetryの計装で利用するライブラリ ◦ Ruby SDK:トレース設定、手動計装 ◦ 計装ライブラリ:Gem毎の自動計装 •
Railsの計装ライブラリ ◦ 多くはActiveSupport::Notificationsを利用 ◦ モンキーパッチも一部あるけど、危ないので ActiveSupport::Notificationsを利用する流れへ
ありがとうございました!
参考 35 • Ruby on Rails API • OpenTelemetry 公式ドキュメント
• Github - rails v7.2.2 • Github - opentelemetry-ruby • Github - opentelemetry-ruby-contrib ※スライド内に直接出典を記載したものを除く
More Decks by Y.Matsuda
See All by Y.Matsuda
Accelerating the Feedback Loop of OpenTelemetry Instrumentation with otel-tui
ymtdzzz
1
980
Observability Technology Selection Tips
ymtdzzz
6
1.8k
Building Observability Infrastructure with OpenTelemetry and SaaS
ymtdzzz
2
2.1k
OpenTelemetryでRailsのパフォーマンス分析を始めてみよう(KoR2024)
ymtdzzz
5
5.4k
OIDC仕様に準拠した Makuake ID連携基盤構築の裏側
ymtdzzz
3
3k
Other Decks in Programming
See All in Programming
はじめてのPLATEAU
nokonoko1203
1
660
クラウドゲーミングのパフォーマンス最適化に挑む / Cloud Gaming Performance Tuning
vivion
0
360
SFCで実現する病院・医療システムの動的組み立て式UI
koukimiura
1
180
React Native経験者が Flutterを30⽇間触って驚いたこと
3saito
0
200
AIが実装を担う時代の「技術設計」と「チームマネジメント」
kamina_zzz
2
300
LLM 101
dalinaum
0
520
React Native에 현대적인 빌드 도구 더하기: Rollipop 구현기
leegeunhyeok
0
190
Web3Dライブラリを作ってVue Custom Rendererの仕組みを理解しよう / lets learn vue custom renderer by making 3d library
drumath2237
1
140
読みやすい!と評判(?)の発表の準備にかける私のこだわり
shoheimitani
0
110
手の動かし方がわからなかった私が個人開発者になるまで
usagi0920_pochi
0
320
[Kotlin Fest 2026] eBPF Tracing for Kotlin
takehaya
1
390
Apple Intelligenceとオンデバイス時代の到来
yahir0
0
250
Featured
See All Featured
How to optimise 3,500 product descriptions for ecommerce in one day using ChatGPT
katarinadahlin
PRO
3
3.9k
Tips & Tricks on How to Get Your First Job In Tech
honzajavorek
1
850
How People are Using Generative and Agentic AI to Supercharge Their Products, Projects, Services and Value Streams Today
helenjbeal
2
400
Game over? The fight for quality and originality in the time of robots
wayneb77
1
340
HTML-Aware ERB: The Path to Reactive Rendering @ RubyCon 2026, Rimini, Italy
marcoroth
6
960
SERP Conf. Vienna - Web Accessibility: Optimizing for Inclusivity and SEO
sarafernandez
2
1.7k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
46
3.1k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
162
16k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
508
140k
Scaling GitHub
holman
464
140k
So, you think you're a good person
axbom
PRO
2
2.3k
Git: the NoSQL Database
bkeepers
PRO
433
67k