Monitor Docker EE 2.x および UCP 3.x の監視

apmsaas
HID_ee2xucp3x
Docker UCP (Universal Control Plane) 3.x および Docker Enterprise 2.x は、Kubernetes および Swarm ワークロードのマルチ アーキテクチャ オーケストレーションを提供します。デフォルトの Docker Enterprise インストールには、クラスタ全体にわたる Kubernetes および Swarm コンポーネントの両方が含まれています。
新しく結合されるすべてのワーカ ノードは、Kubernetes、Swarm、または両方のワークロード(混在モード)をスケジュールする準備ができています。Docker Monitor を使用すると、Swarm ノード上で実行されているコンテナを監視できます。Kubernetes Monitor を使用すると、Kubernetes ノード上で実行されているポッドを監視できます。
Swarm ノード上のコンテナの監視
Swarm ノードにインストールされているコンテナのパフォーマンスおよび稼働状況を監視するには、Docker Monitor をインストールします。
以下の手順に従います。
  1. DX SaaS
    で、
    [エージェント]
    を選択し、
    [エージェントのダウンロード]
    を選択します。
  2. [Docker Monitor EE2.x UCP 3.x Monitor]
    を選択します。
  3. エージェントを選択した後に表示されるインストール手順に従います。
  4. (オプション) YML ファイルで指定されている環境変数に加えて、インフラストラクチャ エージェント プロファイル内のプロパティを使用して環境を設定します。インフラストラクチャ エージェントのプロパティの詳細については、「インフラストラクチャ エージェント プロパティ リファレンス」を参照してください。
    インフラストラクチャ エージェント プロパティを環境変数として
    install.yml
    ファイルに渡すには、
    environment
    セクションの最後に変数を追加します。YML 形式では、プロパティ名に区切り文字「.」は使用できません。プロパティ名のドットをアンダースコアに置き換える必要があります。たとえば、エージェント名およびプロキシ サーバを設定するには、
    introscope.agent.agentName
    および
    introscope.agent.enterprisemanager.transport.http.proxy.host
    プロパティを以下のように使用します。
    environment: - agentManager_url_1=[AGENT_MANAGER_URL] - containerflow=enabled - interval=90 - type=Docker - introscope_agent_agentName=example_agent_name - introscope_agent_enterprisemanager_transport_http_proxy_host=example_proxy_server.com
  5. (オプション)ホスト モニタをインストールすると、コンポーネント ビュー内のホスト関連情報には
    StorageName
    メトリックが含まれます。UNIX または Linux システムでは、ストレージ フィルタを設定して、このメトリックに関連付けられているように表示されるマウント ポイントを設定できます。ストレージ フィルタを設定するには、以下の環境変数を使用します。
    • storage_mount_filter
      StorageName
      メトリックの考慮対象から削除するマウント ポイントを指定するための変数。1 行に 1 つのマウント ポイント、または 1 行に複数のマウント ポイントをカンマで区切って指定できます。
    • storage_outofbox_filter_enabled
      有効にされている場合、以下のマウントを除外する標準装備のフィルタ。
      • devicemapper/mnt
      • docker/containers
      • docker/devicemapper
      • docker/
      • kubelet/pods
      • openshift.local.volumes
      このフィルタはデフォルトで有効です。無効にするには、その値を
      no
      に設定します。
    例:
    /host/home
    マウント ポイントは非表示にできますが、
    storage_outofbox_filter_enabled
    フィルタでリストされているすべてのマウント ポイントを含めることができます。これを行うには、YML ファイルの環境変数セクションに環境変数を追加します。
    environment: - agentManager_url_1=[AGENT_MANAGER_URL] - containerflow=enabled - interval=90 - type=Docker - storage_mount_filter=/host/home - storage_outofbox_filter_enabled=no
  6. (オプション)以下の環境変数を使用して、インフラストラクチャ エージェントが実行される JVM の
    xms
    および
    xmx
    パラメータを設定できます。
      • MIN_HEAP_VAL_IN_MB
        デフォルト:
        256
      • MAX_HEAP_VAL_IN_MB
        デフォルト:
        512
    例:
    YML ファイルを使用して Java ヒープの値を更新します。
    environment: - agentManager_url_1=[AGENT_MANAGER_URL] - containerflow=enabled - interval=90 - type=Docker - MIN_HEAP_VAL_IN_MB=335 - MAX_HEAP_VAL_IN_MB=670
