WildFly

WildFly 統合では、WildFly ログを収集して解析し、JSON ペイロードを生成します。結果には、ソース、メッセージコード、レベル、メッセージが含まれます。

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

前提条件

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

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

この統合は、WildFly バージョン 26.x と 25.x をサポートしています。

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

JMX エンドポイントをリモートで公開するには、jboss.bind.address.management システムプロパティを設定する必要があります。デフォルトでは、このプロパティは WildFly の構成に設定されています。デフォルトの WildFly インストールでは、127.0.0.1:9990 でローカルに公開された JMX による JMX 認証は必要ありません。

セッション指標を収集するには、JBoss CLI で次のコマンドを実行して、undertow サブシステムで統計情報を有効にする必要があります。

/subsystem=undertow:write-attribute(name=statistics-enabled,value=true)

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

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

構成の例

次のコマンドは、WildFly のテレメトリーを収集して取り込み、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
metrics:
  receivers:
    wildfly:
      type: wildfly
      endpoint: localhost:9990
  service:
    pipelines:
      wildfly:
        receivers:
          - wildfly

logging:
  receivers:
    wildfly_system:
      type: wildfly_system
  service:
    pipelines:
      wildfly_system:
        receivers:
          - wildfly_system
EOF

sudo service google-cloud-ops-agent restart

ログの収集を構成する

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

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

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

ログの内容

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

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

フィールド	タイプ	説明
`jsonPayload.level`	文字列	ログエントリレベル
`jsonPayload.message`	文字列	ログメッセージ
`jsonPayload.messageCode`	文字列	ログの前にある Wildfly 固有のメッセージコード（該当する場合）。
`jsonPayload.source`	文字列	ログの生成元のソース
`jsonPayload.thread`	文字列	ログの作成元であるスレッド
`severity`	文字列（`LogSeverity`）	ログエントリレベル（変換済み）。

指標の収集を構成する

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

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

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

フィールド	デフォルト	説明
`additional_jars`	`/opt/wildfly/bin/client/jboss-client.jar`	JMX で WildFly をモニタリングするために必要な `jboss-client.jar` ファイルのパス。
`collection_interval`	`60s`	期間の値（例: `30s`、`5m`）。
`endpoint`	`service:jmx:remote+http://localhost:9990`	JMX サービス URL、またはサービス URL の作成に使用されるホストとポート。この値は、`service:jmx:<protocol>:<sap>` または `host:port` の形式にする必要があります。`host:port` フォームの値は、`service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi` というサービス URL を作成するために使用されます。
`password`		JMX が認証を要求するように構成されている場合、構成されたパスワード。
`type`		値は、`wildfly` にする必要があります。
`username`		JMX が認証を要求するように構成されている場合、構成されたユーザー名。

モニタリング対象

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

指標タイプ
種類、タイプモニタリング対象リソース	ラベル
`workload.googleapis.com/wildfly.jdbc.connection.open`
`GAUGE`、`INT64` gce_instance	`data_source` `state`
`workload.googleapis.com/wildfly.jdbc.request.wait`
`CUMULATIVE`、`INT64` gce_instance	`data_source`
`workload.googleapis.com/wildfly.jdbc.rollback.count`
`CUMULATIVE`、`INT64` gce_instance	`cause`
`workload.googleapis.com/wildfly.jdbc.transaction.count`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/wildfly.network.io`
`CUMULATIVE`、`INT64` gce_instance	`listener` `server` `state`
`workload.googleapis.com/wildfly.request.count`
`CUMULATIVE`、`INT64` gce_instance	`listener` `server`
`workload.googleapis.com/wildfly.request.server_error`
`CUMULATIVE`、`INT64` gce_instance	`listener` `server`
`workload.googleapis.com/wildfly.request.time`
`CUMULATIVE`、`INT64` gce_instance	`listener` `server`
`workload.googleapis.com/wildfly.session.active`
`GAUGE`、`INT64` gce_instance	`deployment`
`workload.googleapis.com/wildfly.session.count`
`CUMULATIVE`、`INT64` gce_instance	`deployment`
`workload.googleapis.com/wildfly.session.expired`
`CUMULATIVE`、`INT64` gce_instance	`deployment`
`workload.googleapis.com/wildfly.session.rejected`
`CUMULATIVE`、`INT64` gce_instance	`deployment`

構成を確認する

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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