SAP HANA

SAP HANA の統合により、SAP HANA の指標とログが収集されます。指標は、関連するモニタリングビューに対してクエリを実行することで収集されます。この統合により、構造化トレースログが書き込まれます。

HANA の詳細については、SAP HANA のドキュメントをご覧ください。

前提条件

HANA テレメトリーを収集するには、Ops エージェントをインストールする必要があります。

指標の場合は、バージョン 2.18.1 以降をインストールします。
ログの場合は、バージョン 2.18.1 以降をインストールします。

この統合は HANA バージョン 2.0 をサポートしています。

HANA インスタンスを構成する

指標を収集するには、モニタリングユーザーに、関連するモニタリングビューへの SELECT アクセス権が必要です。次の SQL スクリプトは、モニタリングロールを作成し、SAP HANA インスタンスに接続された十分な権限のあるユーザーが実行した場合、そのロールをモニタリングユーザーに適用します。

--Create the user
CREATE RESTRICTED USER otel_monitoring_user PASSWORD ;
--Enable user login
ALTER USER otel_monitoring_user ENABLE CLIENT CONNECT;
--Create the monitoring role
CREATE ROLE OTEL_MONITORING;
--Grant permissions to the relevant views
GRANT CATALOG READ TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_BACKUP_CATALOG TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_BLOCKED_TRANSACTIONS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_CONNECTIONS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_CS_ALL_COLUMNS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_CS_TABLES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_DATABASE TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_DISKS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_HOST_RESOURCE_UTILIZATION TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_LICENSES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_RS_TABLES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_COMPONENT_MEMORY TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_MEMORY TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_REPLICATION TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_STATISTICS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_THREADS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_VOLUME_IO_TOTAL_STATISTICS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_WORKLOAD TO OTEL_MONITORING;
GRANT SELECT ON _SYS_STATISTICS.STATISTICS_CURRENT_ALERTS TO OTEL_MONITORING;
GRANT SELECT ON DUMMY TO OTEL_MONITORING;
--Add the OTEL_MONITOR role to the monitoring user
GRANT OTEL_MONITORING TO otel_monitoring_user;

HANA 用に Ops エージェントを構成する

Ops エージェントの構成のガイドに従って、HANA インスタンスからテレメトリーを収集するために必要な要素を追加し、エージェントを再起動します。

構成の例