Docker モニタリングのエージェント プロパティの使用
特定のエージェント プロパティには、エージェントの設定に使用できるエイリアスがあります。以下の表の同じ行に記載されているプロパティの機能は同じです。同じ行にあるプロパティは入れ替えて使用できます。これらのプロパティは、インストール中に環境変数として渡すことができます。
エイリアス プロパティ
プロパティの説明
デフォルト値
docker.interval.seconds
間隔
com.ca.apm.docker.monitor.polling.interval
データ収集のレポート間隔を設定します。
120 秒
type
monitoring.type
com.ca.apm.docker.monitor.type
モニタリング タイプを示します。
DockerMonitor
containerflow
com.ca.apm.docker.monitor.containerflow
Containerflow モジュールが有効か無効かどうかを示します。
enabled
docker.skip.stopped.container
com.ca.apm.docker.monitor.skip.stopped.container
停止しているコンテナのモニタリングをスキップします。
false
com.ca.apm.docker.swarm.task.max.default.instance
メトリック ツリーに表示される Swarm Tasks または Docker Project Service インスタンスの最大数を設定します。設定された最大値を超えるインスタンスは、メトリック ツリーの[TaskDefault]ノードの下に表示されます。
デフォルト: 5
Kubernetes ノード上のコンテナの監視
Kubernetes にインストールされているポッドのパフォーマンスおよび稼働状況を監視するには、Kubernetes Monitor をインストールします。
以下の手順に従います。
  1. DX SaaS
    で、
    [エージェント]
    を選択し、
    [エージェントのダウンロード]
    を選択します。
  2. [Docker Monitor EE2.x
    UCP 3.x Monitor]
    を選択します。
  3. エージェントを選択した後に表示されるインストール手順に従います。
  4. UCP Web サイトからクライアント バンドルをダウンロードし、バンドルを抽出したことを確認します。
  5. 設定コマンドで指定するノード上に
    kube.yml
    ファイルの完全パスをコピーします。
  6. UCP クライアント バンドルのフル パスを
    path
    プロパティとして
    install.yml
    ファイルに追加して、ファイルを保存します。
    このパスは、ノード セレクタ上の
    kube.yml
    ファイルを指している必要があります。
  7. (オプション) YML ファイルで指定されている環境変数に加えて、インフラストラクチャ エージェント プロファイル内のプロパティを使用して環境を設定します。インフラストラクチャ エージェントのプロパティの詳細については、「インフラストラクチャ エージェント プロパティ リファレンス」を参照してください。
    インフラストラクチャ エージェント プロパティを環境変数として
    install.yml
    ファイルに渡すには、
    environment
    セクションの最後に変数を追加します。YML 形式では、プロパティ名に区切り文字「.」は使用できません。プロパティ名のドットをアンダースコアに置き換える必要があります。
    たとえば、エージェント名およびプロキシ サーバを設定するには、
    introscope.agent.agentName
    および
    introscope.agent.enterprisemanager.transport.http.proxy.host
    プロパティを以下のように使用します。
    env: - name: containerflow value: enabled - name: agentManager_url_1 value: [AGENT_MANAGER_URL] - name: agentManager_credential value: [AGENTMANAGER_CREDENTIAL] - name: type value: Kubernetes - name: interval value: "30" - name: KUEBRNETES_NODE_MONITORING value: "true" - name: introscope_agent_agentName value: KubernetesNodeMonitor
  8. (オプション)ホスト モニタをインストールすると、コンポーネント ビュー内のホスト関連情報には
    StorageName
    メトリックが含まれます。UNIX または Linux システムでは、ストレージ フィルタを設定して、このメトリックに関連付けられているように表示されるマウント ポイントを設定できます。ストレージ フィルタを設定するには、以下の環境変数を使用します。
    • storage_mount_filter
      StorageName
      メトリックの考慮対象から削除するマウント ポイントを指定するための変数。1 行に 1 つのマウント ポイント、または 1 行に複数のマウント ポイントをカンマで区切って指定できます。
    • storage_outofbox_filter_enabled
      有効にされている場合、以下のマウントを除外する標準装備のフィルタ。
      • devicemapper/mnt
      • docker/containers
      • docker/devicemapper
      • docker/
      • kubelet/pods
      • openshift.local.volumes
      このフィルタはデフォルトで有効です。無効にするには、その値を
      no
      に設定します。
    例:
    /host/home
    マウント ポイントは非表示にしますが、
    storage_outofbox_filter_enabled
    フィルタでリストされているすべてのマウント ポイントを含めて、標準装備のフィルタを無効化します。
    このタスクを行うには、以下のように YML ファイルの最初の環境変数セクションに環境変数を追加します。
    env: - name: containerflow value: enabled - name: agentManager_url_1 value: [AGENTMANAGER_URL] - name: type value: Kubernetes - name: interval value: "120" - name: storage_mount_filter value: "/host/home" - name: storage_outofbox_filter_enabled value: "no"
  9. (オプション)以下の環境変数を使用して、インフラストラクチャ エージェントが実行される JVM の
    xms
    および
    xmx
    パラメータを設定できます。
      • MIN_HEAP_VAL_IN_MB デフォルト:
        256
      • MAX_HEAP_VAL_IN_MB デフォルト:
        512
    例:
    YML ファイルを使用して Java ヒープの値を更新できます。
    env: - name: containerflow value: enabled - name: agentManager_url_1 value: [AGENTMANAGER_URL] - name: type value: Kubernetes - name: HostMonitoring value: disabled - name: interval value: "120" - name: MIN_HEAP_VAL_IN_MB value: "335" - name: MAX_HEAP_VAL_IN_MB value: "670"
