Gateway KPI Definitions
A gateway is a connection between two Brokers in different territories, allowing the transfer of events between the territories. Each Broker belongs to its own territory but can share event types with its companion Broker across the gateway. A Broker can be a gateway to multiple territories.
Gateway components are logical constructs, so they will appear as Component Categories on the Analytics Overview page.
Discovery Mechanism
Gateway components are discovered automatically via Broker.
KPIs
| Name | Description |
|---|---|
| string remoteTerritoryName | Name of the remote territory. |
| string gatewayBrokerName | Remote Broker name. |
| string gatewayHost | Remote Broker's host name. |
| date now | Current time on the Broker host. |
| string connectedFrom | IP address where Broker is currently connected from. The attribute will be empty if there is no connection. |
| date lastConnectTime | Time when the Broker last connected. |
| boolean gateway_pause | A flag indicating whether outbound traffic from this gateway Broker to territory_name is enabled or disabled (paused). Will be true if outbound traffic to territory_name has been paused. |
| string gateway_pause_client | The client id of the Broker Admin Client that paused the gateway. If outbound traffic is not currently paused for territory_name, this parameter will be empty. |
| int gateway_pause_session | The session id from which the gateway was paused. If outbound traffic is not currently paused for territory_name, this parameter will be 0. |
| date gateway_pause_time | The time when the gateway was paused. If outbound traffic is not currently paused for territory_name, this parameter will be 0. |
| int numEventsForwarded | Number of documents forwarded across the gateway. |
| int numEventsReceived | Number of documents received across the gateway. |
| int numEventsEnqueued | Number of documents enqueued for the gateway. |
| date lastEventForwardTime | Time when a document was last forwarded across the gateway. |
| date lastEventReceiveTime | Time when a document was last received across the gateway. |
| date lastEventEnqueueTime | Time when a document was last enqueued for the gateway. |
| string protocol_version | The version of the territory protocol. |
| long queueLength | Current size (in number of documents) of the gateway's queue. |
| long queueByteSize | Current size (in bytes) of the gateway's queue. |
| long queueHighestLength | Highest length (in number of documents) of the gateway's queue. |
| date queueHighestLengthTime | Time when queueHighestLength was last changed. |
| int ObjectStatus | Indicates Operational or Failed status of the component. |
| boolean ContainsResourceMessage | Flag indicating a resource message, such as a log message or exception message, has been received from the monitored resource. |
| int MessageSeverity | Severity level of
the resource message:
Critical = 1 Major = 2 Minor = 3 Warning = 4 Info = 5 Ok = 6 Indeterminate = 7 |