OpenTelemetry のサービスという概念について

OpenTelemetry には Semantic Conventions と呼ばれる規約で service という属性が定義されています。service はメトリックが計装されたアプリケーションの名前やバージョンを表します。特に、service.name と呼ばれる属性の重要性について話します。

Transcript

1. OpenTelemetry のサービス という概念について azukiazusa
2. 自己紹介 • Web フロントエンドが得意 • https://azukiazusa.dev/ • 趣味 ◦ 読書 ◦ 麻雀 ◦ ポーカー azukiazusa
3. OpenTelemetry における サービスとは
4. テレメトリが計装された アプリケーションの 名前やバージョンを表す属性
5. http.requests.total{service.name=”payment”}
6. Semantic Conventions （意味規則）
7. メトリック名、属性名などの 共通命名や要求レベルの定義
8. 多くの規則がある • HTTP • DataBase • Resource • FaaS • Exception • …
9. 例 • HTTP サーバーリクエストの継続時間のメトリック ◦ http.server.request.duration • HTTP メソッドを表す属性 ◦ http.request.method • HTTP ステータスコードを表す属性 ◦ http.response.status_code
10. もし Semantic Conventions がなかったら...
11. マイクロサービスのダッシュボード作るぞ！
12. アプリケーションでの計装は準備できてる！ あとはクエリを書くだけ！
13. はぁ？ こっちは http.request.method だけどあっちは method だから注意してね あ、このテレメトリどこから送信されるかわからないか らよろしく
14. 言語のライブラリごとに属性の名前が違う... どういうクエリを書けばいいの...
15. よく使う属性は命名統一して！ あとどのアプリケーションから来たデータかわかる 属性は必須にして！
16. Semantic Conventions は実 装間の差異をなくし共通化す る意味で重要
17. サービスは Resource を 表す属性
18. テレメトリを生成するエンティティの情報 • 例えば、Kubernetes なら... ◦ プロセス名 ◦ Pod 名 ◦ 名前空間 ◦ Deployment 名 Resource
19. Service 属性 説明 service.name サービスの論理名 必須 service.version サービスのバージョン service.instance.id サービスインスタンスの ID 一意の文字列 である必要がある 実験的 service.namespace サービスのグループを区別する名前空 間。`service.namespace` 内で `service.name` は一意である 実験的
20. service.name は SDK によっ て必ず提供されていなければ ならない
21. ココに 注目
22. もしくは環境変数 OTEL_SERVICE_NAME
23. • service.name は必須の属性だが、SDK を初期化する 際の `resource` は必須ではない • `resource` が指定されない場合 `service.name` は `unknown_service:` + プロセス実行可能ファイルの 名前になる ◦ `unknown_service:bash` SDK 使用時の注意点
24. service.name は必ず指定すべき
25. 監視バックエンドも service.name が指定されて いること前提の UI となって ることが多い
28. • OpenTelemetry におけるサービスは Semantic Conventions で定義されている属性 • テレメトリを送信するサービスの情報を表す • サービスの名前を表す `service.name` は必ず指定し たほうがいい まとめ