AWS AppSync の監視
「 Instana 」エージェントをインストールすると、「 AWS AppSync 」センサーが自動的に展開およびインストールされます。 「 AWS AppSync 」に関連するメトリクスは、「 Instana 」のUIで確認できます。
メトリックの表示
メトリックを表示するには、以下のステップを実行します。
- Instana のUIのサイドバーで、 「インフラストラクチャ」 を選択します。
- 監視対象の AWS AppSync インスタンスを1つクリックします。
収集されたすべてのメトリクスが表示された AWS AppSync のダッシュボードを確認できます。
構成データ
AWS AppSync センサーは、以下の AppSync データを収集します:
- ARN
- 名前
- リージョン
- API ID
- API タイプ
- 認証タイプ
- 表示設定
- データ・ソース
メトリック
AWS AppSync センサーは、以下のメトリクスを収集します:
| 名前 | 説明 |
|---|---|
| 4xx エラー | 期間内のクライアント構成が正しくないために無効な要求が原因で発生したエラーの数。 |
| 5xx エラー | 期間内に GraphQL 照会の実行中に発生したエラーの数。 |
| 合計エラー数 | 一定期間内のエラーの総数 (4xx + 5xx)。 |
| 待ち時間 | AWS AppSync がクライアントからリクエストを受信してから、クライアントに応答を返すまでの平均時間。 |
| 要求 | 期間内にアカウント内のすべての API が処理した要求 (照会 + 変異) の総数 (地域別)。 |
| 消費されたトークン | 期間内に特定の領域で処理された要求に割り振られたトークンの総数。 |
| 接続成功 | 一定期間内に WebSocket から AWS AppSync への接続が成功した総数。 |
| Connect クライアント・エラー | 一定期間内に、クライアント側のエラーにより AWS AppSync によって拒否された WebSocket 接続の数。 |
| 接続サーバー・エラー | 一定期間内に接続が処理される過程で、 AWS AppSync に起因するエラーの件数。 |
| サブスクライブ成功 | 一定期間内に、 WebSocket を通じて AWS AppSync に正常に登録されたサブスクリプションの数。 |
| サブスクライブ・クライアント・エラー | ある期間内に、クライアント側のエラーを理由に AWS AppSync によって拒否されたサブスクリプションの数。 |
| サブスクライブ・サーバー・エラー | 特定の期間内にサブスクリプションが処理される過程で、 AWS AppSync に起因するエラーの件数。 |
| データ・メッセージのパブリッシュの成功 | 一定期間に正常にパブリッシュされたサブスクリプション・イベント・メッセージの数。 |
| パブリッシュ・データ・メッセージ・クライアント・エラー | 一定期間内にクライアント・サイドのエラーが原因でパブリッシュに失敗したサブスクリプション・イベント・メッセージの数。 |
| パブリッシュ・データ・メッセージ・サーバー・エラー | 一定期間内にサブスクリプションイベントメッセージが発行される際に、 AWS AppSync に起因するエラーの件数。 |
| パブリッシュ・データ・メッセージ・サイズ | パブリッシュされたサブスクリプション・イベント・メッセージのサイズ (バイト単位)。 |
| アクティブな接続 | 1分間にクライアントから AWS AppSync への WebSocket 同時接続数。 |
| アクティブなサブスクリプション | 1 分間におけるクライアントからの同時サブスクリプションの数。 |
| 接続時間 | 接続が開いたままになっている平均時間。 |
必要なアクセス権
AWS AppSync センサーには、以下の権限が必要です:
cloudwatch:GetMetricDatacloudwatch:GetMetricStatisticsappsync:ListGraphqlApisappsync:GetGraphqlApiappsync:ListDataSources
構成
AWS AppSync のメトリクスは60秒ごとに取得されます。 この設定は、 <agent_install_dir>/etc/instana/configuration.yml ファイルで変更できます。
com.instana.plugin.aws.appsync:
cloudwatch_period: 60
AppSync インスタンスのモニターを無効にするには、以下の構成を使用します。
com.instana.plugin.aws.appsync:
enabled: false
プロキシ設定の有効化
AWS AppSync センサーでプロキシ設定を使用できるようにするには、以下のエージェント設定を追加してください:
com.instana.plugin.aws.appsync:
proxy_host: 'example.com' # proxy host name or ip address
proxy_port: 3128 # proxy port
proxy_protocol: 'HTTP' # proxy protocol: HTTP or HTTPS
proxy_username: 'username' # OPTIONAL: proxy username
proxy_password: 'password' # OPTIONAL: proxy password
複数の AWS アカウントのモニター
同じリージョン内の 1 つの AWS エージェントを使用して複数の AWS アカウントのモニターをセットアップするには、 「複数の AWS アカウントのモニター」 トピックを参照してください。
AWS -命名済みプロファイル方式
AWS AppSync の監視に使用するプロファイルを上書きするには、以下の設定を使用してください:
com.instana.plugin.aws.appsync:
profile_names:
- 'profile2'
- 'profile3'
AWS STS を使用する方法
AppSync, の監視に使用するIAMロールを上書きするには、以下の設定を使用してください:
com.instana.plugin.aws.appsync:
role_arns:
- 'arn:aws:iam::<account_1_id>:role/<role_1_name>'
- 'arn:aws:iam::<account_2_id>:role/<role_2_name>'
タグを定義してフィルタリングする
それぞれをコンマで区切って、複数のタグを定義できます。 タグは、キーと値のペアとして指定する必要があります。 構成を容易にするために、どのタグをディスカバリーに含めるか、またはディスカバリーから除外するかを定義できます。 両方のリスト (include および exclude) でタグを定義すると、 exclude リストの優先順位が高くなります。 サービスをフィルタリングする必要がない場合は、タグを定義する必要はありません。 フィルタリングを有効にするためにすべての値を定義することは必須ではありません。
tagged-services-poll-rate 構成プロパティーを使用して、センサーが AWS タグ付きリソースをポーリングする頻度を指定できます。 デフォルトでは、この値は 300 秒です。
タグ付けされたリソースをセンサーがポーリングする頻度を定義するには、以下の構成を使用します。
com.instana.plugin.aws:
tagged-services-poll-rate: 60 #default 300
タグによってサービスをディスカバリーに組み込むには、以下の構成を使用します。
com.instana.plugin.aws.appsync:
include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)
タグによってサービスをディスカバリーから除外するには、以下の構成を使用します。
com.instana.plugin.aws.appsync:
exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)
タグのない AWS サービスはデフォルトでモニターされますが、 include_untagged フィールドを falseに設定することで除外できます。
com.instana.plugin.aws.appsync:
include_untagged: false # True value by default