Kubernetes モニタリングのエージェント プロパティの使用
特定のエージェント プロパティには、エージェントの設定に使用できるエイリアスがあります。以下の表の同じ行に記載されているプロパティの機能は同じです。同じ行にあるプロパティは入れ替えて使用できます。これらのプロパティは、インストール中に環境変数として渡すことができます。
エイリアス プロパティ
説明
デフォルト値
docker.interval.seconds
間隔
com.ca.apm.kubernetes.monitor.polling.interval
データ収集のレポート間隔を設定します。
120 seconds
type
monitoring.type
com.ca.apm.docker.monitor.type
モニタリング タイプを設定します。
DockerMonitor
containerflow
com.ca.apm.docker.monitor.containerflow
Containerflow モジュールが有効か無効かどうかを示します。
enabled
connectionurl
KUBERNETES_CONNECTION_URL
com.ca.apm.kubernetes.monitor.connection.url
Kubernetes クライアントの接続 URL を示します。
空の文字列値
apitoken
com.ca.apm.kubernetes.monitor.api.token
Kubernetes クラスタに接続するために必要な API トークンを示します。
空の文字列値
k8s_username
com.ca.apm.kubernetes.monitor.username
クラスタ アクセス用の Kubernetes ユーザ名を示します。
空の文字列値
SHOW_METRICS_LEVEL
com.ca.apm.show.metrics.level
Kubernetes モニタリング用のメトリック レベルを示します。
設定可能な値:
full
または
minimum
minimum
DEFAULT_MAX_POD_INSTANCE
メトリック ツリーに表示されるインスタンスの最大数を設定します。設定された最大値を超えるインスタンスは、メトリック ツリーの[InstanceDefault]ノードの下に表示されます。
デフォルト:
5
  • SHOW_METRICS_LEVEL が
    full
    に設定されている場合、または
    ReadyState
    1
    に設定されている場合、以下のメトリックが表示されます:
    ClusterMonitor
    Container State
    Containers Per Pod
    、および
    Total Containers Ready
  • SHOW_METRICS_LEVEL が full に設定されている場合、または
    Deployment Health
    1
    に設定されている場合、以下のメトリックが表示されます:
    ReadyState
    Available Replicas
    Desired Replicas
    、および
    UptoDate Replicas
    これらのメトリックの詳細については、「Kubernetes モニタリング メトリック」を参照してください。
混在ノード上のコンテナの監視
混在モードでノードを設定する場合は、Docker モニタリングおよび Kubernetes の両方をインストールします。Swarm 設定で実行されているコンテナのパフォーマンスを測定するには、Docker Monitor をインストールします。
Kubernetes で実行されているポッドのパフォーマンスを測定するには、Kubernetes Monitor をインストールします。ホスト モニタリング ソリューションの重複インストールを回避するには、Docker モニタで追加の環境変数を渡します。環境変数の追加により、Docker Monitor インストールの一部としてホスト モニタをインストールすることがなくなります。
以下の手順に従います。
  1. DX SaaS
    で、
    [エージェント]
    を選択し、
    [エージェントのダウンロード]
    を選択します。
  2. [Docker Monitor EE2.x UCP 3.x Monitor]
    を選択します。
  3. エージェントを選択した後に表示されるインストール手順に従います。
  4. Docker Monitor
    の YML ファイルの
    env
    という見出しの下に、以下の変数を追加します。
    - HostMonitoring=disabled
    この変数により、インストールの重複がなくなります。