OpenTelemetryを使ってアプリケーションのメトリクスを取る / Kofu.なんか #1 #kofuasterisk

https://houtoupm.connpass.com/event/357176/ でOpenTelemetryでメトリクスを取る話をしました。

Transcript

1. OpenTelemetryを使って アプリケーションの メトリクスを取る id:ymse / @azukibar_D 2025/08/16 Kofu.なんか #1 1
2. お前だれ - X: @azukibar_D - GitHub: Azuki-bar - 株式会社はてなでアプリケーションエンジニア として働いています - toittaという生成AIを活用した発話分析ソリューション を作っています 2
3. お断り OpenTelemetryを用いた製品(Mackerel)を作っ ている会社にいます 3
4. 想定読者とおおまかな内容 - 想定読者 - OpenTelemetryの名前を聞いたことはある - 内容 - OpenTelemetryを知るために実際に手を動かした記録 4
5. お品書き - OpenTelemetryについて - 実際にやってみる - やってみての疑問と解決 - 感想・まとめ 5
6. 6 OpenTelemetry
7. OpenTelemetry - オープンなプロジェクト - CNCF Incubating - オブザーバビリティを実現するためのフレーム ワークでありツールキット - OTelと略される - Tは大文字 7
8. オブザーバビリティの実現？ - サービスの状態（=Signals)を取る - メトリクス - トレース - ログ - （将来的には）プロファイル？ - 取った状態を表現するプロトコル - データの命名規則 8
9. オブザーバビリティの実現？ - サービスの状態（=Signals)を取る - メトリクス - トレース - ログ - （将来的には）プロファイル？ - 取った状態を表現するプロトコル - データの命名規則 9
10. メトリクス - サービスに関する時系列データ - CPU使用率, アクセス数, etc… - 適切に取得すると、異変を認知したりコン ピュートリソースを調整できたりする - メトリックが単数形で、メトリクスが複数形 10
11. 計装 - メトリクスなどSignalsを取得すること - 方法はふたつ - APIとSDKを使って自分で取得するコードを書く - Code-based solutions - Zero-codeでいい感じにしてくれるくんを入れる 11
12. 計装 - メトリクスなどSignalsを取得すること - 方法はふたつ - APIとSDKを使って自分で取得するコードを書く - Code-based solutions - Zero-codeでいい感じにしてくれるくんを入れる 12
13. 13 実際にメトリクスを取っ てみる
14. 14 実際に取ってみる - 計装するためのコードを書く - 普段Nodeアプリケーションを書いているので Nodeのコード例
15. メトリクスの種類 メトリクスには3種類あるので選ぶ - インクリメントする Counter - 特定タイミングの値を取る Gauge - 統計情報を取る Histogram 15
16. 16 メトリクスを取るまで - OTel SDKを初期化する - 値を取りたいところでAPIを呼ぶ SDKとAPIの話はあとでします
17. OTel SDKを初期化する import { NodeSDK } from '@opentelemetry/sdk-node'; import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; const sdk = new NodeSDK({ metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: 'http://127.0.0.1:4317', }), }), }); sdk.start(); 17
18. OTel SDKを初期化する import { NodeSDK } from '@opentelemetry/sdk-node'; import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; const sdk = new NodeSDK({ metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: 'http://127.0.0.1:4317', }), }), }); sdk.start(); 18 PeriodicExportingMe tricReader メモリに抱えつつ、定 期的に外部へ送信する
19. OTel SDKを初期化する import { NodeSDK } from '@opentelemetry/sdk-node'; import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; const sdk = new NodeSDK({ metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: 'http://127.0.0.1:4317', }), }), }); sdk.start(); 19 gRPCでメトリクスを吐 く実装
20. OTel SDKを初期化する import { NodeSDK } from '@opentelemetry/sdk-node'; import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; const sdk = new NodeSDK({ metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: 'http://127.0.0.1:4317', }), }), }); sdk.start(); 20 4317でgRPCを、4318で HTTPをリッスンしている のが一般的
21. OTel SDKを初期化する import { NodeSDK } from '@opentelemetry/sdk-node'; import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; const sdk = new NodeSDK({ metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: 'http://127.0.0.1:4317', }), }), }); sdk.start(); 21 今回は省略しているが、ト レースや自動計装する設定 もここに書く
22. OTel SDKを初期化する import { NodeSDK } from '@opentelemetry/sdk-node'; import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; const sdk = new NodeSDK({ metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: 'http://127.0.0.1:4317', }), }), }); sdk.start(); 22 最後にstartする 省略しているが、 sdk.shutdown()もある
23. APIを呼ぶ import * as OTel from '@opentelemetry/api'; const meter = OTel.metrics.getMeter('default'); const counter = meter.createCounter('custom.foo'); counter.add(1); 23
24. APIを呼ぶ import * as OTel from '@opentelemetry/api'; const meter = OTel.metrics.getMeter('default'); const counter = meter.createCounter('custom.foo'); counter.add(1); 24 Meter（後述）を取得
25. APIを呼ぶ import * as OTel from '@opentelemetry/api'; const meter = OTel.metrics.getMeter('default'); const counter = meter.createCounter('custom.foo'); counter.add(1); 25 Counter, Gauge, Histogramから選んで、値を 記録するためのインスタンスを作る
26. メトリクスの種類（再掲） メトリクスには3種類あるので選ぶ - インクリメントする Counter - 特定タイミングの値を取る Gauge - 統計情報を取る Histogram 26
27. APIを呼ぶ import * as OTel from '@opentelemetry/api'; const meter = OTel.metrics.getMeter('default'); const counter = meter.createCounter('custom.foo'); counter.add(1); 27 実際に値を記録する
28. めでたしめでたし - ここまでやれば大体値が取れる - あとは好みのSaaSだったり, OTel Collectorだったりに 送る - 疑問に思う - なんでSDKとAPI分かれているの？ - getMeterってどこから何をgetしているの？ 28
29. 29 疑問と解決
30. 30 疑問が2つある - SDKとAPIは分かれているけどなぜ？ - meterって何？ 定義を読んでみて考えよう
31. 31 疑問が2つある - SDKとAPIは分かれているけどなぜ？ - meterって何？ 定義を読んでみて考えよう
32. OTel API - > トレース、メトリクス、およびロギングデー タを生成および相関させるためのデータ型と操 作を定義します。 - https://opentelemetry.io/ja/docs/concepts/compo nents/ - 要はインターフェース(I/F)だけを定義してい る - ここでのI/Fは、I/Fに依存するなどの文脈のI/F 32
33. OTel SDK - > 言語固有のAPI実装の要件を定義します。設 定、データ処理、エクスポートの概念もここで 定義されます。 - https://opentelemetry.io/ja/docs/concepts/compo nents/ - 具体の実装 - APIで定義されたI/Fから呼ばれる実体 33
34. OTel SDKを初期化する import { NodeSDK } from '@opentelemetry/sdk-node'; import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics'; import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc'; const sdk = new NodeSDK({ metricReader: new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter({ url: 'http://127.0.0.1:4317', }), }), }); sdk.start(); 34 設定 エクスポート
35. これってもしや？ - まさに依存性逆転の原則 - ライブラリはAPIにだけ依存していると嬉しい - ライブラリを使う側で実装を差し変えられる - 実装 - signalsの送信先やサンプリングなど - これらはSDKでユーザーが定義している 35
36. 36 疑問が2つある - SDKとAPIは分かれているけどなぜ？ - meterって何？ 定義を読んでみて考えよう
37. APIを呼ぶ（再掲） import * as OTel from '@opentelemetry/api'; const meter = OTel.metrics.getMeter('foo'); const counter = meter.createCounter('custom.foo'); counter.add(1); 37
38. そもそもMeterとは？ - > メーターはメトリクス計装を作成し、実行時 にサービスに関する測定値を取得します。 メー ターはメータープロバイダーから作成されま す。 - https://opentelemetry.io/ja/docs/concepts/signals /metrics/#meter 38
39. ようは - API呼び出しするためのクライアントくらいに 思っている - けどあっている自信がない 39
40. APIを呼ぶ（再掲） import * as OTel from '@opentelemetry/api'; const meter = OTel.metrics.getMeter('foo'); const counter = meter.createCounter('custom.foo'); counter.add(1); 40
41. APIを呼ぶ（再掲） import * as OTel from '@opentelemetry/api'; const meter = OTel.metrics.getMeter('foo'); const counter = meter.createCounter('custom.foo'); counter.add(1); 41 どこからgetMeter しているの？
42. getMeterの型定義 export declare class MetricsAPI { /** * Returns a meter from the global meter provider. */ getMeter(name: string, version?: string, options?: MeterOptions): Meter; } 42 https://github.com/open-telemetry/opentelemetry-js/blob/927032ffd956eac7 3d0a1a98212aded9bf8a0107/api/src/api/metrics.ts#L29-L77 より。一部改変
43. global meter provider 43 どこかでMeter Providerを定義し、グローバル に置いていそう
44. もう一度ドキュメントを読む - > いくつかの言語SDKでは、グローバルな メータープロバイダーがすでに初期化されてい ます。 - https://opentelemetry.io/ja/docs/concepts/signals /metrics/#meter-provider 44
45. global meter provider 45 どこかでMeter Providerを定義し、グローバル に置いていそう
46. global meter provider 46 どこかでMeter Providerを定義し、グローバル に置いていそう -> SDK側で初期化されている
47. global meter provider 47 どこかでMeter Providerを定義し、グローバル に置いていそう -> SDK側で初期化されている -> これ依存性の注入（DI）だ！
48. 48 まとめと感想
49. まとめ - OpenTelemetryを知る - 実際に手を動かしメトリクスを取った - 手を動かすことにより疑問が出たので解消した 49
50. 50 感想 - OpenTelemetryの世界は広い - 今は無知を知った状態 - 「依存関係逆転だこれ」と思えたの良かった - 過去の経験が活きているのを実感 - こういう発見ができる領域を増やしたい
51. 今後への宿題 - キーワードは聞いたけど知らない概念 - Semantic Conventions - OTel Collectorでどんなことできるの - OpenTelemetry実装への興味 - 他言語ではどうなっているのか - 自動計装はどうやって実装されているのか 51