# アラーム

EMQX は、CPU 使用率、システムおよびプロセスメモリ使用率、プロセス数、ルールエンジンのリソース状態、クラスターのパーティションおよび修復など、内部状態の変化を監視するための組み込みの監視およびアラーム機能を提供しています。これらの変化が閾値を超えたり期待値から逸脱した場合に EMQX はアラームをトリガーして記録し、状態が復旧するとリストから削除します。

本ページでは、EMQX が提供するアラーム情報、詳細なアラーム情報の取得および確認方法、アラーム設定および閾値の設定方法について紹介します。監視およびアラーム機能により、運用中の潜在的な問題を通知し続けます。適切な閾値を設定してアラームを構成することで、EMQX の安全性、安定性、信頼性を確保できます。

## アラーム一覧

以下の表は、システム監視中に潜在的な問題を示すためにトリガーされる可能性のあるアラームを示しています。

::: tip

アラームは、システムへの影響度や重大度に応じて3つのレベルに分類されます。

- **Error（エラー）**: ユーザー設定によるエラー。クライアントはエラーを認識して再試行可能です。

- **Warning（警告）**: 時折発生するエラー。頻発する場合は注意が必要です。

- **Critical（重大）**: クライアントとサーバー間で不可逆的なデータ損失が発生し、通信や業務に支障をきたします。

これらのレベルは開発視点から定義された推奨値であり、業務要件に応じて独自に定義可能です。

:::

| **アラーム**                | レベル    | 説明                                                        | **詳細**                                    | **閾値**                                                      |
| :------------------------- | -------- | :---------------------------------------------------------- | :------------------------------------------ | :------------------------------------------------------------ |
| high_system_memory_usage   | Warning  | システムメモリ使用率が高い                                 | システムメモリ使用率が約 ~p% を超えています | `os_mon.sysmem_high_watermark = 70%`                          |
| high_process_memory_usage  | Warning  | 単一の Erlang プロセスメモリ使用率が高い（システムメモリ使用率の割合） | プロセスメモリ使用率が約 ~p% を超えています | `os_mon.procmem_high_watermark = 5%`                          |
| high_cpu_usage             | Warning  | CPU 使用率が高い                                           | 約 ~p% の CPU 使用率                         | `os_mon.cpu_high_watermark = 80%` `os_mon.cpu_low_watermark = 60%` |
| too_many_processes         | Warning  | プロセス数が多すぎる                                      | 約 ~p% のプロセス使用率                      | `vm_mon.process_high_watermark = 80%` `vm_mon.process_low_watermark = 60%` |
| license_quota              | Warning  | ライセンスの接続数が上限を超えている                      | ライセンス：接続数が % を超えています         | `license.connection_high_watermark_alarm = 80%` `license.connection_low_watermark_alarm = 75%` |
| license_expiry             | Critical | ライセンスが期限切れ                                        | ライセンスは % に期限切れになります           | -                                                             |
| license_tps                | Warning  | TPS 使用率がライセンス上限を超えている                     | ライセンス：TPS 上限（例：10）を超えています | -                                                             |
| partition                  | Critical | ノードでパーティションが発生                               | ノード ~s でパーティションが発生しました      | -                                                             |
| resource                   | Critical | リソースが切断された                                      | リソース ~s(~s) がダウンしています           | -                                                             |
| conn_congestion            | Critical | 接続プロセスの輻輳                                       | 接続が輻輳しています                         | -                                                             |

## アラームの取得

EMQX では、アラームを取得して詳細情報を確認するための複数の方法を提供しています。1つは EMQX ダッシュボードを通じて、アクティブなアラームや履歴アラームをユーザーフレンドリーなインターフェースで閲覧する方法です。ここがアラームの概要を簡単に確認できる中央拠点となります。

また、MQTT のシステムトピックをサブスクライブしてリアルタイムにシステムアラームの通知を受け取る方法もあります。さらに、Webhook 統合を利用してアラームイベントを外部の HTTP サービスに送信することも可能です。アラームはログや REST API を通じて取得することもできます。

### ダッシュボードでアラームを確認する

EMQX ダッシュボードで、**Monitoring** -> **Alarms** をクリックします。次に、**Active** または **History** タブを選択して、現在アクティブなアラームや履歴アラームの一覧を表示します。

