Amazon DocumentDBの監視

Instana Amazon DocumentDB を監視し、Amazon DocumentDB センサーを使用して環境の可視性を提供します。

Instana エージェントをインストールすると、Amazon DocumentDB センサーが自動的にデプロイおよびインストールされます。 「 Instana 」のUIでは、Amazon DocumentDB に関連するメトリクスを確認できます。

Amazon DocumentDB はインスタンスベースのクラスタとエラスティックなクラスタをサポートしています。 Amazon DocumentDB センサーは、インスタンスベースのクラスタとインスタンスの両方のタイプを監視します。

インスタンス ベースのクラスタでは、Amazon DocumentDB センサーは以下のエンジン バージョンをサポートします:

  • 5.0.0 (デフォルト)
  • 4.0.0
  • 3.6.0

その他のサポート対象の AWS サービスに関する詳細については、『 AWS 』のドキュメントを参照してください。

必要なアクセス権

Amazon DocumentDB センサーは、Amazon DocumentDB: からメトリクスを収集するために、次の AWS Identity and Access Management (IAM) パーミッションが必要です

  • docdb-elastic:ListClusters
  • docdb-elastic:GetCluster
  • docdb-elastic:ListTagsForResource
  • rds:DescribeDBClusters
  • rds:DescribeDBInstances
  • rds:ListTagsForResource

Amazon DocumentDB センサーの設定

Instana ホストエージェントをインストールすると、デフォルトで Instana が自動的に設定され、Amazon DocumentDB のクラスターおよびインスタンスを監視するようになります。

Amazon DocumentDB のメトリクスは1分ごとに収集されますが、 Instana<agent_install_dir>/etc/instana/configuration.yamlエージェントの設定ファイルで以下の設定を行うことで、この間隔を変更できます:

com.instana.plugin.aws.documentdb:
  cloudwatch_period: 300

センサーを無効にする

DocumentDB クラスターとインスタンスの監視を無効にするには、以下の設定を使用します:

com.instana.plugin.aws.documentdb:
  enabled: false

プロキシ設定の有効化

Amazon DocumentDB センサーがプロキシ構成を使用できるようにするには、以下のエージェント構成設定を追加します:

com.instana.plugin.aws.documentdb:
  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アカウントの監視を設定するには、2つのアプローチを使用できます。 詳細については、複数のAWSアカウントを監視するを参照してください。

AWS 名前付きプロファイルを使用する方法

AWS named profilesアプローチでは、プロファイルを定義することができます。 DocumentDB,を監視するために使用されるプロファイルを上書きするには、エージェント・コンフィギュレーション・ファイルで以下のコンフィギュレーションを使用します:

com.instana.plugin.aws.documentdb:
  profile_names:
    - 'profile2'
    - 'profile3'
注: サービスレベルでプロファイルを定義した場合、それらのプロファイルはグローバルな AWS プロファイルの設定よりも優先されます。

AWS セキュリティ・トークン・サービス(STS)のアプローチ

Amazon DocumentDB,の監視に使用されるIAMロールをオーバーライドするには、エージェント・コンフィギュレーション・ファイルで以下のコンフィギュレーションを使用します:

com.instana.plugin.aws.documentdb:
  role_arns:
    - 'arn:aws:iam::<account_1_id>:role/<role_1_name>'
    - 'arn:aws:iam::<account_2_id>:role/<role_2_name>'
注: サービスレベルでIAMロールを定義した場合、これらのロールはグローバルな AWS のIAMロールの設定よりも優先されます。

タグでサービスを絞り込む

Instana デフォルトでは、すべてのAmazon DocumentDB サービスを監視します。 カンマで区切って複数のタグを定義することで、監視するサービスを設定できる。 タグは、コロン(:)で区切られたキーと値のペアとしてconfiguration.yamlファイルに記述する必要があります。 Amazon DocumentDB センサーを簡単に設定するには、検出対象に含めるタグや除外するタグを定義できます。 タグが両方のリスト(インクルードとエクスクルード)に定義されている場合、エクスクルードリストの方が優先されます。 サービスレベルのフィルタリングが必要ない場合は、 DocumentDB の設定を定義する必要はありません。これは、設定が AWS の設定レベルで行われるためです。

