Extend the platform,
empower your team.
To gain insights including usage and statuses, about the different Routers, Message VPNs, Queues, Bridges and Topic Endpoints.
Read Only
User/PasswordThis extension uses the Solace SEMP v1 XML APIs to gather the metrics and data points.
Currently only Basic Authentication is supported via User and Password.
When using this extension with Solace Cloud :
-view
) . This user has the correct permissions while the -admin
does not.The extension queries the routers every minute to gather data, although there are some calls that may require to be called less frequently due to the large amount of response data they supply. See the Frequency for Large SEMP API Calls
in the configuration for more details.
Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.
Metric name | Metric key | Description | Unit |
---|---|---|---|
network-interface-enabled | custom.solace.system.network.interface.phy-interface.enabled | - | Count |
network-interface-link-detected | custom.solace.system.network.interface.os-physical.link-detected | - | Count |
- | custom.solace.system.network.interface.stats.rx-bytes | - | - |
- | custom.solace.system.network.interface.stats.tx-bytes | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
hostname | custom.solace.high-availability.vip-status.vip-status.hostname | - | Count |
redundancy-config-status | custom.solace.high-availability.redundancy.redundancy.config-status | - | Count |
redundancy-redundancy-status | custom.solace.high-availability.redundancy.redundancy.redundancy-status | - | Count |
redundancy-redundancy-mode | custom.solace.high-availability.redundancy.redundancy-mode | - | Count |
redundancy-active-standby-role | custom.solace.high-availability.redundancy.active-standby-role | - | Count |
redundancy-adb-link-up | custom.solace.high-availability.redundancy.redundancy.adb-link-up | - | Count |
redundancy-adb-hello-up | custom.solace.high-availability.redundancy.redundancy.adb-hello-up | - | Count |
redundancy-primary-status | custom.solace.high-availability.redundancy.redundancy.primary-status | - | Count |
redundancy-backup-status | custom.solace.high-availability.redundancy.redundancy.backup-status | - | Count |
redundancy-mate-router-name | custom.solace.high-availability.redundancy.redundancy.mate-router-name | - | Count |
message-spool-ingress-flows-allowed | custom.solace.system.message-spool.ingress-flows.ingress-flows-allowed | - | Count |
- | custom.solace.system.message-spool.ingress-flows.ingress-flow-count | - | - |
- | custom.solace.system.message-spool.egress-flows.active-flow-count | - | - |
- | custom.solace.system.message-spool.egress-flows.inactive-flow-count | - | - |
- | custom.solace.system.message-spool.egress-flows.browser-flow-count | - | - |
message-spool-message-spool-entities-allowed-by-qendpt | custom.solace.system.message-spool.endpoints-utilization.message-spool-entities-allowed-by-qendpt | - | Count |
message-spool-message-spool-entities-used-by-queue | custom.solace.system.message-spool.endpoints-utilization.message-spool-entities-used-by-queue | - | Count |
message-spool-message-spool-entities-used-by-dte | custom.solace.system.message-spool.endpoints-utilization.message-spool-entities-used-by-dte | - | Count |
message-spool-message-count-utilization-percentage | custom.solace.system.message-spool.spool-utilization.message-count-utilization-percentage | - | Percent |
- | custom.solace.system.message-spool.spool-utilization.total-messages-currently-spooled | - | - |
message-spool-spool-files-utilization-percentage | custom.solace.system.message-spool.spool-utilization.spool-files-utilization-percentage | - | Percent |
message-spool-max-transacted-sessions | custom.solace.system.message-spool.transacted-sessions.max-transacted-sessions | - | Count |
message-spool-transacted-sessions-used | custom.solace.system.message-spool.transacted-sessions.transacted-sessions-used | - | Count |
message-spool-max-transactions | custom.solace.system.message-spool.transacted-sessions.max-transactions | - | Count |
message-spool-transactions-used | custom.solace.system.message-spool.transacted-sessions.transactions-used | - | Count |
message-spool-max-disk-usage | custom.solace.system.message-spool.disk-usage.max-disk-usage | - | MegaByte |
message-spool-current-persist-usage (MB) | custom.solace.system.message-spool.disk-usage.current-persist-usage-mb | - | MegaByte |
message-spool-current-disk-usage (MB) | custom.solace.system.message-spool.disk-usage.current-disk-usage-mb | - | MegaByte |
message-spool-current-rfad-usage (ADB) (MB) | custom.solace.system.message-spool.disk-usage.current-rfad-usage-adb-mb | - | MegaByte |
message-spool-rfad-messages-currently-spooled (ADB) | custom.solace.system.message-spool.messages-currently-spooled.rfad-messages-currently-spooled-adb | - | Count |
message-spool-disk-messages-currently-spooled | custom.solace.system.message-spool.messages-currently-spooled.disk-messages-currently-spooled | - | Count |
message-spool-total-messages-currently-spooled | custom.solace.system.message-spool.messages-currently-spooled.total-messages-currently-spooled | - | Count |
message-spool-active-disk-partition-usage | custom.solace.system.message-spool.active-disk-partition-usage | - | Unspecified |
message-spool-config-status | custom.solace.system.message-spool.config-status | - | Count |
message-spool-operational-status | custom.solace.system.message-spool.operational-status | - | Count |
message-spool-datapath-up | custom.solace.system.message-spool.datapath-up | - | Count |
message-spool-synchronization-status | custom.solace.system.message-spool.synchronization-status | - | Count |
message-spool-transaction-resource-utilization-percentage | custom.solace.system.message-spool.transaction-resource-utilization-percentage | - | Percent |
message-spool-transacted-session-count-utilization-percentage | custom.solace.system.message-spool.transacted-session-count-utilization-percentage | - | Percent |
message-spool-delivered-unacked-msgs-utilization-percentage | custom.solace.system.message-spool.delivered-unacked-msgs-utilization-percentage | - | Percent |
message-spool-blocks | custom.solace.system.message-spool.disk-info.blocks-used | - | Unspecified |
message-vpn-current-ingress-compressed-rate-per-second | custom.solace.message-vpn.vpn.zip-stats.current-ingress-compressed-rate-per-second | - | PerSecond |
message-vpn-current-egress-compressed-rate-per-second | custom.solace.message-vpn.vpn.zip-stats.current-egress-compressed-rate-per-second | - | PerSecond |
message-vpn-current-ingress-ssl-rate-per-second | custom.solace.message-vpn.vpn.ssl-stats.current-ingress-ssl-rate-per-second | - | PerSecond |
message-vpn-current-egress-ssl-rate-per-second | custom.solace.message-vpn.vpn.ssl-stats.current-egress-ssl-rate-per-second | - | PerSecond |
- | custom.solace.message-vpn.vpn.total-unique-subscriptions | - | - |
- | custom.solace.message-vpn.vpn.total-remote-unique-subscriptions | - | - |
- | custom.solace.message-vpn.vpn.total-local-unique-subscriptions | - | - |
- | custom.solace.message-vpn.vpn.stats.ingress-discards.total-ingress-discards | - | - |
- | custom.solace.message-vpn.vpn.stats.egress-discards.total-egress-discards | - | - |
- | custom.solace.message-vpn.vpn.stats.total-client-messages-received | - | - |
- | custom.solace.message-vpn.vpn.stats.total-client-messages-sent | - | - |
- | custom.solace.message-vpn.vpn.stats.client-data-messages-received | - | - |
- | custom.solace.message-vpn.vpn.stats.client-data-messages-sent | - | - |
- | custom.solace.message-vpn.vpn.stats.client-data-bytes-received | - | - |
- | custom.solace.message-vpn.vpn.stats.client-data-bytes-sent | - | - |
message-vpn-current-ingress-rate-per-second | custom.solace.message-vpn.vpn.stats.current-ingress-rate-per-second | - | PerSecond |
message-vpn-current-egress-rate-per-second | custom.solace.message-vpn.vpn.stats.current-egress-rate-per-second | - | PerSecond |
message-vpn-average-ingress-rate-per-minute | custom.solace.message-vpn.vpn.stats.average-ingress-rate-per-minute | - | PerMinute |
message-vpn-average-egress-rate-per-minute | custom.solace.message-vpn.vpn.stats.average-egress-rate-per-minute | - | PerMinute |
message-vpn-connections | custom.solace.message-vpn.vpn.connections | - | Count |
service-connections-service-smf | custom.solace.message-vpn.vpn.connections-service-smf | - | Count |
service-connections-service-web | custom.solace.message-vpn.vpn.connections-service-web | - | Count |
service-connections-service-rest-incoming | custom.solace.message-vpn.vpn.connections-service-rest-incoming | - | Count |
service-connections-service-mqtt | custom.solace.message-vpn.vpn.connections-service-mqtt | - | Count |
service-connections-service-amqp | custom.solace.message-vpn.vpn.connections-service-amqp | - | Count |
service-connections-service-rest-outgoing | custom.solace.message-vpn.vpn.connections-service-rest-outgoing | - | Count |
message-vpn-max-connections | custom.solace.message-vpn.vpn.max-connections | - | Count |
service-max-connections-service-smf | custom.solace.message-vpn.vpn.max-connections-service-smf | - | Count |
service-max-connections-service-web | custom.solace.message-vpn.vpn.max-connections-service-web | - | Count |
service-max-connections-service-rest-incoming | custom.solace.message-vpn.vpn.max-connections-service-rest-incoming | - | Count |
service-max-connections-service-mqtt | custom.solace.message-vpn.vpn.max-connections-service-mqtt | - | Count |
service-max-connections-service-amqp | custom.solace.message-vpn.vpn.max-connections-service-amqp | - | Count |
service-max-connections-service-rest-outgoing | custom.solace.message-vpn.vpn.max-connections-service-rest-outgoing | - | Count |
message-vpn-enabled | custom.solace.message-vpn.vpn.enabled | - | Count |
message-vpn-locally-configured | custom.solace.message-vpn.vpn.locally-configured | - | Count |
message-vpn-local-status | custom.solace.message-vpn.vpn.local-status | - | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
replication-sync-msgs-queued-to-standby | custom.solace.system.replication.stats.active-stats.message-processing.sync-msgs-queued-to-standby | - | Count |
replication-async-msgs-queued-to-standby | custom.solace.system.replication.stats.active-stats.message-processing.async-msgs-queued-to-standby | - | Count |
replication-sync-msgs-queued-to-standby-as-async | custom.solace.system.replication.stats.active-stats.message-processing.sync-msgs-queued-to-standby-as-async | - | Count |
replication-msgs-tx-to-standby | custom.solace.system.replication.stats.active-stats.ack-propagation.msgs-tx-to-standby | - | Count |
replication-msgs-rx-from-active | custom.solace.system.replication.stats.standby-stats.message-processing.msgs-rx-from-active | - | Count |
replication-out-of-seq-rx | custom.solace.system.replication.stats.standby-stats.ack-propagation.out-of-seq-rx | - | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
physical-memory-usage-percent | custom.solace.system.memory.memory.physical-memory-usage-percent | - | Percent |
subscription-memory-usage-percent | custom.solace.system.memory.memory.subscription-memory-usage-percent | - | Percent |
nab-buffer-load-factor | custom.solace.system.memory.memory.nab-buffer-load-factor | - | Unspecified |
physical-memory-used | custom.solace.system.memory.memory.physical-memory-used | - | KiloByte |
Metric name | Metric key | Description | Unit |
---|---|---|---|
queue-num-messages-spooled | custom.solace.queues.queues-detail.queues-detail.num-messages-spooled | - | Count |
queue-current-spool-usage-in-mb | custom.solace.queues.queues-detail.queues-detail.current-spool-usage-in-mb | - | MegaByte |
queue-quota | custom.solace.queues.queues-detail.queues-detail.quota | - | MegaByte |
- | custom.solace.queues.queues-detail.queues-detail.bind-count | - | - |
queue-durable | custom.solace.queues.queues-detail.queues-detail.durable | - | Count |
queue-ingress-config-status | custom.solace.queues.queues-detail.queues-detail.ingress-config-status | - | Count |
queue-egress-config-status | custom.solace.queues.queues-detail.queues-detail.egress-config-status | - | Count |
- | custom.solace.queues.queues-detail.queues-detail.access-type | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
- | custom.solace.queues.queues-stats.queue-msg-spool-stats.total-ttl-expired-discard-messages | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
config-sync-admin-status | custom.solace.config-sync.status.admin-status | - | Count |
config-sync-oper-status | custom.solace.config-sync.status.oper-status | - | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
bridge-connection-uptime-in-seconds | custom.solace.message-vpn.bridge.bridge.connection-uptime-in-seconds | - | Second |
bridge-admin-state | custom.solace.message-vpn.bridge.bridge.admin-state | - | Count |
bridge-inbound-operational-state | custom.solace.message-vpn.bridge.bridge.inbound-operational-state | - | Count |
bridge-outbound-operational-state | custom.solace.message-vpn.bridge.bridge.outbound-operational-state | - | Count |
bridge-queue-operational-state | custom.solace.message-vpn.bridge.bridge.queue-operational-state | - | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
- | custom.solace.clients.clients-stats.client-stats.client-data-messages-received | - | - |
- | custom.solace.clients.clients-stats.client-stats.client-data-messages-sent | - | - |
client-current-ingress-rate-per-second | custom.solace.clients.clients-stats.client-stats.current-ingress-rate-per-second | - | PerSecond |
client-current-egress-rate-per-second | custom.solace.clients.clients-stats.client-stats.current-egress-rate-per-second | - | PerSecond |
client-average-ingress-rate-per-minute | custom.solace.clients.clients-stats.client-stats.average-ingress-rate-per-minute | - | PerMinute |
client-average-egress-rate-per-minute | custom.solace.clients.clients-stats.client-stats.average-egress-rate-per-minute | - | PerMinute |
- | custom.solace.clients.clients-stats.client-stats.total-ingress-discards | - | - |
- | custom.solace.clients.clients-stats.client-stats.total-egress-discards | - | - |
- | custom.solace.clients.clients-stats.client-stats.client-data-bytes-received | - | - |
- | custom.solace.clients.clients-stats.client-stats.client-data-bytes-sent | - | - |
- | custom.solace.clients.clients-stats.client-stats.total-client-bytes-received | - | - |
- | custom.solace.clients.clients-stats.client-stats.total-client-bytes-sent | - | - |
- | custom.solace.clients.clients-stats.client-stats.client-instances-count | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
queue-total-delivered-unacked-msgs | custom.solace.queues.queues-detail.queues-detail.total-delivered-unacked-msgs | - | Count |
- | custom.solace.queues.queues-detail.queues-detail.max-bind-count | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
- | custom.solace.system.subscription-management.subscription-management.total-subscriptions | - | - |
- | custom.solace.system.subscription-management.subscription-management.total-unique-subscriptions | - | - |
- | custom.solace.system.subscription-management.subscription-management.total-client-subscriptions | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
storage-used-blocks | custom.solace.storage-element.storage-element.used-blocks | - | Unspecified |
storage-available-blocks | custom.solace.storage-element.storage-element.available-blocks | - | Count |
storage-used-percentage | custom.solace.storage-element.storage-element.used-percentage | - | Percent |
Metric name | Metric key | Description | Unit |
---|---|---|---|
- | custom.solace.message-vpn.topic-endpoint.info.durable | - | - |
topic-endpoint-ingress-config-status | custom.solace.message-vpn.topic-endpoint.info.ingress-config-status | - | Count |
topic-endpoint-egress-config-status | custom.solace.message-vpn.topic-endpoint.info.egress-config-status | - | Count |
topic-endpoint-num-messages-spooled | custom.solace.message-vpn.topic-endpoint.info.num-messages-spooled | - | Count |
topic-endpoint-current-spool-usage-in-mb | custom.solace.message-vpn.topic-endpoint.info.current-spool-usage-in-mb | - | MegaByte |
- | custom.solace.message-vpn.topic-endpoint.info.bind-count | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
topic-endpoint-current-queues-and-topic-endpoints | custom.solace.message-spool.message-vpn.vpn.current-queues-and-topic-endpoints | - | Count |
message-spool-current-messages-spooled | custom.solace.message-spool.message-vpn.vpn.current-messages-spooled | - | Count |
message-spool-current-spool-usage-mb | custom.solace.message-spool.message-vpn.vpn.current-spool-usage-mb | - | MegaByte |
message-spool-maximum-spool-usage-mb | custom.solace.message-spool.message-vpn.vpn.maximum-spool-usage-mb | - | MegaByte |
Metric name | Metric key | Description | Unit |
---|---|---|---|
replication-admin-state | custom.solace.message-vpn.replication.message-vpn.admin-state | - | Count |
replication-config-state | custom.solace.message-vpn.replication.message-vpn.config-state | - | Count |
replication-transaction-replication-mode | custom.solace.message-vpn.replication.message-vpn.transaction-replication-mode | - | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
queue-current-ingress-rate-per-second | custom.solace.queues.queues-rates.qendpt-data-rates.current-ingress-rate-per-second | - | PerSecond |
queue-current-egress-rate-per-second | custom.solace.queues.queues-rates.qendpt-data-rates.current-egress-rate-per-second | - | PerSecond |
- | custom.solace.queues.queues-rates.qendpt-data-rates.average-ingress-rate-per-minute | - | - |
- | custom.solace.queues.queues-rates.qendpt-data-rates.average-egress-rate-per-minute | - | - |
Metric name | Metric key | Description | Unit |
---|---|---|---|
service-listen-port-operational-status | custom.solace.system.service.services.service.listen-port-operational-status | - | Count |
service-ssl-listen-port-operational-status | custom.solace.system.service.services.service.ssl.listen-port-operational-status | - | Count |
service-compression-listen-port-operational-status | custom.solace.system.service.services.service.compression-listen-port-operational-status | - | Count |
service-msg-backbone | custom.solace.system.service.services.msg-backbone | - | Count |
Metric name | Metric key | Description | Unit |
---|---|---|---|
disk-latency-average-value | custom.solace.system.health.disk-latency-average-value | - | Unspecified |
disk-latency-current-value | custom.solace.system.health.disk-latency-current-value | - | Unspecified |
compute-latency-average-value | custom.solace.system.health.compute-latency-average-value | - | Unspecified |
compute-latency-current-value | custom.solace.system.health.compute-latency-current-value | - | Unspecified |
network-interface-network-latency-average-value | custom.solace.system.health.network-latency-average-value | - | Unspecified |
network-interface-network-latency-current-value | custom.solace.system.health.network-latency-current-value | - | Unspecified |
mate-link-latency-average-value | custom.solace.system.health.mate-link-latency-average-value | - | Unspecified |
mate-link-latency-current-value | custom.solace.system.health.mate-link-latency-current-value | - | Unspecified |
Metric name | Metric key | Description | Unit |
---|---|---|---|
- | custom.solace.system.global-stats.clients.ingress-discards.total-ingress-discards | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.no-subscription-match | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.topic-parse-error | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.parse-error | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.msg-too-big | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.ttl-exceeded | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.web-parse-error | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.publish-topic-acl | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.msg-spool-discards | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.message-promotion-congestion | - | - |
- | custom.solace.system.global-stats.clients.ingress-discards.message-spool-congestion | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.total-egress-discards | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.transmit-congestion | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.compression-congestion | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.message-elided | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.ttl-exceeded | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.payload-could-not-be-formatted | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.message-promotion-congestion | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.message-spool-congestion | - | - |
- | custom.solace.system.global-stats.clients.egress-discards.client-not-connected | - | - |
total-clients-connected | custom.solace.system.global-stats.clients.total-clients-connected | - | Count |
service-total-clients-connected-service-smf | custom.solace.system.global-stats.clients.total-clients-connected-service-smf | - | Count |
- | custom.solace.system.global-stats.clients.current-ingress-rate-per-second | - | - |
- | custom.solace.system.global-stats.clients.current-egress-rate-per-second | - | - |
- | custom.solace.system.global-stats.clients.current-ingress-byte-rate-per-second | - | - |
- | custom.solace.system.global-stats.clients.current-egress-byte-rate-per-second | - | - |
- | custom.solace.system.global-stats.clients.ingress-compressed-bytes | - | - |
- | custom.solace.system.global-stats.clients.egress-compressed-bytes | - | - |