EMQX ダッシュボードでのアラーム管理の完全なガイドは、[アラーム](../dashboard/alarm_dashboard.md) を参照してください。

<img src="./assets/view-alarms.png" alt="アラーム表示" style="zoom:50%;" />

### システムトピック経由でアラームを取得する

アラームがトリガーまたは解除されると、EMQX は MQTT メッセージをシステムトピック `$SYS/brokers/<Node>/alarms/activate` または `$SYS/brokers/<Node>/alarms/deactivate` にパブリッシュします。ユーザーはこれらのトピックをサブスクライブしてアラーム通知を受け取れます。

アラーム通知メッセージのペイロードは JSON 形式で、以下のフィールドを含みます。

| フィールド名         | 型               | 説明                                                        |
| -------------------- | ---------------- | ----------------------------------------------------------- |
| `name`               | string           | アラーム名                                                  |
| `details`            | object           | アラームの詳細                                              |
| `message`            | string           | 人間が読みやすいアラームの説明                             |
| `activate_at`        | integer          | アラームが発動した時刻をマイクロ秒単位の UNIX タイムスタンプで表現 |
| `deactivate_at`      | integer / string | アラームが解除された時刻をマイクロ秒単位の UNIX タイムスタンプで表現。アクティブなアラームの場合は `infinity` となる。 |
| `activated`          | boolean          | アラームが発動中かどうか                                   |

システムメモリ使用率が高いアラームの例を挙げると、以下のようなアラームメッセージを受け取ります。

<img src="./assets/alarm_activate_msg.png" alt="アラームメッセージ" style="zoom:50%;" />

アラームは繰り返し通知されません。例えば高 CPU 使用率のアラームが発動中の場合、同種のアラームは再度生成されません。監視対象の指標が正常に戻ると自動的にアラームは解除されますが、手動で解除することも可能です。

### ログからアラームを取得する

アラームの発動および解除はログ（コンソールまたはファイル）に記録されます。メッセージ送信やイベント処理中に障害が発生した場合、詳細情報をログに出力でき、ログ解析によってアラートを検知することも可能です。以下の例は、ログに出力された詳細なアラーム情報を示しています。ログレベルは `warning` で、`msg` フィールドは `alarm_is_activated` および `alarm_is_deactivated` となっています。

<img src="./assets/view-alarms-log.png" alt="ログでのアラーム表示" style="zoom:50%;" />

### REST API 経由でアラームを取得する

API を通じてアラームの照会および管理が可能です。UI の左ナビゲーションメニューから **Alarms** をクリックすると、この API リクエストが実行されます。EMQX API の利用方法については [REST API](../api.md) を参照してください。

<img src="./assets/view-alarms-api.png" alt="APIでのアラーム表示" style="zoom:45%;" />

### Webhook 統合によるアラームイベント送信

EMQX バージョン 5.8.5 以降、ルールエンジンは以下の2つの新しいアラームイベントをサポートしています。