次のコマンドは、HANA のテレメトリーを収集して取り込み、Ops エージェントを再起動するための構成を作成します。

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    saphana:
      type: saphana
      include_paths:
      - /usr/sap/*/HDB*/*/trace/*.trc
      exclude_paths:
      - /usr/sap/*/HDB*/*/trace/nameserver_history*.trc
      - /usr/sap/*/HDB*/*/trace/nameserver*loads*.trc
      - /usr/sap/*/HDB*/*/trace/nameserver*executed_statements*.trc
  service:
    pipelines:
      saphana:
        receivers:
          - saphana
metrics:
  receivers:
    saphana:
      type: saphana
      username: SYSTEM
      password: G00g3l21
      endpoint: localhost:30015
  service:
    pipelines:
      saphana:
        receivers:
          - saphana
EOF

sudo service google-cloud-ops-agent restart

ログの収集を構成する

HANA からログを取り込むには、HANA が生成するログのレシーバーを作成してから、新しいレシーバー用のパイプラインを作成する必要があります。

saphana ログのレシーバーを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`exclude_paths`	`[/usr/sap//HDB/${HOSTNAME}/trace/nameserver_history.trc, /usr/sap//HDB/${HOSTNAME}/trace/nameserverloads.trc, /usr/sap//HDB/${HOSTNAME}/trace/nameserverexecuted_statements*.trc]`	`include_paths` の照合で除外するファイルシステムパスのパターンのリスト。
`include_paths`	`[/usr/sap//HDB/${HOSTNAME}/trace/*.trc]`	各ファイルのテーリングで読み込むファイルシステムのパスのリスト。パスにはワイルドカード（`*`）を使用できます。
`record_log_file_path`	`false`	`true` に設定すると、ログレコードの取得元のファイルのパスが `agent.googleapis.com/log_file_path` ラベルの値として出力ログエントリに表示されます。ワイルドカードを使用する場合、レコードを取得したファイルのパスのみが記録されます。
`type`		値には `saphana` を指定してください。
`wildcard_refresh_interval`	`60s`	`include_paths` のワイルドカードファイルのパスの更新間隔。期間を指定します（例: `30s`、`2m`）。このプロパティは、ログファイルのローテーションがデフォルトの間隔よりも速く、ロギングのスループットが高い場合に有用です。

ログの内容

logName は、構成で指定されたレシーバ ID から取得されます。LogEntry 内の詳細なフィールドは、次のとおりです。

saphana ログの LogEntry には次のフィールドが含まれます。

フィールド	タイプ	説明
`jsonPayload.component`	文字列	SAP HANA コンポーネント
`jsonPayload.connection_id`	数値	メッセージを送信した接続の ID（メッセージが接続のスコープ内でログに記録された場合）
`jsonPayload.message`	文字列	ログメッセージ
`jsonPayload.severity_flag`	文字列	ログエントリレベル
`jsonPayload.thread_id`	数値	メッセージをログに記録しているスレッドの ID
`jsonPayload.transaction_id`	数値	メッセージを送信したトランザクションの ID（メッセージがトランザクションのスコープ内でログに記録された場合）
`jsonPayload.update_transaction_id`	数値	メッセージを送信した更新トランザクションの ID（メッセージが更新トランザクションのスコープ内でログに記録された場合）
`severity`	文字列（`LogSeverity`）	ログエントリレベル（変換済み）。
`sourceLocation.file`	文字列	ソースファイル名
`sourceLocation.line`	数値	ソースファイル内の行

指標の収集を構成する

HANA から指標を取り込むには、HANA が生成する指標のレシーバーを作成してから、新しいレシーバー用のパイプラインを作成する必要があります。

このレシーバーでは、複数のエンドポイントのモニタリングなど、構成で複数のインスタンスを使用することはできません。このようなインスタンスはすべて同じ時系列に書き込まれるため、Cloud Monitoring ではインスタンスを区別できません。

saphana 指標のレシーバーを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`ca_file`		CA 証明書のパス。クライアントとして、これによりサーバー証明書が検証されます。空の場合、レシーバはシステムルート CA を使用します。
`cert_file`		mTLS で必要な接続に使用する TLS 証明書のパス。
`collection_interval`	`60s`	期間の値（例: `30s`、`5m`）。
`endpoint`	`localhost:30015`	SAP HANA インスタンスへの接続に使用される `hostname:port`。
`insecure`	`true`	セキュア TLS 接続を使用するかどうかを設定します。`false` に設定すると、TLS が有効になります。
`insecure_skip_verify`	`false`	証明書の検証をスキップするかどうかを指定します。`insecure` が `true` に設定されている場合、`insecure_skip_verify` 値は使用されません。
`key_file`		mTLS で必要な接続に使用する TLS キーのパス。
`password`		インスタンスへの接続に使用するパスワード。
`type`		値は、`saphana` にする必要があります。
`username`		インスタンスへの接続に使用するユーザー名。

モニタリング対象

次の表に、Ops エージェントが HANA インスタンスから収集する指標の一覧を示します。

指標タイプ
種類、タイプモニタリング対象リソース	ラベル
`workload.googleapis.com/saphana.alert.count`
`GAUGE`、`INT64` gce_instance	`rating`
`workload.googleapis.com/saphana.backup.latest`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/saphana.column.memory.used`
`GAUGE`、`INT64` gce_instance	`host` `subtype` `type`
`workload.googleapis.com/saphana.component.memory.used`
`GAUGE`、`INT64` gce_instance	`component` `host`
`workload.googleapis.com/saphana.connection.count`
`GAUGE`、`INT64` gce_instance	`host` `status`
`workload.googleapis.com/saphana.cpu.used`
`CUMULATIVE`、`INT64` gce_instance	`host` `type`
`workload.googleapis.com/saphana.disk.size.current`
`GAUGE`、`INT64` gce_instance	`host` `path` `state` `usage_type`
`workload.googleapis.com/saphana.host.memory.current`
`GAUGE`、`INT64` gce_instance	`host` `state`
`workload.googleapis.com/saphana.host.swap.current`
`GAUGE`、`INT64` gce_instance	`host` `state`
`workload.googleapis.com/saphana.instance.code_size`
`GAUGE`、`INT64` gce_instance	`host`
`workload.googleapis.com/saphana.instance.memory.current`
`GAUGE`、`INT64` gce_instance	`host` `state`
`workload.googleapis.com/saphana.instance.memory.shared.allocated`
`GAUGE`、`INT64` gce_instance	`host`
`workload.googleapis.com/saphana.instance.memory.used.peak`
`GAUGE`、`INT64` gce_instance	`host`
`workload.googleapis.com/saphana.license.expiration.time`
`GAUGE`、`INT64` gce_instance	`product` `system`
`workload.googleapis.com/saphana.license.limit`
`GAUGE`、`INT64` gce_instance	`product` `system`
`workload.googleapis.com/saphana.license.peak`
`GAUGE`、`INT64` gce_instance	`product` `system`
`workload.googleapis.com/saphana.network.request.average_time`
`GAUGE`、`DOUBLE` gce_instance	`host`
`workload.googleapis.com/saphana.network.request.count`
`GAUGE`、`INT64` gce_instance	`host` `state`
`workload.googleapis.com/saphana.network.request.finished.count`
`CUMULATIVE`、`INT64` gce_instance	`host` `type`
`workload.googleapis.com/saphana.replication.average_time`
`GAUGE`、`DOUBLE` gce_instance	`mode` `port` `primary` `secondary`
`workload.googleapis.com/saphana.replication.backlog.size`
`GAUGE`、`INT64` gce_instance	`mode` `port` `primary` `secondary`
`workload.googleapis.com/saphana.replication.backlog.time`
`GAUGE`、`INT64` gce_instance	`mode` `port` `primary` `secondary`
`workload.googleapis.com/saphana.row_store.memory.used`
`GAUGE`、`INT64` gce_instance	`host` `type`
`workload.googleapis.com/saphana.schema.memory.used.current`
`GAUGE`、`INT64` gce_instance	`host` `schema` `type`
`workload.googleapis.com/saphana.schema.memory.used.max`
`GAUGE`、`INT64` gce_instance	`host` `schema`
`workload.googleapis.com/saphana.schema.operation.count`
`CUMULATIVE`、`INT64` gce_instance	`host` `schema` `type`
`workload.googleapis.com/saphana.schema.record.compressed.count`
`GAUGE`、`INT64` gce_instance	`host` `schema`
`workload.googleapis.com/saphana.schema.record.count`
`GAUGE`、`INT64` gce_instance	`host` `schema` `type`
`workload.googleapis.com/saphana.service.code_size`
`GAUGE`、`INT64` gce_instance	`host` `service`
`workload.googleapis.com/saphana.service.count`
`GAUGE`、`INT64` gce_instance	`host` `status`
`workload.googleapis.com/saphana.service.memory.compactors.allocated`
`GAUGE`、`INT64` gce_instance	`host` `service`
`workload.googleapis.com/saphana.service.memory.compactors.freeable`
`GAUGE`、`INT64` gce_instance	`host` `service`
`workload.googleapis.com/saphana.service.memory.effective_limit`
`GAUGE`、`INT64` gce_instance	`host` `service`
`workload.googleapis.com/saphana.service.memory.heap.current`
`GAUGE`、`INT64` gce_instance	`host` `service` `state`
`workload.googleapis.com/saphana.service.memory.limit`
`GAUGE`、`INT64` gce_instance	`host` `service`
`workload.googleapis.com/saphana.service.memory.shared.current`
`GAUGE`、`INT64` gce_instance	`host` `service` `state`
`workload.googleapis.com/saphana.service.memory.used`
`GAUGE`、`INT64` gce_instance	`host` `service` `type`
`workload.googleapis.com/saphana.service.stack_size`
`GAUGE`、`INT64` gce_instance	`host` `service`
`workload.googleapis.com/saphana.service.thread.count`
`GAUGE`、`INT64` gce_instance	`host` `status`
`workload.googleapis.com/saphana.transaction.blocked`
`GAUGE`、`INT64` gce_instance	`host`
`workload.googleapis.com/saphana.transaction.count`
`CUMULATIVE`、`INT64` gce_instance	`host` `type`
`workload.googleapis.com/saphana.volume.operation.count`
`CUMULATIVE`、`INT64` gce_instance	`host` `path` `type` `usage_type`
`workload.googleapis.com/saphana.volume.operation.size`
`CUMULATIVE`、`INT64` gce_instance	`host` `path` `type` `usage_type`
`workload.googleapis.com/saphana.volume.operation.time`
`CUMULATIVE`、`INT64` gce_instance	`host` `path` `type` `usage_type`

構成を確認する

このセクションでは、HANA レシーバが正しく構成されていることを確認する方法について説明します。Ops エージェントがテレメトリーの収集を開始するまでに 1～2 分かかる場合があります。

HANA ログが Cloud Logging に送信されていることを確認するには、次のようにします。

Google Cloud コンソールで、[ログエクスプローラ] ページに移動します。
[ログエクスプローラ] に移動

検索バーを使用してこのページを検索する場合は、小見出しが「Logging」の結果を選択します。
エディタに次のクエリを入力し、[クエリを実行] をクリックします。
```
resource.type="gce_instance"
log_id("saphana")
```

HANA 指標が Cloud Monitoring に送信されていることを確認するには、次のようにします。

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

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
クエリビルダーペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
[言語] で [MQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定と同じツールバーにあります。
エディタに次のクエリを入力し、[クエリを実行] をクリックします。
```
fetch gce_instance
| metric 'workload.googleapis.com/saphana.connection.count'
| every 1m
```

ダッシュボードを表示する

HANA 指標を表示するには、グラフまたはダッシュボードが構成されている必要があります。HANA インテグレーションには、1 つ以上のダッシュボードが含まれています。インテグレーションを構成して Ops エージェントが指標データの収集を開始すると、ダッシュボードは自動的にインストールされます。

インテグレーションをインストールすることなく、ダッシュボードの静的プレビューを表示することもできます。

インストールされているダッシュボードを表示する手順は次のとおりです。

Google Cloud コンソールで [ダッシュボード] ページに移動します。
[ダッシュボード] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
[ダッシュボードリスト] タブを選択し、[統合] カテゴリを選択します。
表示するダッシュボードの名前をクリックします。

インテグレーションを構成してもダッシュボードがインストールされていない場合は、Ops エージェントが実行されていることを確認します。ダッシュボードにグラフの指標データがない場合、ダッシュボードのインストールは失敗します。Ops エージェントが指標の収集を開始した後に、ダッシュボードがインストールされます。

ダッシュボードの静的プレビューを表示する手順は次のとおりです。

Google Cloud コンソールで [統合] ページに移動します。
[インテグレーション] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
[デプロイメントプラットフォーム] フィルタの [Compute Engine] をクリックします。
HANA のエントリを見つけて [詳細を表示] をクリックします。
[ダッシュボード] タブを選択すると、静的プレビューが表示されます。ダッシュボードがインストールされている場合は、[ダッシュボードを表示] をクリックして移動できます。

Cloud Monitoring のダッシュボードについて詳しくは、ダッシュボードとグラフをご覧ください。

[インテグレーション] ページの使用方法については、インテグレーションを管理するをご覧ください。

アラートポリシーをインストールする

アラートポリシーは、指定した条件が成立した際に通知するように Cloud Monitoring に指示します。HANA インテグレーションには、使用する 1 つ以上のアラートポリシーが含まれています。これらのアラートポリシーは、Monitoring の [インテグレーション] ページで表示してインストールできます。

使用可能なアラートポリシーの説明を表示してインストールする手順は次のとおりです。

Google Cloud コンソールで [統合] ページに移動します。
[インテグレーション] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。
HANA のエントリを見つけて [詳細を表示] をクリックします。
[アラート] タブを選択します。このタブには、利用可能なアラートポリシーの説明と、それらをインストールするためのインターフェースが表示されます。
アラートポリシーをインストールします。アラートポリシーでは、アラートがトリガーされた通知の送信先を特定する必要があるため、インストール環境の情報が必要になります。アラートポリシーをインストールする手順は次のとおりです。
1. 利用可能なアラートポリシーのリストから、インストールするアラートポリシーを選択します。
2. [通知の構成] セクションで、1 つ以上の通知チャンネルを選択します。通知チャンネルの使用を無効にすることもできますが、無効にすると、アラートポリシーは通知なく起動します。Monitoring でステータスを確認できますが、通知は受信しません。
  
  通知チャンネルの詳細については、通知チャンネルを管理するをご覧ください。
3. [ポリシーの作成] をクリックします。

Cloud Monitoring のアラートポリシーの詳細については、アラートの概要をご覧ください。