Process Monitoring 指標の収集を構成する

このガイドでは、SAP システムから Process Monitoring 指標を収集するように、Google Cloud の SAP 用エージェントを構成する方法について説明します。

この機能の詳細については、Google Cloud の SAP 用エージェントを使用した Process Monitoring をご覧ください。

始める前に

IAM のロールを設定する

Google Cloud の SAP 用エージェントが Process Monitoring 指標を収集できるようにするには、Compute Engine インスタンスまたは Bare Metal Solution サーバーが使用するサービス アカウントに次のロールが含まれている必要があります。

これらの必要なロールをサービス アカウントに追加する手順は次のとおりです。

  1. Google Cloud コンソールの [IAM] ページに移動します。

    [IAM] に移動

  2. Google Cloud プロジェクトを選択します。

  3. ロールを追加するサービス アカウントを特定します。

    • サービス アカウントがまだプリンシパル リストに含まれていない場合、サービス アカウントには何もロールが割り当てられていません。[追加] をクリックし、サービス アカウントのメールアドレスを入力します。
    • このサービス アカウントがすでにプリンシパル リストに含まれている場合、サービス アカウントには既存のロールがあります。編集するサービス アカウントの [編集] ボタンをクリックします。
  4. 使用可能なロールのリストから必要なロールを選択します。

    • Compute 閲覧者(
    • [Monitoring] > [モニタリング指標の書き込み]
    • [Secret Manager] > [Secret Manager のシークレット アクセサー]
  5. [追加] または [保存] をクリックして、サービス アカウントにロールを適用します。

きめ細かいアクセスレベルの場合は、次の IAM 権限を独自のカスタムロールに設定できます。

  • 指標の収集:
    • monitoring.timeSeries.create
    • compute.instances.get
    • compute.nodeGroups.list
    • compute.nodeGroups.get
  • Secrets Manager:
    • secretmanager.versions.access

カスタムロールの作成方法の詳細については、カスタムロールを作成、管理するをご覧ください。

Process Monitoring 指標の収集を有効にする

Google Cloud の SAP 用エージェントを使用した Process Monitoring 指標の収集を有効にする手順は次のとおりです。

  1. ホスト Compute Engine インスタンスと SSH 接続を確立します。

  2. エージェントの構成ファイルを開きます。

    /etc/google-cloud-sap-agent/configuration.json

    別の方法として、コマンドを実行してこの構成を行うこともできます。詳細については、Google Cloud の SAP 用エージェントの構成コマンドをご覧ください。

  3. collection_configuration セクションで、次の操作を行います。

    • collect_process_metrics パラメータに、値 true を指定します。
    • SAP HANA データベース インスタンスに関連する Process Monitoring 指標の収集を有効にするには、hana_metrics_config セクションで追加のパラメータを構成する必要があります。これらのパラメータの詳細については、構成パラメータをご覧ください。
  4. 必要に応じて、cloud_properties セクションの自動的に設定されたパラメータ値を更新します。これを行うには、構成ファイルに cloud_properties セクションを追加した後、必要なパラメータとその値を指定します。

  5. 構成ファイルを保存します。

  6. エージェントを再起動して、新しい設定を有効にします。

    sudo systemctl restart google-cloud-sap-agent

構成ファイルの例

Compute Engine インスタンス

次の例は、Compute Engine インスタンスで実行されている Google Cloud の SAP 用エージェントの完全な構成ファイルです。ここでは、Process Monitoring 指標の収集が有効になっています。

SAP HANA 認証の場合、エージェントは次の優先順位を使用します。指定されている場合、hdbuserstore_key 構成パラメータは hana_db_password パラメータよりも優先され、hana_db_password パラメータは hana_db_password_secret_name パラメータよりも優先されます。構成ファイルで設定する認証オプションは 1 つだけにすることをおすすめします。

  • 次の例では、SAP HANA 認証にセキュア ユーザーストア(hdbuserstoreキーを使用します。
    {
      "provide_sap_host_agent_metrics": true,
      "bare_metal": false,
      "log_level": "INFO",
      "log_to_cloud": true,
      "collection_configuration": {
        "collect_workload_validation_metrics": true,
        "collect_process_metrics": true,
        "process_metrics_frequency": 5,
        "slow_process_metrics_frequency": 30,
        "hana_metrics_config": {
          "hana_db_user": "db_user_name",
          "sid": "DEH",
          "hdbuserstore_key": "user_store_key"
        }
      },
      "cloud_properties": {
        "project_id": "my-project",
        "instance_name": "instance-1",
        "image": "rhel-8"
      },
      "discovery_configuration": {
        "enable_discovery": true,
        "enable_workload_discovery": true
      },
      "hana_monitoring_configuration": {
        "enabled": false
      }
    }
  • 次の例では、SAP HANA 認証にユーザー名と Secret Manager シークレットを使用します。
    {
      "provide_sap_host_agent_metrics": true,
      "bare_metal": false,
      "log_level": "INFO",
      "log_to_cloud": true,
      "collection_configuration": {
        "collect_workload_validation_metrics": true,
        "collect_process_metrics": true,
        "process_metrics_frequency": 5,
        "slow_process_metrics_frequency": 30,
        "hana_metrics_config": {
          "hana_db_user": "db_user_name",
          "sid": "DEH",
          "hana_db_password_secret_name": "db_pwd_secret_name"
        }
      },
      "cloud_properties": {
        "project_id": "my-project",
        "instance_name": "instance-1",
        "image": "rhel-8"
      },
      "discovery_configuration": {
        "enable_discovery": true,
        "enable_workload_discovery": true
      },
      "hana_monitoring_configuration": {
        "enabled": false
      }
    }
  • 次の例では、SAP HANA 認証にユーザー名とパスワードを使用します。代わりに、SAP HANA 認証に Secret Manager シークレットまたはセキュア ユーザーストア(hdbuserstoreキーを使用することをおすすめします。
    {
      "provide_sap_host_agent_metrics": true,
      "bare_metal": false,
      "log_level": "INFO",
      "log_to_cloud": true,
      "collection_configuration": {
        "collect_workload_validation_metrics": true,
        "collect_process_metrics": true,
        "process_metrics_frequency": 5,
        "slow_process_metrics_frequency": 30,
        "hana_metrics_config": {
          "hana_db_user": "db_user_name",
          "sid": "DEH",
          "hana_db_password": "TempPa55word"
        }
      },
      "cloud_properties": {
        "project_id": "my-project",
        "instance_name": "instance-1",
        "image": "rhel-8"
      },
      "discovery_configuration": {
        "enable_discovery": true,
        "enable_workload_discovery": true
      },
      "hana_monitoring_configuration": {
        "enabled": false
      }
    }

Bare Metal Solution サーバー

次の例は、Bare Metal Solution サーバーで実行されている Google Cloud の SAP 用エージェントの完全な構成ファイルです。ここでは、Process Monitoring 指標の収集が有効になっています。

SAP HANA 認証の場合、エージェントは次の優先順位を使用します。指定されている場合、hdbuserstore_key 構成パラメータは hana_db_password パラメータよりも優先され、hana_db_password パラメータは hana_db_password_secret_name パラメータよりも優先されます。構成ファイルで設定する認証オプションは 1 つだけにすることをおすすめします。

  • 次の例では、SAP HANA 認証にセキュア ユーザーストア(hdbuserstoreキーを使用します。
    {
      "provide_sap_host_agent_metrics": true,
      "bare_metal": true,
      "log_level": "INFO",
      "log_to_cloud": true,
      "collection_configuration": {
        "collect_workload_validation_metrics": true,
        "collect_process_metrics": true,
        "process_metrics_frequency": 5,
        "slow_process_metrics_frequency": 30,
        "hana_metrics_config": {
          "hana_db_user": "db_user_name",
          "sid": "DEH",
          "hdbuserstore_key": "user_store_key"
        }
      },
      "cloud_properties": {
        "project_id": "my-project",
        "instance_name": "bms-machine-1"
    "region": "us-central1", "image": "rhel-8" }, "discovery_configuration": { "enable_discovery": true, "enable_workload_discovery": true }, "hana_monitoring_configuration": { "enabled": false } }
  • 次の例では、SAP HANA 認証にユーザー名と Secret Manager シークレットを使用します。
    {
      "provide_sap_host_agent_metrics": true,
      "bare_metal": true,
      "log_level": "INFO",
      "log_to_cloud": true,
      "collection_configuration": {
        "collect_workload_validation_metrics": true,
        "collect_process_metrics": true,
        "process_metrics_frequency": 5,
        "slow_process_metrics_frequency": 30,
        "hana_metrics_config": {
          "hana_db_user": "db_user_name",
          "sid": "DEH",
          "hana_db_password_secret_name": "db_pwd_secret_name"
        }
      },
      "cloud_properties": {
        "project_id": "my-project",
        "instance_name": "bms-machine-1"
    "region": "us-central1", "image": "rhel-8" }, "discovery_configuration": { "enable_discovery": true, "enable_workload_discovery": true }, "hana_monitoring_configuration": { "enabled": false } }
  • 次の例では、SAP HANA 認証にユーザー名とパスワードを使用します。代わりに、SAP HANA 認証に Secret Manager シークレットまたはセキュア ユーザーストア(hdbuserstoreキーを使用することをおすすめします。
    {
      "provide_sap_host_agent_metrics": true,
      "bare_metal": true,
      "log_level": "INFO",
      "log_to_cloud": true,
      "collection_configuration": {
        "collect_workload_validation_metrics": true,
        "collect_process_metrics": true,
        "process_metrics_frequency": 5,
        "slow_process_metrics_frequency": 30,
        "hana_metrics_config": {
          "hana_db_user": "db_user_name",
          "sid": "DEH",
          "hana_db_password": "TempPa55word"
        }
      },
      "cloud_properties": {
        "project_id": "my-project",
        "instance_name": "bms-machine-1"
    "region": "us-central1", "image": "rhel-8" }, "discovery_configuration": { "enable_discovery": true, "enable_workload_discovery": true }, "hana_monitoring_configuration": { "enabled": false } }

構成パラメータ

次の表は、Process Monitoring 指標の収集に固有の Google Cloud の SAP 用エージェントの構成パラメータを示しています。

パラメータ
provide_sap_host_agent_metrics

Boolean

SAP Host Agent に必要な指標の収集を有効にするには、true を指定します。デフォルトは true です。
Cloud カスタマーケアまたは SAP サポートから求められない限り、provide_sap_host_agent_metricsfalse に設定しないでください。

bare_metal

Boolean

エージェントが Bare Metal Solution サーバーにインストールされている場合は、true を指定します。デフォルトは false です。

log_level

String

エージェントのロギングレベルを設定するには、必要な値を設定します。使用可能なログレベルは次のとおりです。

  • DEBUG
  • INFO
  • WARNING
  • ERROR

デフォルトは INFO です。Cloud カスタマーケアから求められない限り、ロギングレベルを変更しないでください。

log_to_cloud

Boolean

エージェントのログを Cloud Logging にリダイレクトするには、true を指定します。デフォルトは true です。

cloud_properties.project_id

String

SAP システムが Bare Metal Solution サーバーで実行されている場合は、Bare Metal Solution で使用する Google Cloud プロジェクトのプロジェクト ID を指定します。

エージェントが Compute Engine インスタンスで実行されている場合、デフォルトでは、プロジェクト ID が自動的に検出されます。

cloud_properties.instance_name

String

SAP システムが Compute Engine インスタンスで実行されている場合は、そのコンピューティング インスタンスの名前を指定します。エージェントは、インストール時にコンピューティング インスタンス名を自動的に検出します。

SAP システムが Bare Metal Solution サーバーで実行されている場合は、そのサーバーの名前を指定します。

cloud_properties.region

String

SAP システムが Bare Metal Solution サーバーで実行されている場合は、Bare Metal Solution サーバーのリージョンを指定します。

エージェントがコンピューティング インスタンスで実行されている場合、デフォルトでは、エージェントはコンピューティング インスタンスがデプロイされているリージョンを使用します。

cloud_properties.zone

String

エージェントがコンピューティング インスタンスで実行されている場合、デフォルトでは、コンピューティング インスタンスがデプロイされているゾーンが使用されます。

cloud_properties.image

String

インスタンスの OS イメージ名を指定します。

エージェントがコンピューティング インスタンスで実行されている場合、デフォルトでは、コンピューティング インスタンスで使用される OS イメージが自動的に検出されます。

cloud_properties.numeric_project_id

String

SAP システムが実行されている Google Cloud プロジェクトの数値 ID を指定します。

エージェントがコンピューティング インスタンスで実行されている場合、デフォルトでは、プロジェクト番号が自動的に検出されます。

discovery_configuration.enable_workload_discovery

Boolean

エージェントがホストで実行されている SAP プロダクトの名前とバージョンを収集できるようにするには、true を指定します。デフォルト値は true です。

詳細については、GoogleCloudPlatform/sapagentgoogle-cloud-sap-agent GitHub リポジトリにあるエージェントのコードベースをご覧ください。

discovery_configuration.enable_discovery

Boolean

エージェントがホストで実行されている SAP プロダクトについて収集した情報を Cloud Logging に送信するには、true を指定します。デフォルト値は true です。

false を指定すると、エージェントは収集した情報をホストに保存し、Cloud Logging に送信しません。

collection_configuration.collect_process_metrics

Boolean

Process Monitoring 指標の収集を有効にするには、true を指定します。デフォルトは false です。
このパラメータは Linux にのみ適用されます。

SAP HANA のプロセス指標の収集を有効にする場合は、hana_metrics_config の下にリストされている追加のパラメータを設定する必要があります。

collection_configuration.process_metrics_frequency

Int

バージョン 2.6 以降では、このパラメータによって急速に変化する Process Monitoring 指標の収集頻度(秒単位)が決定されます。急速に変化する Process Monitoring 指標は、sap/hana/availabilitysap/hana/ha/availabilitysap/nw/availability です。

このパラメータのデフォルト値は 5 秒です。このデフォルト値を使用することをおすすめします。

変化が緩やかな他の Process Monitoring 指標はすべて、デフォルトの 30 秒の頻度で収集されます。変化が緩やかな Process Monitoring 指標の収集頻度を変更するには、slow_process_metrics_frequency パラメータを使用します。

collection_configuration.slow_process_metrics_frequency

Int

変化が緩やかな Process Monitoring 指標の収集頻度を秒単位で指定します。

このパラメータのデフォルト値は 30 秒です。

collection_configuration.process_metrics_to_skip

Array

エージェントで収集しない Process Monitoring 指標を指定します。このパラメータには、Process Monitoring 指標名のカンマ区切り値を指定できます。例: "process_metrics_to_skip": ["/sap/nw/abap/sessions", "/sap/nw/abap/rfc"]

collection_configuration.hana_metrics_config.hana_db_user

String

エージェントが SAP HANA のクエリに使用するデータベース ユーザー アカウントを指定します。デフォルトは SYSTEM です。

collection_configuration.hana_metrics_config.hana_db_password

String

エージェントが SAP HANA のクエリに使用するデータベース ユーザー アカウントのパスワード(書式なしテキスト)を指定します。

書式なしテキスト パスワードを指定する代わりに、次のいずれかのオプションを使用することをおすすめします。

  • hana_db_password_secret_nameSecret Manager に保存されているシークレットを指定します。
  • hdbuserstore_keyhdbuserstore キーを指定します。

SAP HANA 認証の場合、エージェントは次の優先順位を使用します。指定されている場合、hdbuserstore_key 構成パラメータは hana_db_password パラメータよりも優先され、hana_db_password パラメータは hana_db_password_secret_name パラメータよりも優先されます。構成ファイルで設定する認証オプションは 1 つだけにすることをおすすめします。

collection_configuration.hana_metrics_config.hana_db_password_secret_name

String

エージェントが SAP HANA のクエリに使用するデータベース ユーザー アカウントのパスワードを安全に指定するには、データベース ユーザー アカウントのセキュリティ認証情報を含むシークレットの名前を指定します。

hana_db_password_secret_namehdbuserstore_key、または hana_db_password のいずれかを指定した場合にのみ、エージェントが SAP HANA 関連の指標を収集します。

SAP HANA 認証の場合、エージェントは次の優先順位を使用します。指定されている場合、hdbuserstore_key 構成パラメータは hana_db_password パラメータよりも優先され、hana_db_password パラメータは hana_db_password_secret_name パラメータよりも優先されます。構成ファイルで設定する認証オプションは 1 つだけにすることをおすすめします。

collection_configuration.hana_metrics_config.hdbuserstore_key

String

SAP HANA システムに安全に接続するには、そのシステム用に作成したセキュア ユーザーストア(hdbuserstore鍵を指定します。

認証に hdbuserstore 鍵を使用するには、次の点に注意してください。

  • SAP ツール hdbsqlhdbuserstore が、エージェントをホストする Compute インスタンスにインストールされている。
  • hdbuserstore キーが、特定の 1 つの SAP HANA インスタンスに対応している。複数の SAP HANA インスタンスのホスト名を含む鍵は使用できません。
  • SIDadm ユーザーは、このキーを使用して SAP HANA データベースにクエリを実行できます。ここで、SIDsid パラメータに指定した値を参照します。これを検証するには、SIDadm ユーザーとして次のコマンドを実行します。
    hdbsql -U HDB_USERSTORE_KEY "SELECT * FROM DUMMY"

この構成パラメータは、エージェントのバージョン 3.3 以降でサポートされています。

SAP HANA 認証の場合、エージェントは次の優先順位を使用します。指定されている場合、hdbuserstore_key 構成パラメータは hana_db_password パラメータよりも優先され、hana_db_password パラメータは hana_db_password_secret_name パラメータよりも優先されます。構成ファイルで設定する認証オプションは 1 つだけにすることをおすすめします。

collection_configuration.hana_metrics_config.sid

String

SAP HANA インスタンスの SID を指定します。hdbuserstore キーを使用して SAP HANA の認証を行う場合は、hdbuserstore_key セクションをご覧ください。

収集された指標を表示する

エージェントが収集する Process Monitoring 指標を可視化するには、Google Cloud が提供する次のカスタム ダッシュボードを使用します。

  • SAP 用エージェント - HANA の概要: このダッシュボードは、SAP HANA の可用性、SAP HANA HA の可用性、SAP HANA HA レプリケーション、SAP HANA サービス ステータス、HA クラスタ - ノードの状態、HA クラスタ - SAP インスタンスのリソース状態の指標のステータスの概要を表示するグラフを提供します。

    このダッシュボードの JSON ファイルは sap-agent-status-overview.json です。

  • SAP 用エージェント - HANA の元の指標: このダッシュボードは、SAP HANA の可用性、SAP HANA HA の可用性、SAP HANA HA レプリケーション、SAP HANA サービス ステータス、HA クラスタ - ノードの状態、HA クラスタ - SAP インスタンスのリソース状態の指標の生の指標値を表示するグラフを提供します。

    このダッシュボードの JSON ファイルは sap-agent-raw-metrics.json です。

ダッシュボードをインストールする

カスタム ダッシュボードをインストールするには、次の手順を完了します。

Google Cloud コンソール

  1. Google Cloud コンソールで、[Monitoring] ページに移動します。

    [Monitoring] に移動

  2. Monitoring のナビゲーション パネルで、[ダッシュボード] をクリックします。

  3. [サンプル ライブラリ] タブをクリックします。

    [サンプル ライブラリ] タブが選択されている画面

  4. エージェント固有のカスタム ダッシュボードをフィルタするには、[フィルタ] フィールドに「Agent for SAP」と入力します。

  5. (省略可)ダッシュボードの詳細を表示するか、コンテンツをプレビューするには、[プレビュー] をクリックします。

  6. インストールするダッシュボードを選択します。

  7. [インポート]、[確認] の順にクリックします。

    ダッシュボードが Google Cloud プロジェクトで使用可能なダッシュボードに追加されます。ダッシュボードを表示するには、インストールされているダッシュボードを表示するの手順に沿って操作します。

Google Cloud CLI

  1. Cloud Shell を開きます。

    Cloud Shell を開く

  2. Cloud Shell で、リポジトリのクローンを作成するか、リポジトリをダウンロードします。

    git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples/

  3. Cloud Shell で、対応する JSON ファイルを使用して必要なダッシュボードをインストールします。

    gcloud monitoring dashboards create --config-from-file=CONFIG_FROM_FILE

    CONFIG_FROM_FILE は、ダッシュボード構成を含む JSON ファイルのパスに置き換えます。ダッシュボード構成ファイルはパス monitoring-dashboard-samples/dashboards/google-cloud-agent-for-sap にあります。

    ダッシュボードが Google Cloud プロジェクトで使用可能なダッシュボードに追加されます。ダッシュボードを表示するには、インストールされているダッシュボードを表示するの手順に沿って操作します。

インストールされているダッシュボードを表示する

インストールされているダッシュボードを表示するには、次の操作を行います。

  1. Google Cloud コンソールで、[Monitoring] ページに移動します。

    [Monitoring] に移動

  2. Monitoring のナビゲーション パネルで、[ダッシュボード] をクリックします。

  3. リスト内のダッシュボード名をクリックします。

ダッシュボードの数が多い場合は、カスタム ダッシュボードや新しいダッシュボードの名前でフィルタできます。このリストをフィルタする方法については、カスタム ダッシュボードを表示するをご覧ください。

次の図は、Monitoring の SAP HANA 指標のカスタム ダッシュボードの一部を示す例です。

Monitoring に SAP HANA 指標のカスタム ダッシュボードが表示されているスクリーン キャプチャ。