メインコンテンツまでスキップ

Kotlin サービスのアプリケーションシグナル

はじめに​

Kotlin Web アプリケーションのパフォーマンスと健全性をモニタリングすることは、さまざまなコンポーネント間の複雑な相互作用のため、課題となる場合があります。Kotlin Web サービスは通常、Java Archive (jar) ファイルにビルドされ、Java が動作する任意のプラットフォームにデプロイできます。これらのアプリケーションは、多くの場合、データベース、外部 API、キャッシュレイヤーなど、複数の相互接続されたコンポーネントを含む分散環境で動作します。この複雑さにより、平均解決時間 (MTTR) が大幅に増加する可能性があります。

このガイドでは、Linux EC2 サーバー上で動作している Kotlin Web サービスを自動計装する方法を説明します。CloudWatch Application Signals を有効にすることで、AWS Distro for OpenTelemetry (ADOT) Java 自動計装エージェントを使用して、コードを変更することなくアプリケーションからテレメトリを収集できます。呼び出し量、可用性、レイテンシー、障害、エラーなどの主要なメトリクスを活用して、アプリケーションサービスの現在の運用状態を迅速に確認してトリアージし、長期的なパフォーマンスとビジネス目標を満たしているかどうかを検証できます。

前提条件​

  • CloudWatch Application Signals と連携するための適切な IAM 権限 を持つ Linux EC2 インスタンス。このガイドでは Amazon Linux インスタンスを使用しているため、他のものを使用している場合はコマンドが若干異なる可能性があります。
  • インスタンスに SSH 接続する能力。

ソリューションの概要​

高レベルでは、以下の手順を実行します。

  • CloudWatch Application Signals を有効にします。
  • ktor Web サービス を fat jar としてデプロイします。
  • Web サービスから Application Signals を受信するように設定された CloudWatch エージェントをインストールします。
  • ADOT 自動計装エージェントをダウンロードします。
  • サービスを自動計装するために、Kotlin サービス jar を Java エージェントと一緒に実行します。
  • テレメトリを生成するためにいくつかのテストを実行します。

アーキテクチャ図​

Architecture

CloudWatch Application Signals を有効化する​

アカウントでステップ 1: Application Signals の有効化 の手順に従ってください。

Ktor Web サービスのデプロイ​

Ktor は、Web サービスを作成するための人気のある Kotlin フレームワークです。 非同期サーバーサイドアプリケーションを素早く開始することができます。

作業ディレクトリを作成します。

mkdir kotlin-signals && cd kotlin-signals

Ktor のサンプルリポジトリをクローンします。

git clone https://github.com/ktorio/ktor-samples.git && cd ktor-samples/structured-logging

アプリケーションをビルドします。

./gradlew build && cd build/libs

アプリケーションが正常に実行されるかテストします。

java -jar structured-logging-all.jar

サービスが正常にビルドされ実行された場合、ctrl + c で停止できます。

CloudWatch エージェントの設定​

Amazon Linux インスタンスには、デフォルトで CloudWatch エージェントがインストールされています。インスタンスにインストールされていない場合は、インストールする必要があります。

インストールが完了したら、設定ファイルを作成します。

sudo nano /opt/aws/amazon-cloudwatch-agent/bin/app-signals-config.json

以下の設定をファイルにコピーアンドペーストします。

{
    "traces": {
        "traces_collected": {
            "app_signals": {}
        }
    },
    "logs": {
        "metrics_collected": {
            "app_signals": {}
        }
    }
}

ファイルを保存し、作成した設定で CloudWatch エージェントを起動します。

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a fetch-config -m ec2 -s -c file:/opt/aws/amazon-cloudwatch-agent/bin/app-signals-config.json

ADOT 自動計装エージェントのダウンロード​

JAR ファイルが含まれているディレクトリに移動します。このデモンストレーションを簡単にするために、エージェントをここに配置します。実際のシナリオでは、おそらく独自のフォルダに配置されるでしょう。

cd kotlin-signals/ktor-samples/structured-logging/build/libs

自動計装エージェントをダウンロードします。

wget https://github.com/aws-observability/aws-otel-java-instrumentation/releases/latest/download/aws-opentelemetry-agent.jar

ADOT エージェントを使用して Ktor サービスを実行する​

OTEL_RESOURCE_ATTRIBUTES=service.name=KotlinApp,service.namespace=MyKotlinService,aws.hostedin.environment=EC2 \
OTEL_AWS_APPLICATION_SIGNALS_ENABLED=true \
OTEL_AWS_APPLICATION_SIGNALS_EXPORTER_ENDPOINT=http://localhost:4316/v1/metrics \
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4316/v1/traces \
OTEL_METRICS_EXPORTER=none \
OTEL_LOGS_EXPORT=none \
java -javaagent:aws-opentelemetry-agent.jar -jar structured-logging-all.jar

サービスにトラフィックを生成してテレメトリを作成する​

for i in {1..1800}; do curl http://localhost:8080 && sleep 2; done

テレメトリーの確認​

これで CloudWatch の「Services」セクションに Kotlin サービスが表示されるはずです。

kotlin-service

「Service Map」でもサービスを確認できます。

kotlin-service-map

この計装により、レイテンシーなどの貴重なメトリクスが提供されます：

kotlin-metrics

次のステップ​

ここからの次のステップは、SLO の作成を含む Application Signals エクスペリエンス をさらに探索することです。 もう一つの良い次のステップは、Ktor でより多くの Kotlin マイクロサービスを作成し、より複雑なバックエンドを構築し始めることです。 分散した複雑な環境こそ、Application Signals のようなツールの利点を最も活かせる場所です。

クリーンアップ​

EC2 インスタンスを終了し、/aws/appsignals/generic ロググループを削除します。