From 5c772e18c3b114663ba6e5a2f986ec4a4635aabc Mon Sep 17 00:00:00 2001 From: Matthias Hanel Date: Tue, 12 May 2020 21:28:22 -0400 Subject: [PATCH] Documenting monitoring endpoint as system service Signed-off-by: Matthias Hanel --- nats-server/configuration/sys_accounts/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/nats-server/configuration/sys_accounts/README.md b/nats-server/configuration/sys_accounts/README.md index 12a2126..bb2f29b 100644 --- a/nats-server/configuration/sys_accounts/README.md +++ b/nats-server/configuration/sys_accounts/README.md @@ -35,6 +35,20 @@ In addition other tools with system account privileges, can initiate requests \( * `$SYS.REQ.SERVER..STATSZ` \(request server stat summary\) * `$SYS.REQ.SERVER.PING` \(discover servers - will return multiple messages\) +[Monitoring endpoints](../monitoring.md) as listed in the table below are accessible as system services using the following subject pattern: + +* `$SYS.REQ.SERVER..` \(request server monitoring endpoint corresponding to endpoint name.\) +* `$SYS.REQ.SERVER.PING.` \(from all server request server monitoring endpoint corresponding to endpoint name - will return multiple messages\) + +| Endpoint | Endpoint Name | +| :--- | :--- | +| [General Server Information](../monitoring.md#general-information)| `VARZ` | +| [Connections](../monitoring.md#connection-information)| `CONNZ` | +| [Routing](../monitoring.md#route-information)| `ROUTEZ` | +| [Gateways](../monitoring.md#gateway-information)| `GATEWAYZ` | +| [Leaf Nodes](../monitoring.md#leaf-nodes-information)| `LEAFZ` | +| [Subscription Routing](../monitoring.md#subscription-routing-information)| `SUBSZ` | + Servers like `nats-account-server` publish system account messages when a claim is updated, the nats-server listens for them, and updates its account information accordingly: * `$SYS.ACCOUNT..CLAIMS.UPDATE`