AWS Distrofor OpenTelemetry

AWS X-RayのJava SDKが基本的に使いものにならんので (ref: AWS X-Ray Java SDKのここがひどい)、OpenTelemetryを使ったものに切り替えていったほうがよい。余談であるが、X-RayはGoのSDKも致命的に出来が悪い (see also: https://shogo82148.github.io/blog/2020/03/30/aws-xray-yasdk-go/) ので、個人的な感覚としてはX-Ray SDKはもう金輪際使わない方が良いのではないだろうか。

というわけでreferenceを見て気になった部分をかいつまんでいく。対象となるアプリケーションがJavaで書かれているのでJavaの内容が中心。

当然のことながらADOT Collectorは動かしておく必要がある

https://aws-otel.github.io/docs/getting-started/collector

このドキュメントほぼ情報無い...

https://aws-otel.github.io/docs/setup/ecs

こっち見たほうが良い

デフォの設定はこれ

https://github.com/aws-observability/aws-otel-collector/blob/main/config/ecs/ecs-default-config.yaml

本家のauto instrumentationの使い方

https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/

Play2を使っているので play と play-ws の両方がサポートされているのは非常にありがたい

AWS仕様になっているOTELのJavaagent

https://aws-otel.github.io/docs/getting-started/java-sdk/trace-auto-instr

基本的にAWS環境で使っている (i.e. バックエンドはX-Rayと統合する) 場合はこれを使うことになりそう

javaagentとして食わせる点は本家のotelの使い方と同じ

デフォではOTELのexporterに投げるようになってるっぽい

localhost:4317

サンプリングについては個別に設定できるっぽい。この項目はX-Ray側のサンプリングとは独立していそうに見えるが、X-Rayのサンプリング情報を使うということもできるらしい。

OTEL_TRACES_SAMPLER

OTEL_TRACES_SAMPLER=xray とするとX-RayのRemote Sampling設定を取ってくるようになるらしい

この場合 OTEL_TRACES_SAMPLER_ARG=endpoint=http://... で指定したendpointにリクエストを打ってsampling rateを取ってくるらしい。デフォルト値は http://localhost:2000。つまりこのためにX-Rayのdaemonを動かしておけということなんだろうか？

ADOT Collectorが2000でlistenできるっぽい

OTEL_TRACES_SAMPLER_ARG

ログも出せるとのこと。どういう形式で出るんだろ。

OTEL_TRACES_EXPORTER=logger

OTEL_METRICS_EXPORTER=logger

これ微妙に意味が違って、「logを出す」ではなく「実際のtrace/metricsの送出の代わりにログ出力する」というやつだった。微妙にハマった。

X-Rayのremote samplingのrateを引っぱってくる場合

https://aws-otel.github.io/docs/getting-started/remote-sampling

とはいえわざわざこれ使う必要もそんな無い気はする。OTELのサンプリングで十分では？

いらんauto instrumentationを除去する

https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/da036f0b50aa540f47ed812f97efc881eef97ec0/docs/advanced-configuration-options.md

OTEL_JAVAAGENT_EXCLUDE_CLASSES

IAM権限について

https://aws-otel.github.io/docs/setup/permissions