- [$events/sys/alarm_activated](../../develop/data-integration/rule-sql-events-and-fields.md#system-alarm-activated-event-events-sys-alarm-activated)
- [$events/sys/alarm_deactivated](../../develop/data-integration/rule-sql-events-and-fields.md#system-alarm-deactivated-event-events-sys-alarm-deactivated)

これらのイベントにより、Webhook 統合を通じて外部 HTTP サービスへアラームの発動・解除通知を受け取ることが可能です。

Webhook 統合の設定手順：

1. EMQX ダッシュボードで **Monitoring** -> **Alarms** に移動します。
2. 右上の **Set Up Webhook** ボタンをクリックし、Webhook 統合設定ページを開きます。
3. Webhook 統合の名前と任意のメモを入力します。**Trigger** フィールドには `Alarm Activated` と `Alarm Deactivated` があらかじめ選択されています。
4. 通知を送信する Webhook URL を入力します。
5. 詳細な設定オプションについては [Webhook 作成](../../develop/data-integration/webhook.md) を参照してください。
6. 設定が完了したら **Save** をクリックします。

![alarm_webhook_setup](./assets/alarm_webhook_setup.png)

## アラーム設定

アラーム設定には、アラームの動作設定と閾値設定が含まれます。アラームの動作設定はアラームメッセージの表示や保存方法を決定し、閾値設定は潜在的な問題を検知してアラームをトリガーするための制限値や値を定めます。アラーム設定機能により、業務要件に応じてアラームの動作や閾値をカスタマイズできます。

### アラーム動作設定の構成

アラームの動作設定は、設定ファイル内の設定項目を変更することでのみ構成可能です。以下の表はアラーム動作設定に利用可能な設定項目を示しています。

| 設定項目               | 説明                                                                                     | デフォルト値           | 選択可能な値   |
| ---------------------- | ---------------------------------------------------------------------------------------- | --------------------- | -------------- |
| alarm.actions          | アラーム発動・解除時にログ（コンソールまたはファイル）への書き込みおよびシステムトピック `$SYS/brokers/<node_name>/alarms/activate` と `$SYS/brokers/<node_name>/alarms/deactivate` への MQTT メッセージのパブリッシュを行うアクション。 | `["log", "publish"]`   | -              |
| alarm.size_limit       | 履歴として保持する非アクティブアラームの最大総数。この上限を超えると最も古い非アクティブアラームから削除される。 | `1000`                | `1-3000`       |
| alarm.validity_period  | 非アクティブアラームの保持期間。アラームは解除されてもすぐには削除されず、一定期間経過後に削除される。 | `24h`                 | -              |

### ダッシュボードでアラーム閾値を設定する

EMQX ダッシュボードでアラーム閾値を設定できます。閾値設定用の **Monitoring** ページを起動する方法は2通りあります。

1. **Alarms** ページで **Setting** ボタンをクリックすると **Monitoring** ページに遷移します。
2. 左ナビゲーションメニューから **Management** -> **Monitoring** をクリックします。

**Monitoring** -> **System** タブの中の **Erlang VM** タブでは、Erlang 仮想マシンのシステムパフォーマンスに関する以下の項目を設定できます。

<img src="./assets/monitoring-system-ee.png" alt="システム監視設定" style="zoom:40%;" />

- **Process limit check interval**: プロセス数の定期チェック間隔を秒単位で指定します。デフォルトは `30` 秒です。
- **Process high watermark**: ローカルノードで同時に存在可能なプロセス数の閾値（割合）を指定します。この割合を超えるとアラームが発動します。デフォルトは `80` パーセントです。
- **Process low watermark**: ローカルノードで同時に存在可能なプロセス数の解除閾値（割合）を指定します。この割合を下回るとアラームが解除されます。デフォルトは `60` パーセントです。
- **Enable Long GC monitoring**: デフォルトは無効。有効にすると、Erlang プロセスが長時間ガベージコレクションを行った際に警告レベルのログ `long_gc` を出力し、システムトピック `$SYS/sysmon/long_gc` に MQTT メッセージをパブリッシュします。
- **Enable Long Schedule monitoring**: デフォルトで有効。Erlang VM が長時間スケジュールされたタスクを検知した場合、警告レベルのログ `long_schedule` を出力します。タスクの適切なスケジュール時間をミリ秒単位で設定できます。デフォルトは `240` ミリ秒です。
- **Enable Large Heap monitoring**: デフォルトで有効。Erlang プロセスが大きなヒープ領域を消費した場合、警告レベルのログ `large_heap` を出力し、システムトピック `$SYS/sysmon/large_heap` に MQTT メッセージをパブリッシュします。ヒープ領域のサイズ制限をバイト単位で設定可能です。デフォルトは `32` MB です。
- **Enable Busy Distribution Port monitoring**: デフォルトで有効。クラスター内の他ノードと通信するための RPC 接続が過負荷状態になると、警告レベルのログ `busy_dis_port` を出力し、システムトピック `$SYS/sysmon/busy_dist_port` に MQTT メッセージをパブリッシュします。
- **Enable Busy Port monitoring**: デフォルトで有効。ポートが過負荷状態になると、警告レベルのログ `busy_port` を出力し、システムトピック `$SYS/sysmon/busy_port` に MQTT メッセージをパブリッシュします。

設定完了後、**Save Changes** をクリックしてください。

**Operating System** タブでは、システムパフォーマンスに関する以下の項目を設定できます。

<img src="./assets/monitoring-operating-system-ee.png" alt="OS監視設定" style="zoom:40%;" />

- **The time interval of the periodic CPU check**: CPU 使用率の定期チェック間隔を秒単位で指定します。デフォルトは `60` 秒です。
- **CPU high watermark**: システム CPU 使用率の閾値を指定します。この割合を超えるとアラームが発動します。デフォルトは `80` パーセントです。
- **CPU low watermark**: システム CPU 使用率の解除閾値を指定します。この割合を下回るとアラームが解除されます。デフォルトは `60` パーセントです。
- **Mem check interval**: メモリ使用率の定期チェック間隔を秒単位で指定します。デフォルトは `60` 秒で有効になっています。
- **SysMem high watermark**: システムメモリ使用率の閾値を指定します。この割合を超えるとアラームが発動します。デフォルトは `70%` です。
- **ProcMem high watermark**: 単一の Erlang プロセスによるメモリ使用率の閾値を指定します。この割合を超えるとアラームが発動します。デフォルトは `5%` です。

設定完了後、**Save Changes** をクリックしてください。

### 設定ファイルでアラーム閾値を設定する

設定ファイル内のアラーム閾値に関する設定項目を変更しても、アラーム閾値を設定可能です。現在変更可能な設定項目は以下の通りです。

| 設定項目                          | 説明                                                                                     | デフォルト値  |
| --------------------------------- | ---------------------------------------------------------------------------------------- | ------------ |
| sysmon.os.cpu_check_interval       | CPU 使用率のチェック間隔                                                                 | `60s`        |
| sysmon.os.cpu_high_watermark       | CPU 使用率の高水位閾値。アラーム発動の閾値。                                            | `80%`        |
| sysmon.os.cpu_low_watermark        | CPU 使用率の低水位閾値。アラーム解除の閾値。                                            | `60%`        |
| sysmon.os.mem_check_interval       | メモリ使用率のチェック間隔                                                               | `60s`        |
| sysmon.os.sysmem_high_watermark    | システムメモリ使用率の高水位閾値。総メモリ使用率がこの値に達するとアラームが発動する。    | `70%`        |
| sysmon.os.procmem_high_watermark   | プロセスメモリ使用率の高水位閾値。単一プロセスのメモリ使用率がこの値に達するとアラームが発動する。 | `5%`         |
| sysmon.vm.process_check_interval   | プロセス数のチェック間隔                                                                 | `30s`        |
| sysmon.vm.process_high_watermark   | プロセス占有率の高水位閾値。作成済みプロセス数／最大数の割合で測定。閾値を超えるとアラーム発動。 | `80%`        |
| sysmon.vm.process_low_watermark    | プロセス占有率の低水位閾値。閾値を下回るとアラーム解除。                                 | `60%`        |
| sysmon.vm.long_gc                  | Long GC 監視の有効化設定                                                                | `disabled`   |
| sysmon.vm.long_schedule            | Long Schedule 監視の有効化設定                                                          | `disabled`   |
| sysmon.vm.large_heap               | Large Heap 監視の有効化設定                                                             | `disabled`   |
| sysmon.vm.busy_dist_port           | Busy Distribution Port 監視の有効化設定                                                | `true`       |
| sysmon.vm.busy_port                | Busy Port 監視の有効化設定                                                              | `true`       |
| sysmon.top.num_items               | 監視グループごとのトッププロセス数                                                     | `10`         |
| sysmon.top.sample_interval         | トッププロセスのチェック間隔                                                           | `2s`         |
| sysmon.top.max_procs               | VM 内のプロセス数がこの値を超えた場合、データ収集を停止                                | `1000000`    |

EMQX Enterprise では、ライセンスの有効期限が30日未満になるか、接続数が高水位閾値を超えた場合にアラームを発動します。接続数の高水位および低水位閾値は、設定ファイル内の以下の設定項目を変更して調整可能です。ライセンス設定の詳細は [ライセンス](../configuration/license.md) を参照してください。

| 設定項目                                | 説明                                                                                     | デフォルト値  |
| --------------------------------------- | ---------------------------------------------------------------------------------------- | ------------ |
| license.connection_high_watermark_alarm | ライセンスがサポートする最大接続数の高水位閾値。アクティブ接続数／最大接続数の割合で測定。閾値を超えるとアラーム発動。 | `80%`        |
| license.connection_low_watermark_alarm  | ライセンスがサポートする最大接続数の低水位閾値。閾値を下回るとアラーム解除。              | `75%`        |