このリポジトリはAmazon Web Servicesブログの Amazon DynamoDB を使った CQRS イベントストアの構築 を参考にRustでイベントソーシングを試してみたリポジトリです。
- Docker Compose: 2.22.0 and later
- aqua
- RustアプリケーションのDockerイメージをビルドする
- Docker Composeでコンテナを起動する
事前にRustアプリケーション (gRPCサーバー) のDockerイメージをビルドします。 事前にビルドするのは、Docker Composeでコンテナを起動する時間を短縮するためです。
Important
Dockerイメージのビルドに多くのリソースを利用するので1つずつビルドすることをおすすめします
# 各サービスを1つずつビルドする
docker compose build tenant-service \
&& docker compose build cart-service \
&& docker compose build order-service
# 各サービスを並列でビルドする
docker compose buildDocker Composeでアプリケーションやデータストア (DynamoDB)、オブザーバビリティ関連のコンテナを起動します。
定義ファイルはルートディレクトリの compose.yaml を利用します。
docker compose up
# アプリケーションコードの変更を検知してコンテナを作り直す
docker compose watch起動されるコンテナの説明:
- Grafana:
トレース・ログ・メトリクスを可視化します。
localhost:3000でコンソールにアクセスできます。(任意のポートに変更したい場合は環境変数GRAFANA_PORTに値を設定してください) - Grafana Tempo: トレースデータを収集します
- Grafana Loki: ログデータを収集します
- Prometheus: メトリクスデータを収集します
- OpenTelemetry Collector Agent: アプリケーションから送信されたテレメトリーデータを収集し、バックエンド (OpenTelemetry Collector Gateway) に送信します
- OpenTelemetry Collector Gateway: OpenTelemetry Collector Agent からテレメトリーデータを集約してバックエンドに送信します
- LocalStack:
ローカルマシン上にAWS環境をエミュレートします。
ローカルからLocalStackにリクエストする場合は
localhost:4566にアクセスしてください。(任意のポートに変更したい場合は環境変数LOCALSTACK_GATEWAY_PORTに値を設定してください) - Terraform:
LocalStackに対してリソースを作成します。
リソースの定義は
terraformディレクトリ配下で定義されています。 - アプリケーション: gRPCサーバーを起動します
- テナントサービス:
localhost:50051でアクセスできます。(任意のポートに変更したい場合は環境変数TENANT_SERVICE_PORTに値を設定してください) - カートサービス:
localhost:50052でアクセスできます。(任意のポートに変更したい場合は環境変数CART_SERVICE_PORTに値を設定してください) - 注文サービス:
localhost:50053でアクセスできます。(任意のポートに変更したい場合は環境変数ORDER_SERVICE_PORTに値を設定してください)
- テナントサービス:
環境変数:
| 環境変数名 | 説明 | デフォルト値 |
|---|---|---|
GRAFANA_PORT |
Grafanaのコンソールにアクセスするためのポートを指定する | 3000 |
GRAFANA_TEMPO_LOG_LEVEL |
Grafana Tempoのログレベル | error |
LOCALSTACK_GATEWAY_PORT |
LocalStackにアクセスするためのポート | 4566 |
DOCKER_HOST_SOCK |
Dockerソケットの場所 | -/var/run/docker.sock |
TENANT_SERVICE_PORT |
テナントサービスにアクセスするためのポート | 50051 |
CART_SERVICE_PORT |
カートサービスにアクセスするためのポート | 50052 |
ORDER_SERVICE_PORT |
注文サービスにアクセスするためのポート | 50053 |
シナリオテストができる runn で各サービスのRPCを呼び出すことができます。
runn はaquaで自動でインストールされます。
runn run --grpc-no-tls tests/runn/runbook.yaml各サービスのRPCを呼び出すクライアントはaquaで自動でインストールされます。
GUIベースの gRPC UI か curl ライクな Buf CLI を利用できます。
# gRPC UIを起動する
# ポートは呼び出したいgRPCサーバーに応じて変更してください
grpcui -plaintext localhost:50051
# Buf CLIでRPCを呼び出す
# エンドポイントは呼び出したいgRPCサーバーに応じて変更してください
buf curl --protocol grpc --http2-prior-knowledge \
--data '{ "name": "テストテナント" }' \
http://localhost:50051/tenant.v1.TenantService/CreateエンドポイントをLocalStackに向けるとAWS CLIでAmazon DynamoDBのテーブルやAmazon CloudWatch Logsなどを確認できます
# オプションでエンドポイントを指定する
aws dynamodb --endpoint-url http://localhost:4566 list-tables
# 環境変数でエンドポイントを指定する
AWS_ENDPOINT=http://localhost:4566 aws dynamodb list-tables