LaravelプロダクトにOpentelemetryを導入した話

Laravel プロダクトに Opentelemetry を導入した話 1

自己紹介畑中亮磨ソフトウェアエンジニア千株式会社カメラマンや園の先生向けサービスの開発社内管理画面の開発趣味 Obsidian でナレッジ管理基盤を作ること 2

会社紹介人の心に火をつける。世界を動かす会社を創る幼保園向けの写真撮影・販売のサービスを提供 3

システム概要社員向け管理システム React 、Laravel BFF 、Laravel API ECS on Fargate
4

何故導入した？ 20 年物のシステム。どの画面からどのAPI を呼んでいるか十分把握出来ていない不具合調査の際はコードを読み直しながら、 BFF ・API サーバそれぞれのログを確認する表示の遅い画面を調査する際、ネットワーク
に問題があるのか、クエリに課題があるのか等調査に時間がかかる 5

導入のためにやったこと Dockerfile でphp のOpentelemetry 拡張機能の有効化ライブラリインストール数十行のコード簡単にトレースとログを取得できた 6

導入成功！！ 7

こんな効果があった画面に対して調査をする際にコードを見なくとも全体の流れを追えるようになったトレースから関連するログの確認もできる 9

ただ色々とつまずきもあった 10

スパンアトリビュートにシステム固有 ID を埋め込むにはひと手間必要 11

1. 認証ミドルウェアより後にスパンにユーザID を埋め込むミドルウェアを追加 final class AddUserIdToSpan { public function
handle(Request `$request, Closure $`next): { $span = Span::getCurrent(); if (!$span->getContext()->isValid() || !Auth::check()) return `$next($`request); } $userId = (int) Auth::id(); `$span->setAttribute('user_id', (int) $`userId); return `$next($`request); } } 12

子スパンにも埋め込めるようバゲッジにも詰めた $baggage = Baggage::getCurrent() ->toBuilder() ->set('user_id', $userId) ->build(); 13

2. バゲッジにユーザID があればスパンに追加する独自SpanProcessor を定義 final class UserIdSpanProcessor implements SpanProcessorInterf
{ public function onStart(`$span, $`parentContext): void { `$userId = Baggage::fromContext($`parentContext) ->getValue('user_id'); if ($userId !== null) { `$span->setAttribute('user_id', $`userId); } } } 14

ライブラリを参考に初期化処理を追加し、 bootstrap/app.php で呼び出すようにした Globals::registerInitializer(function (Configurator $configura ... $multiProcessor = new
MultiSpanProcessor( new UserIdSpanProcessor(), $defaultSpanProcessor, ); $tracerProvider = (new TracerProviderBuilder()) ->addSpanProcessor($multiProcessor) ->setResource($resource) ->setSampler((new SamplerFactory())->create()) ->build(); return `$configurator->withTracerProvider($`tracerProvider }); 15

HTTP リクエストのスパンと受信先のスパンを親子関係に出来ない 16

larave がHTTP リクエストの送信元の場合に発生 open-telemetry/opentelemetry-php-contrib がスパンを自動生成してくれるが、W3C Trace Context をヘッダーに注入したり、ライブラリ外からスパンを参照出来る状態になってない
から手動計装に切り替えるしか無いのか… 18

学び自動計装導入するのは簡単（ライブラリ様々ありがたい）自動計装だけでも十分効果がある細かいカスタマイズをしたいなら、手動計装に切り替えたほうが良いかもしれない 19

LaravelプロダクトにOpentelemetryを導入した話

LaravelプロダクトにOpentelemetryを導入した話

h_rym

Featured

Transcript