ステップ 2: アプリケーションモニターを作成する
アプリケーションで CloudWatch RUM の使用を開始するには、アプリケーションモニター を作成します。アプリケーションモニターが作成されると、アプリケーションに貼り付けるための JavaScript スニペットが、RUM により生成されます。このスニペットは RUM のウェブクライアントコードを読み込みます。RUM のウェブクライアントは、アプリケーションのユーザーセッションの割合に関するデータをキャプチャし、それを RUM に送信します。
アプリケーションモニターを作成するには
CloudWatch コンソール (https://console.aws.amazon.com/cloudwatch/
) を開きます。 ナビゲーションペインで、[Application Signals]、[RUM] の順に選択します。
[Add app monitor] (アプリケーションモニターを追加) をクリックします。
アプリケーションの情報と設定を入力します。
[App monitor name] (アプリケーションモニター名) に、CloudWatch RUM コンソール内でこのモニターを識別する際に使用する名前を入力します。
[Application domain] (アプリケーションドメイン) で、アプリケーションが管理権限を持つ最上位レベルのドメイン名を入力します。この情報は URL ドメイン形式であることが必要です。
[Include sub domains] (サブドメインを含める) を選択し、トップレベルドメインの下に存在するすべてのサブドメインから、アプリケーションモニターがデータを収集するようにします。
[Configure RUM data collection] (RUM データ収集の設定) で、以下の各情報をアプリケーションモニターに収集させるかどうかを指定します。
パフォーマンステレメトリ – ページならびにリソースのロード時間に関する情報を収集します。
JavaScript エラー – アプリケーションによって発生した未処理の JavaScript エラーに関する情報を収集します。
HTTP エラー – アプリケーションによってスローされた HTTP エラーに関する情報を収集します。
これらのオプションを選択することで、アプリケーションに関する詳細情報を得ることができますが、同時により多くの CloudWatch RUM イベントが生成されるため、発生する料金も増加します。
これらのいずれかを選択しない場合でも、アプリケーションモニターはセッション開始イベントとページ ID を収集します。これにより、アプリケーションを使用しているユーザーの数を詳細情報 (オペレーティングシステムの種類とバージョン、ブラウザの種類とバージョン、デバイスの種類、および場所など) ごとに確認できます。
サンプリングされたユーザーセッションからの、ユーザー ID とセッション ID の収集を可能ににする場合には、[Check this option to allow the CloudWatch RUM Web Client to set cookies] ( CloudWatch RUM ウェブクライアントでクッキーを設定する場合このオプションをオンにします) を選択します。ユーザー ID は RUM によってランダムに生成されます。詳細については、「CloudWatch RUM ウェブクライアント Cookie (または類似の技術)」を参照してください。
[Session samples] (セッションサンプル) で、RUM データの収集に使用されるユーザーセッションの割合を入力します。デフォルトでこの値は 100% に設定されています。この数を減らすと、取得されるデータは少なくなりますが料金が削減されます。RUM での料金の詳細については、「RUM pricing」を参照してください。
CloudWatch RUM 用に収集したエンドユーザーデータは 30 日間保持され、その後削除されます。RUM イベントのコピーを CloudWatch Logs に保存し、そのコピーの保持期間を設定する場合は、[Data storage] (データストレージ) で、[Check this option to store your application telemetry data in your CloudWatch Logs account] (テレメトリデータを CloudWatch Logs アカウントに保存するにはこのオプションをオンにします) を選択します。デフォルトでは、CloudWatch Logs のロググループは 30 日間データを保持します。ログの保持期間は、CloudWatch Logs コンソールで管理できます。
[Authorization] (認証) で、(新規または既存の) Amazon Cognito ID プールを使用するか、異なる ID プロバイダーを使用するかを指定します。新しい ID プールの作成は、他のセットアップ手順を必要としない最も簡単なオプションです。詳細については、「ステップ 1: AWS にデータを送信することを、アプリケーションに許可する」を参照してください。
Amazon Cognito ID プールの新規作成には、管理者権限が必要です。詳細については、「CloudWatch RUM 使用のための IAM ポリシー」を参照してください。
(オプション) デフォルトでは、アプリケーションに RUM コードスニペットを追加すると、ウェブクライアントにより、そのアプリケーションのすべてのページの HTML コード内にモニターリング用の JavaScript タグが挿入されます。これを変更するには、[Configure pages] (ページの設定) をクリックた後に、[Include only these pages] (これらのページのみを含める)、または[Exclude these pages] (これらのページを除外する) のどちらかを選択します。その上で、含める、もしくは除外するページを指定します。含めるか除外するページを指定するには、その完全な URL を入力します。追加のページを指定するには、[Add URL] (URLを追加) をクリックします。
アプリケーションモニターによってサンプリングされたユーザーセッションで AWS X-Ray トレースを有効化するには、[Active tracing] (アクティブなトレース) をクリックし、[Trace my service with AWS X-Ray] を選択します。
これを選択すると、ユーザーセッション中に発行されアプリモニターによってサンプリングされた、
XMLHttpRequestおよびfetchリクエストがトレースされるようになります。その後、これらのユーザーセッションについてのトレースとセグメントを、RUM ダッシュボード、X-Ray トレースマップページ、X-Ray トレースの詳細ページ上に表示できるようになります。これらのユーザーセッションは、Application Signals でアプリケーションを有効にすると、そこにクライアントページとしても表示されます。CloudWatch RUM ウェブクライアントの設定をさらに変更することで、HTTP リクエストに X-Ray トレースヘッダーを追加し、AWS のマネージド型サービスにおけるユーザーセッションを、下流方向にエンドツーエンドでトレースできるようになります。詳細については、「X-Ray でのエンドツーエンドのトレースを有効にする」を参照してください。
(オプション) アプリケーションモニターにタグを追加する場合は、[Tags] (タグ)、[Add new tag] (新しいタグを追加) の順にクリックします。
次に、[Key] (キー) でタグの名前を入力します。[値] では、任意でタグに値を追加できます。
(オプション) 別のタグを追加するには、[Add new tag] (新しいタグを追加) を再度選択します。
詳細については、「AWS リソースのタグ付け」を参照してください。
[Add app monitor] (アプリケーションモニターを追加) をクリックします。
[Sample code] (サンプルコード) セクションで、アプリケーションに追加するために使用するコードスニペットをコピーできます。[JavaScript] または [TypeScript] を選択し、NPM を使用して、CloudWatch RUM ウェブクライアントを JavaScript モジュールとしてインストールすることをお勧めします。
または、[HTML] を選択し、コンテンツ配信ネットワーク (CDN) を使用して、CloudWatch RUM ウェブクライアントをインストールすることもできます。CDN を使用するデメリットは、Web クライアントが広告ブロッカーによって頻繁にブロックされることです。
[Copy] (コピー) または [Download] (ダウンロード)、続いて [Done] (完了) をクリックします。