AWSタグ付きリソースをポーリングするセンサーの間隔(デフォルトは60秒)は、設定プロパティtagged-services-poll-rateで指定できます。

注: タグは、AWS エージェントでのみ使用可能です。

AWSタグ付きリソースをポーリングするセンサーの間隔を定義するには、以下の設定を使用します:

com.instana.plugin.aws:
  tagged-services-poll-rate: 60 #default 60

タグによるサービスをディスカバリーに含めるには、以下の設定を更新する:

com.instana.plugin.aws.documentdb:
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

タグによるサービスをディスカバリーから除外するには、以下の設定を更新する:

com.instana.plugin.aws.documentdb:
  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.documentdb:
  include_untagged: false # True value by default

メトリックの表示

メトリクスを表示するには、以下の手順を実行します:

  1. Instana のUIにあるナビゲーションメニューから、 「インフラストラクチャ」 を選択します。
  2. 特定の監視対象Amazon DocumentDBインスタンスをクリックします。 Amazon DocumentDB インスタンスのダッシュボードに、収集されたすべてのメトリクスが表示されます。
  3. ダッシュボードの左上にあるパンくずから、インスタンスに関連付けられているクラスタを選択します。 クラスタのメトリクスを見ることができる。

DocumentDB インスタンスベースのクラスター

以下のセクションでは、DocumentDB インスタンス ベースのクラスタで収集された構成データとメトリックを示します。

構成データ

次の表は、Amazon DocumentDB インスタンスベースのクラスターで収集された構成データの概要です:

DocumentDBクラスタの詳細 説明
ARN DocumentDB インスタンスベースのクラスタの Amazon Resource Name (ARN) です。
クラスター・タイプ クラスタのタイプ(インスタンスベースまたはエラスティック)。
クラスター作成時刻 クラスタが作成された時刻。
名前 クラスターの名前。
エンジンのバージョン クラスターのエンジンバージョン。 値は 5.0.0 (デフォルト)、4.0.0 または 3.6.0 です。

メトリック

次の表に、Amazon DocumentDB インスタンス ベースのクラスターのメトリックの詳細を概説します:

クラスターのメトリック 説明
CPU 使用率 CPU 使用量の割合。 クラスタの場合、この指標はすべてのインスタンスのCPU使用率の値を集約したものである。
DatabaseConnections クラスタ上で開かれている接続の数で、1分間隔で収集される。
ボリューム ReadIOPs 5分間隔で報告される、クラスタ・ボリュームからの請求済み読み取りI/O操作の平均数。
ボリューム WriteIOPs 5分間隔で報告される、クラスタ・ボリュームからの請求済み書き込みI/O操作の平均数。
削除されたドキュメント 1分間に削除された文書の数。
挿入されたドキュメント 1分間に挿入される文書の数。
資料更新 1分間に更新されたドキュメントの数。
返却された書類 1分間に返されたドキュメントの数。
読み取りスループット 1秒間にディスクから読み込まれる平均バイト数。
書き込みスループット 1秒間にディスクに書き込まれる平均バイト数。
トランザクション・オープン クラスタ内で1分間にオープンされたトランザクションの数。
トランザクション・オープン・マックス クラスタ上で1分間にオープンされるトランザクションの最大数。
トランザクション・オープンが使用されています 取引残高÷取引残高最大値×100。
読み取り待ち時間 ディスクの読み取りI/O操作にかかる平均時間。
書き込み待ち時間 ディスクI/O操作1回あたりにかかる平均時間(ミリ秒)。
DBCluster ReplicaLag 最大 プライマリ・インスタンスとクラスター内の各 Amazon DocumentDB インスタンス間の最大ラグ量 (ミリ秒単位)。
DBCluster ReplicaLag 最小値 プライマリ・インスタンスとクラスタ内の各レプリカ・インスタンス間の最小ラグ量(ミリ秒)。
トランザクション開始 1分間に開始されたトランザクションの数。
異常終了したトランザクション 1分間に中止されたトランザクション数。
コミット済みのトランザクション 1分間にコミットされたトランザクション数。

