# ブローカーのヘルス指標

このページは、EMQX ブローカーの監視に最も役立つ Prometheus メトリクスを厳選してまとめたリファレンスです。これらのメトリクスの公開およびスクレイピング方法については、[Prometheusとの統合](./prometheus.md)をご参照ください。

指標は以下の4つの分野に分類されています。

1. **システム**：オペレーティングシステムおよびErlang VMのリソース。
2. **ブローカー**：接続とメッセージトラフィック、ならびにブローカーの状態。
3. **認証と認可**：接続時のIDチェックおよびメッセージごとのACL判定。
4. **データ統合**：ルール、アクション、コネクター、ブリッジ。

すべてのメトリクスは EMQX の Prometheus エンドポイント（`/api/v5/prometheus/stats`、`/api/v5/prometheus/auth`、`/api/v5/prometheus/data_integration`）で公開されています。エンドポイントの詳細や `mode` クエリパラメータについては、[Prometheusとの統合](./prometheus.md#configure-pull-mode-integration)を参照してください。

::: tip コレクターのデフォルト設定について

`emqx_` プレフィックスのメトリクスは常に有効です。より詳細な Erlang VM メトリクスである `erlang_vm_` プレフィックスのものは、上流の Prometheus Erlang エクスポーター由来であり、EMQX 6.0 以降では **デフォルトで無効** になっています。プロセス数、アロケーター別メモリ、GCやスケジューラーの内訳を有効にするには、`prometheus.collectors.vm_system_info`、`vm_memory`、`vm_statistics` を `enabled` に設定してください。

:::

## システム

ハードウェア層に最も近い信号です。ブローカーが不調になると、通常これらのいずれかが最初に変動します。

### CPU

| メトリクス | 説明 |
|------------|-------|
| `emqx_vm_cpu_use` | 使用中のCPU割合（パーセント）。 |
| `emqx_vm_cpu_idle` | アイドル状態のCPU割合（パーセント）。 |

### メモリ

| メトリクス | 説明 |
|------------|-------|
| `emqx_vm_total_memory` | システム全体のメモリ容量（バイト）。 |
| `emqx_vm_used_memory` | 使用中のシステムメモリ（バイト）。 |
| `erlang_vm_memory_processes` | アロケーター別メモリ：プロセス（`vm_memory` コレクター有効時）。 |
| `erlang_vm_memory_atom` | アロケーター別メモリ：アトム。 |
| `erlang_vm_memory_binary` | アロケーター別メモリ：バイナリ。 |
| `erlang_vm_memory_ets` | アロケーター別メモリ：ETSテーブル。 |
| `erlang_vm_memory_code` | アロケーター別メモリ：ロード済みコード。 |
| `erlang_vm_memory_system` | アロケーター別メモリ：システムオーバーヘッド。 |

### ファイルディスクリプタ

| メトリクス | 説明 |
|------------|-------|
| `emqx_vm_max_fds` | ブローカープロセスのソフトFD上限値。 |

### Erlangプロセスとスケジューラー負荷

| メトリクス | 説明 |
|------------|-------|
| `emqx_vm_run_queue` | 現在のスケジューラーの実行キュー長。持続的にゼロ以外の場合はCPU飽和を示します。 |
| `emqx_vm_process_messages_in_queues` | すべてのErlangプロセスのメールボックス長の合計。大きいまたは増加傾向は処理遅延を意味します。 |
| `erlang_vm_process_count` | 現在のErlangプロセス数（`vm_system_info` コレクター有効時）。 |
| `erlang_vm_process_limit` | 設定された最大Erlangプロセス数。 |

### 内部メールボックス監視

| メトリクス | 説明 |
|------------|-------|
| `emqx_vm_mnesia_tm_mailbox_size` | Mnesiaトランザクションマネージャのメールボックス深さ。高値はトランザクション競合を示します。 |
| `emqx_vm_broker_pool_max_mailbox_size` | ブローカーディスパッチプール内の最大メールボックス長。高値はサブスクライバー側のバックプレッシャーを示します。 |

### アップタイム

| メトリクス | 説明 |
|------------|-------|
| `emqx_vm_uptime_ms` | ブローカーの稼働時間（ミリ秒）。急激に小さくなるとノードが再起動したことを示します。 |

### クラスター複製のヘルス（Mria）

| メトリクス | 説明 |
|------------|-------|
| `emqx_mria_lag` | レプリカノードごとの複製遅延。 |
| `emqx_mria_replicants` | レプリカ数。 |
| `emqx_mria_bootstrap_time` | 最後のブートストラップに要した時間。 |
| `emqx_mria_message_queue_len` | Mriaのメールボックス長。 |

### オーバーロード保護

| メトリクス | 説明 |
|------------|-------|
| `emqx_overload_protection_new_conn` | オーバーロードによって拒否された接続数。 |
| `emqx_overload_protection_gc` | オーバーロード保護による強制ガベージコレクション回数。 |
| `emqx_overload_protection_hibernation` | トリガーされたプロセスのハイバーネーション数。 |
| `emqx_overload_protection_delay_ok` | 遅延適用が成功した回数。 |
| `emqx_overload_protection_delay_timeout` | 遅延試行がタイムアウトした回数。 |

## ブローカー

コアの運用信号です。メッセージ関連カウンターのレートを監視し、特に `dropped` 系列に注意してください。

### クラスター トポロジー

| メトリクス | 説明 |
|------------|-------|
| `emqx_cluster_nodes_running` | 稼働中のクラスター ノード数。 |
| `emqx_cluster_nodes_stopped` | 停止中のクラスター ノード数。0より大きい場合はアラート対象です。 |
| `emqx_conf_sync_txid` | 適用済みの最後のクラスター設定トランザクションID。ノード間で異なる場合は同期問題を示します。 |

### ライセンス（Enterprise）

| メトリクス | 説明 |
|------------|-------|
| `emqx_license_expiry_at` | ライセンスの有効期限（UNIXエポック秒）。 |
| `emqx_license_issued_at` | ライセンス発行日時。 |
| `emqx_license_max_sessions` | ライセンスのセッション上限。 |
| `emqx_cert_expiry_at` | リスナー証明書の有効期限。 |

### 接続、セッション、チャネル

| メトリクス | 説明 |
|------------|-------|
| `emqx_connections_count` | 現在の接続数。 |
| `emqx_connections_max` | 起動以降の最大接続数。 |
| `emqx_live_connections_count` | 現在接続中（TCP接続確立済み）のクライアント数。 |
| `emqx_live_connections_max` | 最大ライブ接続数。 |
| `emqx_sessions_count` | アクティブなセッション数（現在切断中の永続セッションも含む）。 |
| `emqx_sessions_max` | 最大セッション数。 |
| `emqx_cluster_sessions_count` | クラスター全体のセッション数。 |
| `emqx_cluster_sessions_max` | 最大クラスター全体セッション数。 |
| `emqx_channels_count` | チャネルプロセス数（接続クライアントごとに1つ）。 |
| `emqx_channels_max` | 最大チャネル数。 |

### サブスクリプションとトピック

| メトリクス | 説明 |
|------------|-------|
| `emqx_subscriptions_count` | サブスクリプション数。 |
| `emqx_subscriptions_max` | 最大サブスクリプション数。 |
| `emqx_subscriptions_shared_count` | 共有サブスクリプション数。 |
| `emqx_subscriptions_shared_max` | 最大共有サブスクリプション数。 |
| `emqx_subscribers_count` | サブスクライバープロセス数。 |
| `emqx_topics_count` | ユニークなトピック数。 |
| `emqx_topics_max` | 最大トピック数。 |
| `emqx_routes_count` | ルートテーブルのサイズ。 |
| `emqx_routes_max` | 最大ルートテーブルサイズ。 |
| `emqx_durable_subscriptions_count` | 永続セッションのサブスクリプション数。 |
| `emqx_durable_subscriptions_max` | 最大永続セッションサブスクリプション数。 |

### 保持済み、遅延、禁止

| メトリクス | 説明 |
|------------|-------|
| `emqx_retained_count` | 保持メッセージ数。 |
| `emqx_retained_max` | 最大保持メッセージ数。 |
| `emqx_delayed_count` | 遅延パブリッシュキューの深さ。 |
| `emqx_delayed_max` | 最大遅延キュー深さ。 |
| `emqx_banned_count` | 禁止されたクライアント／ユーザー名／IPのエントリ数。 |

### メッセージ

| メトリクス | 説明 |
|------------|-------|
| `emqx_messages_received` | クライアントから受信したアプリケーションレベルのメッセージ数。 |
| `emqx_messages_sent` | クライアントへ送信したアプリケーションレベルのメッセージ数。 |
| `emqx_messages_publish` | 発行された PUBLISH パケット数。 |
| `emqx_messages_delivered` | サブスクライバーへの配信数（1つのパブリッシュメッセージが複数配信される場合あり）。 |
| `emqx_messages_acked` | サブスクライバーから受信したアック数。 |
| `emqx_messages_forward` | ノード間のメッセージ転送数。 |
| `emqx_messages_retained` | 保持メッセージイベント数。 |
| `emqx_messages_delayed` | 遅延パブリッシュのキューイング数。 |

### メッセージドロップ（問題の最初の兆候）

| メトリクス | 説明 |
|------------|-------|
| `emqx_messages_dropped` | ドロップされたメッセージの合計数。 |
| `emqx_messages_dropped_expired` | メッセージの有効期限超過によるドロップ数。 |
| `emqx_messages_dropped_no_subscribers` | マッチするサブスクライバーがいなかったためのドロップ数。 |
| `emqx_messages_dropped_quota_exceeded` | クライアントごとのクォータ超過によるドロップ数。 |
| `emqx_messages_dropped_receive_maximum` | サブスクライバーの MQTT v5 受信最大数制限超過によるドロップ数。 |

### サブスクライバーごとの配信ドロップ

| メトリクス | 説明 |
|------------|-------|
| `emqx_delivery_dropped` | ドロップされた配信の合計数。 |
| `emqx_delivery_dropped_expired` | 配信前に期限切れとなった数。 |
| `emqx_delivery_dropped_no_local` | MQTT v5 の no-local ルールによるドロップ数。 |
| `emqx_delivery_dropped_qos` | サポートされていない QoS によるドロップ数。 |
| `emqx_delivery_dropped_queue_full` | サブスクライバーのメッセージキューが満杯によるドロップ数。 |
| `emqx_delivery_dropped_too_large` | サブスクライバーの最大パケットサイズ超過によるドロップ数。 |

### バイト数

| メトリクス | 説明 |
|------------|-------|
| `emqx_bytes_received` | 受信した合計バイト数。 |
| `emqx_bytes_sent` | 送信した合計バイト数。 |

### パケットレベル（プロトコルデバッグ用ダッシュボード）

| メトリクス | 説明 |
|------------|-------|
| `emqx_packets_received` | 受信したパケットの合計数。 |
| `emqx_packets_sent` | 送信したパケットの合計数。 |
| `emqx_packets_connect` | 受信した CONNECT パケット数。 |
| `emqx_packets_connack_sent` | 送信した CONNACK パケット数。 |
| `emqx_packets_connack_error` | ゼロ以外の理由コードを持つ CONNACK（多くのクライアント認証失敗がここに表示されます）。 |
| `emqx_packets_disconnect_received` | 受信した DISCONNECT パケット数。 |
| `emqx_packets_disconnect_sent` | 送信した DISCONNECT パケット数。 |
| `emqx_packets_publish_received` | 受信した PUBLISH パケット数。 |
| `emqx_packets_publish_sent` | 送信した PUBLISH パケット数。 |
| `emqx_packets_publish_error` | 受け入れられなかった PUBLISH。 |
| `emqx_packets_publish_auth_error` | 認可により拒否された PUBLISH。 |
| `emqx_packets_puback_received` | 受信した PUBACK パケット数（QoS 1）。 |
| `emqx_packets_puback_sent` | 送信した PUBACK パケット数（QoS 1）。 |
| `emqx_packets_pubrec_received` | 受信した PUBREC パケット数（QoS 2）。 |
| `emqx_packets_pubrec_sent` | 送信した PUBREC パケット数（QoS 2）。 |
| `emqx_packets_pubrel_received` | 受信した PUBREL パケット数（QoS 2）。 |
| `emqx_packets_pubrel_sent` | 送信した PUBREL パケット数（QoS 2）。 |
| `emqx_packets_pubcomp_received` | 受信した PUBCOMP パケット数（QoS 2）。 |
| `emqx_packets_pubcomp_sent` | 送信した PUBCOMP パケット数（QoS 2）。 |
| `emqx_packets_subscribe_received` | 受信した SUBSCRIBE パケット数。 |
| `emqx_packets_suback_sent` | 送信した SUBACK パケット数。 |
| `emqx_packets_subscribe_error` | 失敗した SUBSCRIBE パケット数。 |
| `emqx_packets_subscribe_auth_error` | 認可により拒否された SUBSCRIBE。 |
| `emqx_packets_unsubscribe_received` | 受信した UNSUBSCRIBE パケット数。 |
| `emqx_packets_unsuback_sent` | 送信した UNSUBACK パケット数。 |
| `emqx_packets_unsubscribe_error` | 失敗した UNSUBSCRIBE パケット数。 |
| `emqx_packets_pingreq_received` | 受信した PINGREQ パケット数。 |
| `emqx_packets_pingresp_sent` | 送信した PINGRESP パケット数。 |

### クライアントライフサイクル（フックトリガーカウンター）

| メトリクス | 説明 |
|------------|-------|
| `emqx_client_connect` | 受信した CONNECT。 |
| `emqx_client_connack` | 送信した CONNACK。 |
| `emqx_client_connected` | `client.connected` フックが発火。 |
| `emqx_client_disconnected` | `client.disconnected` フックが発火。 |
| `emqx_client_disconnected_reason` | 切断理由別の切断数。 |
| `emqx_client_subscribe` | サブスクライブフックが発火。 |
| `emqx_client_unsubscribe` | アンサブスクライブフックが発火。 |

### セッションライフサイクル

| メトリクス | 説明 |
|------------|-------|
| `emqx_session_created` | 作成されたセッション数。 |
| `emqx_session_resumed` | 再開された永続セッション数。 |
| `emqx_session_takenover` | 新しいクライアントに引き継がれたセッション数。 |
| `emqx_session_discarded` | 廃棄されたセッション数（既存セッションのクリーンスタート）。 |
| `emqx_session_terminated` | 終了したセッション数。 |

## 認証と認可

HTTP、LDAP、またはデータベースバックエンドが認証経路にある場合に、ブローカーまたはバックエンドのどちらが遅延または障害の原因かを判断するためにこれらのメトリクスを使用します。

### 接続時認証結果

| メトリクス | 説明 |
|------------|-------|
| `emqx_authentication_success` | 認証成功（匿名を除く）。 |
| `emqx_authentication_success_anonymous` | 匿名認証成功。 |
| `emqx_authentication_failure` | 認証失敗。 |

### 認可判定

| メトリクス | 説明 |
|------------|-------|
| `emqx_authorization_allow` | 判定：許可。 |
| `emqx_authorization_deny` | 判定：拒否。 |
| `emqx_authorization_nomatch` | マッチするルールなし（`no_match` 設定にフォールバック）。 |
| `emqx_authorization_matched_allow` | 許可ルールが発火。 |
| `emqx_authorization_matched_deny` | 拒否ルールが発火。 |
| `emqx_authorization_cache_hit` | キャッシュヒット。 |
| `emqx_authorization_cache_miss` | キャッシュミス。 |
| `emqx_authorization_superuser` | スーパーユーザーバイパス経路。 |

### 認証チェーンの状態

| メトリクス | 説明 |
|------------|-------|
| `emqx_authn_total` | 設定された認証プロバイダー数。 |
| `emqx_authn_enable` | プロバイダーごとの有効フラグ（0 / 1）。 |
| `emqx_authn_status` | プロバイダーごとのリソース状態。 |
| `emqx_authn_users_count` | プロバイダーごとのユーザーレコード数（パスワード、mnesia、DBバックエンドの場合）。 |

### プロバイダーごとの認証ランタイムカウンター

| メトリクス | 説明 |
|------------|-------|
| `emqx_authn_success` | プロバイダーごとの認証成功数。 |
| `emqx_authn_failed` | プロバイダーごとの認証失敗数。 |
| `emqx_authn_nomatch` | プロバイダーごとの無視数（チェーンは次のプロバイダーへ継続）。 |
| `emqx_authn_latency` | プロバイダーごとのバックエンドレイテンシ。 |

### 認可ソースの状態

| メトリクス | 説明 |
|------------|-------|
| `emqx_authz_total` | 設定された認可ソース数。 |
| `emqx_authz_enable` | ソースごとの有効フラグ（0 / 1）。 |
| `emqx_authz_status` | ソースごとのリソース状態。 |
| `emqx_authz_rules_count` | ソースごとのルールレコード数（ファイル、mnesia、DBバックエンド）。 |

### ソースごとの認可ランタイムカウンター

| メトリクス | 説明 |
|------------|-------|
| `emqx_authz_allow` | ソースごとの許可判定数。 |
| `emqx_authz_deny` | ソースごとの拒否判定数。 |
| `emqx_authz_nomatch` | ソースごとの無視数（チェーン継続）。 |
| `emqx_authz_latency` | ソースごとのバックエンドレイテンシ。 |

### 組み込みDBサイズ

| メトリクス | 説明 |
|------------|-------|
| `emqx_authn_builtin_record_count` | 組み込み認証データベースのユーザー数。 |
| `emqx_authz_builtin_record_count` | 組み込み認可データベースのルール数。 |

## データ統合

トラフィックはルールエンジンに入り、アクションやコネクターにファンアウトし、外部システムに到達します。各レイヤーは独自のカウンターを公開しており、順に読むことでメッセージがどこで失われているかがわかります。

### インベントリ

| メトリクス | 説明 |
|------------|-------|
| `emqx_rules_count` | 設定されたルール数。 |
| `emqx_actions_count` | 設定されたアクション数。 |
| `emqx_connectors_count` | 設定されたコネクター数。 |
| `emqx_schema_registrys_count` | スキーマレジストリのエントリ数。 |

### リソースごとの状態

| メトリクス | 説明 |
|------------|-------|
| `emqx_rule_enable` | ルールの有効フラグ（0 / 1）。 |
| `emqx_action_enable` | アクションの有効フラグ（0 / 1）。 |
| `emqx_action_status` | アクションリソースの状態。 |
| `emqx_connector_enable` | コネクターの有効フラグ（0 / 1）。 |
| `emqx_connector_status` | コネクターリソースの状態。 |

### ルールエンジン：ルールごとのカウンター

| メトリクス | 説明 |
|------------|-------|
| `emqx_rule_matched` | ルールの WHERE 句にマッチしたメッセージ数。 |
| `emqx_rule_passed` | ルールを通過したメッセージ数。 |
| `emqx_rule_failed` | ルール処理の失敗数。 |
| `emqx_rule_failed_exception` | ルール内で発生したErlang例外。 |
| `emqx_rule_failed_no_result` | SQLが結果を返さなかった場合の数。 |

### ルールエンジン：アクションのサブカウンター

| メトリクス | 説明 |
|------------|-------|
| `emqx_rule_actions_total` | ルールからのアクション呼び出し回数。 |
| `emqx_rule_actions_success` | アクションが成功した回数。 |
| `emqx_rule_actions_failed` | アクションが失敗した回数。 |
| `emqx_rule_actions_failed_unknown` | 原因不明の失敗回数。 |
| `emqx_rule_actions_failed_out_of_service` | 下流リソースが不健康なための失敗回数。 |
| `emqx_rule_actions_discarded` | アクションが破棄された回数（例：レート制限）。 |

### アクションのスループット

| メトリクス | 説明 |
|------------|-------|
| `emqx_action_matched` | アクションにルーティングされたメッセージ数。 |
| `emqx_action_received` | アクションキューで受信したメッセージ数。 |
| `emqx_action_success` | アクション呼び出しが成功した回数。 |
| `emqx_action_failed` | アクション呼び出しが失敗した回数。 |
| `emqx_action_late_reply` | タイムアウト後に応答が到着した回数。 |
| `emqx_action_retried` | リトライ試行回数。 |
| `emqx_action_retried_success` | リトライ後に成功した回数。 |
| `emqx_action_retried_failed` | すべてのリトライ後に失敗した回数。 |

### アクションキューとインフライト

| メトリクス | 説明 |
|------------|-------|
| `emqx_action_inflight` | 処理中のリクエスト数。 |
| `emqx_action_queuing` | キューに入っている（ディスパッチ待ちの）長さ。 |

### アクションのドロップ

これらのいずれかの系列でゼロ以外のレートがある場合、下流システムが不健康かアクションの設定に問題があります。

| メトリクス | 説明 |
|------------|-------|
| `emqx_action_dropped` | アクション層でドロップされた合計数。 |
| `emqx_action_dropped_queue_full` | キュー容量上限に達した回数。 |
| `emqx_action_dropped_resource_stopped` | 対象リソースが停止しているためのドロップ数。 |
| `emqx_action_dropped_resource_not_found` | 対象リソースが見つからないためのドロップ数。 |
| `emqx_action_dropped_expired` | ディスパッチ前にメッセージが期限切れとなった数。 |
| `emqx_action_dropped_other` | その他の理由によるドロップ数。 |

## 最小限の「ブローカー異常」パネル

Grafana ダッシュボードに表示できる系列が限られている場合、以下の指標が最も重要です。ほとんどの本番問題は、イベント発生から数秒以内にこれらのいずれかが変動します。

- `rate(emqx_messages_dropped[1m])`：ゼロ以外はブローカーが処理を拒否または失っていることを示します。
- `rate(emqx_action_dropped[1m])`：統合レイヤーで処理が失われていることを示します。
- `emqx_cluster_nodes_stopped`：0より大きい場合はメンバーが失われています。
- `rate(emqx_overload_protection_new_conn[1m])`：ブローカーが新規接続を積極的に拒否しています。
- `rate(emqx_authentication_failure[1m])`：急増は通常バックエンド問題または攻撃を示します。
- `emqx_vm_run_queue`：持続的にゼロ以上はCPU飽和を示します。
- `emqx_vm_process_messages_in_queues`：大きな値はプロセスメールボックスのバックログを示します。
- `emqx_mria_lag`：数秒以上の値は複製遅延を示します。
- `emqx_license_expiry_at - time()`（Enterprise）：ライセンス有効期限までのカウントダウン。