DocumentDB インスタンス

Amazon DocumentDB センサーは、Amazon DocumentDB インスタンスから以下のデータを収集します:

構成データ

DocumentDBインスタンスの詳細 説明
インスタンス ARN DocumentDB インスタンスの Amazon Resource Name (ARN) です。
クラスター ARN インスタンスを含む DocumentDB クラスタの ARN。
インスタンス作成時間 インスタンスが作成され、クラスタに追加された時刻。
名前 DocumentDB インスタンスの名前。
プロモーション階層 フェイルオーバー時および高可用性時にインスタンスがクラスタ内で果たす役割。 最も低い昇格ティア値(通常は1)を持つインスタンスは、新しいプライマリになる優先順位が最も高い。

メトリック

次の表に、Amazon DocumentDB インスタンスのメトリックの詳細を概説します:

ノード・メトリック 説明
CPU 使用率 CPU 使用量の割合。
データベース接続数 インスタンス上で開かれている接続の数で、1分間の頻度で収集される。
データベース接続最大数 1分間にインスタンス上でオープンされるデータベース接続の最大数。
使用データベース接続 データベース接続数 ÷ データベース接続数最大値 * 100.
ReadIOPs 1秒あたりのディスク読み取り操作の平均回数。
WriteIOPs 1秒あたりのディスク書き込み操作の平均回数。
削除されたドキュメント 1分間に削除された文書の数。
挿入されたドキュメント 1分間に挿入される文書の数。
資料更新 1分間に更新される文書の数。
返却された書類 1分間に返される文書の数。
読み取りスループット 1秒間にディスクから読み込まれる平均バイト数。
書き込みスループット 1秒間にディスクに書き込まれる平均バイト数。
トランザクション・オープン 1分間にインスタンスでオープンされているトランザクションの数。
トランザクション・オープン・マックス 1分間にインスタンス上でオープンされるトランザクションの最大数。
トランザクション・オープンが使用されています 取引残高÷取引残高最大値×100。
読み取り待ち時間 ディスクの読み取りI/O操作にかかる平均時間。
書き込み待ち時間 ディスクI/O操作1回あたりにかかる平均時間(ミリ秒)。
DBInstance ReplicaLag アップデートがプライマリ・インスタンスからレプリカ・インスタンスにレプリケートされる際のラグ量。
トランザクション開始 1分間に開始されたトランザクションの数。
異常終了したトランザクション 1分間に中止されたトランザクション数。
コミット済みのトランザクション 1分間にコミットされたトランザクション数。

DocumentDB 弾性クラスター

Amazon DocumentDB センサーは、Amazon DocumentDB エラスティッククラスターから以下のデータを収集します:

構成データ

DocumentDBエラスティッククラスターの詳細 説明
ARN DocumentDBエラスティッククラスターのAmazonリソース名(ARN)。
クラスター・タイプ クラスタのタイプ(インスタンスベースまたはエラスティック)。
クラスター作成時刻 クラスタが作成された時刻。
名前 クラスターの名前。

メトリック

クラスターのメトリック 説明
CPU 使用率 プライマリ・インスタンスのCPU使用率。
DatabaseConnections クラスタ上で開かれている接続の数で、1分間隔で収集される。
ボリューム ReadIOPs 5分間隔で報告されるクラスタ・ボリュームからの請求済み読み取りI/O操作の平均数。
ボリューム WriteIOPs 5分間隔で報告される、クラスタ・ボリュームからの請求済み書き込みI/O操作の平均数。
削除されたドキュメント 1分間に削除された文書の数。
挿入されたドキュメント 1分間に挿入される文書の数。
資料更新 1分間に更新される文書の数。
返却された書類 1分間に返される文書の数。
読み取りスループット 1秒間にディスクから読み込まれる平均バイト数。
書き込みスループット 1秒間にディスクに書き込まれる平均バイト数。