Insights Metrics: Message VPN

Solace Insights Metrics and Checks provides information about using, filtering, and understanding the metrics collected by Insights.

This page contains metrics and statistics for:

Message VPN Detailed Statistics

Metric
Name
Unit (If Applicable) Polling
Frequency
in Seconds
In Addition to
Common Tags,
Other Tags to Use
Description

vpn.total_unique_subscriptions

not applicable 10

vpn_name

The number of unique subscriptions in the Message VPN.

vpn.max_subscriptions

not applicable 10

vpn_name

The configured maximum number of subscriptions for the Message VPN.

vpn.total_remote_unique_subscriptions

not applicable 10

vpn_name

The number of subscriptions from remote brokers (DMR).

vpn.total_local_unique_subscriptions

not applicable 10

vpn_name

The number of local subscriptions in use by consumers connected to this Message VPN.

vpn.export_subscriptions_percent_complete

percentage

10

vpn_name

The percentage of subscriptions propagated to remote brokers.

vpn.connections

not applicable 10

vpn_name

The current number of connections to the Message VPN.

vpn.max_connections

not applicable 10

vpn_name

The configured maximum number of connections for the Message VPN.

vpn.connections_service_smf

not applicable 10

vpn_name

The total number of connections using the Solace Message Format (SMF) protocol in the Message VPN.

vpn.max_connections_service_smf

not applicable 10

vpn_name

The configured maximum number of connections using the SMF protocol.

vpn.connections_service_web

not applicable 10

vpn_name

The total number of connections using the Web Messaging protocol.

vpn.max_connections_service_web

not applicable 10

vpn_name

The configured maximum number of connections using the Web Messaging protocol.

vpn.connections_service_rest_incoming

not applicable 10

vpn_name

The total number of incoming REST connections.

vpn.max_connections_service_rest_incoming

not applicable 10

vpn_name

The configured maximum number of incoming connections using the REST protocol.

vpn.connections_service_mqtt

not applicable 10

vpn_name

The current number of MQTT connections.

vpn.max_connections_service_mqtt

not applicable 10

vpn_name

The configured maximum number of MQTT connections

vpn.connections_service_rest_outgoing

not applicable 10

vpn_name

The total number of outgoing REST connections.

vpn.max_connections_service_rest_outgoing

not applicable 10

vpn_name

The configured maximum number of outgoing connections using the REST protocol.

vpn.connections_service_amqp

not applicable

10

vpn_name

The current number of AMQP connections.

vpn.max_connections_service_amqp

not applicable

10

vpn_name

The configured maximum number of AMQP connections.

vpn.stats.login_msgs_received

not applicable

10

vpn_name

The number of client logins for the Message VPN.

vpn.stats.login_msgs_sent

not applicable

10

vpn_name

The number of client login acknowledgements for the Message VPN.

vpn.stats.total_client_messages_received

not applicable

10

vpn_name

The sum of data and control messages received.

vpn.stats.total_client_messages_sent

not applicable

10

vpn_name

The sum of data and control messages sent.

vpn.stats.client_data_messages_received

not applicable

10

vpn_name

The sum of data messages received.

vpn.stats.client_data_messages_sent

not applicable

10

vpn_name

The sum of data messages received.

vpn.stats.client_control_messages_received

not applicable

10

vpn_name

The sum of control messages received.

vpn.stats.client_control_messages_sent

not applicable

10

vpn_name

The sum of control messages sent.

vpn.stats.client_persistent_messages_received

not applicable

10

vpn_name

The sum of persistent messages received.

vpn.stats.client_persistent_messages_sent

not applicable

10

vpn_name

The sum of persistent messages sent.

vpn.stats.client_non_persistent_messages_received

not applicable

10

vpn_name

The sum of non-persistent messages received.

vpn.stats.client_non_persistent_messages_sent

not applicable

10

vpn_name

The sum of non-persistent messages sent.

vpn.stats.client_direct_messages_received

not applicable

10

vpn_name

The sum of direct messages received.

vpn.stats.client_direct_messages_sent

messages/second

10

vpn_name

The sum of direct messages sent.

vpn.stats.current_ingress_rate_per_second

messages/second

10

vpn_name

The number of incoming messages per second for the Message VPN.

vpn.stats.current_egress_rate_per_second

messages/second

10

vpn_name

The number of outgoing messages per second for the Message VPN.

vpn.stats.average_ingress_rate_per_minute

messages/second

10

vpn_name

The average of incoming messages per second sampled at 60 seconds for the Message VPN.

vpn.stats.average_egress_rate_per_minute

messages/second

10

vpn_name

The average of outgoing messages per second sampled at 60 seconds for the Message VPN.

vpn.stats.current_ingress_byte_rate_per_second

messages/second

10

vpn_name

The average of incoming bytes per second for the Message VPN.

vpn.stats.current_egress_byte_rate_per_second

messages/second

10

vpn_name

The average of outgoing bytes per second for the Message VPN.

vpn.stats.average_ingress_byte_rate_per_minute

messages/second

10

vpn_name

The average of incoming bytes per second sampled at 60 seconds for the Message VPN.

vpn.stats.average_egress_byte_rate_per_minute

messages/second

10

vpn_name

The average of outgoing bytes per second sampled at 60 seconds for the Message VPN.

vpn.stats.total_client_bytes_sent

bytes

10

vpn_name

The total bytes sent for data and control messages.

vpn.stats.client_data_bytes_sent

bytes

10

vpn_name

The total bytes sent for data messages.

vpn.stats.client_persistent_bytes_sent

bytes

10

vpn_name

The total bytes sent for persistent messages.

vpn.stats.client_non_persistent_bytes_sent

bytes

10

vpn_name

The total bytes sent for non-persistent messages.

vpn.stats.client_direct_bytes_sent

bytes

10

vpn_name

The total bytes sent for direct messages.

vpn.stats.client_control_bytes_sent

bytes

10

vpn_name

The total bytes sent for control messages.

vpn.stats.total_client_bytes_received

bytes

10

vpn_name

The total bytes received for data and control messages.

vpn.stats.client_data_bytes_received

bytes

10

vpn_name

The total bytes received for data messages

vpn.stats.client_persistent_bytes_received

bytes

10

vpn_name

The total bytes received for persistent messages

vpn.stats.client_non_persistent_bytes_received

bytes

10

vpn_name

The total bytes received for non-persistent messages

vpn.stats.client_direct_bytes_received

bytes

10

vpn_name

The total bytes received for direct messages

vpn.stats.client_control_bytes_received

bytes

10

vpn_name

The total bytes received for control messages

vpn.stats.zip_stats.current_ingress_compressed_rate_per_second

messages/second

10

vpn_name

The incoming compressed messages per second.

vpn.stats.zip_stats.current_egress_compressed_rate_per_second

messages/second

10

vpn_name

The outgoing compressed messages per second.

vpn.stats.zip_stats.current_ingress_uncompressed_rate_per_second

messages/second

10

vpn_name

The incoming uncompressed messages per second.

vpn.stats.zip_stats.current_egress_uncompressed_rate_per_second

messages/second

10

vpn_name

The outgoing uncompressed messages per second.

vpn.stats.ssl_stats.current_ingress_ssl_rate_per_second

messages/second

10

vpn_name

The incoming encrypted messages per second using the SSL protocol.

vpn.stats.ssl_stats.current_egress_ssl_rate_per_second

messages/second

10

vpn_name

The outgoing encrypted messages per second using the SSL protocol.

vpn.stats.ssl_stats.ingress_ssl_bytes

bytes

10

vpn_name

The incoming encrypted messages using the SSL protocol, measured in bytes.

vpn.stats.ssl_stats.egress_ssl_bytes

bytes

10

vpn_name

The outgoing encrypted messages using the SSL protocol, measured in bytes.

vpn.stats.ssl_stats.average_ingress_ssl_rate_per_minute

bytes/minute

10

vpn_name

The average incoming encrypted messages using the SSL protocol, measured in bytes and sampled at 60 seconds.

vpn.stats.ssl_stats.average_egress_ssl_rate_per_minute

bytes/minute

10

vpn_name

The average outgoing encrypted messages using the SSL protocol, measured in bytes and sampled at 60 seconds.

vpn.stats.ingress_discards.total_ingress_discards

not applicable

10

vpn_name

The total incoming message discards for the Message VPN.

vpn.stats.ingress_discards.no_subscription_match

not applicable

10

vpn_name

The incoming message discards with no subscription match for the Message VPN.

vpn.stats.ingress_discards.topic_parse_error

not applicable

10

vpn_name

The incoming message discards with topic-parse errors for the Message VPN.

vpn.stats.ingress_discards.parse_error

not applicable

10

vpn_name

The incoming message discards with parse error for the Message VPN.

vpn.stats.ingress_discards.msg_too_big

not applicable

10

vpn_name

The incoming guaranteed message discards without acknowledgment because the message exceeds the maximum configured size for guaranteed messages on the event broker.

The event broker blocks further publishing of the message by the client application if the client application sent the message using the following API:

  • JS 10.10.0 and later

  • JCSMP 10.14.0 and later

  • JMS 10.14.0 and later

vpn.stats.ingress_discards.ttl_exceeded

not applicable

10

vpn_name

The incoming message discards with a time-to-live (TTL) expiry for the Message VPN.

vpn.stats.ingress_discards.publish_topic_acl

not applicable

10

vpn_name

The incoming message discards due to publisher ACL rules for the Message VPN.

vpn.stats.ingress_discards.message_spool_congestion

not applicable

10

vpn_name

The incoming message discards with Message Spool congestion for the Message VPN.

vpn.stats.ingress_discards.msg_spool_discards

not applicable

10

vpn_name

The incoming message discards with Message Spool discards for the Message VPN.

vpn.stats.egress_discards.total_egress_discards

not applicable

10

vpn_name

The total outgoing message discards for the Message VPN.

vpn.stats.egress_discards.transmit_congestion

not applicable

10

vpn_name

The outgoing message discards due to slow consumers for the Message VPN.

vpn.stats.egress_discards.compression_congestion

not applicable

10

vpn_name

The outgoing message discards due to compression congestion for the Message VPN.

vpn.stats.egress_discards.message_elided

not applicable

10

vpn_name

The outgoing message discards due to message eliding for the Message VPN.

vpn.stats.egress_discards.ttl_exceeded

not applicable

10

vpn_name

The outgoing message discards due to message time-to-live (TTL) expiry for the Message VPN.

vpn.stats.egress_discards.client_not_connected

not applicable

10

vpn_name

The outgoing message discards due to disconnected consumers for the Message VPN.

vpn.stats.egress_discards.msg_spool_egress_discards

not applicable

10

vpn_name

The total outgoing message discards for all persistent message discards for the Message VPN.

Message VPN Message Spool Statistics

Metric
Name
Unit (If Applicable) Polling
Frequency
in Seconds
In Addition to
Common Tags,
Other Tags to Use
Description

message_vpn.vpn.current_queues_and_topic_endpoints

not applicable

10

vpn_name

The number of queues and topic endpoints on the Message VPN.

message_vpn.vpn.maximum_queues_and_topic_endpoints

not applicable

10

vpn_name

The maximum number of queues and topic endpoints permitted on the Message VPN.

message_vpn.vpn.num_queues

not applicable

10

vpn_name

The total number of queues on the Message VPN.

message_vpn.vpn.num_topic_endpoints

not applicable

10

vpn_name

The total number of topic endpoints on the Message VPN.

message_vpn.vpn.current_messages_spooled

not applicable

10

vpn_name

The current number of messages that are spooled for the Message VPN.

message_vpn.vpn.current_spool_usage_mb

MB

10

vpn_name

The current size (MB) of all messages that are spooled for the Message VPN.

message_vpn.vpn.maximum_spool_usage_mb

MB

10

vpn_name

The maximum storage (MB) permitted for the Message VPN.

message_vpn.vpn.current_transacted_sessions

not applicable

10

vpn_name

The current number of transactional sessions (connections) in use on the Message VPN.

message_vpn.vpn.maximum_transacted_sessions

not applicable

10

vpn_name

The maximum number of transactional sessions (connections) permitted on the Message VPN.

message_vpn.vpn.transacted_sessions_local_used

not applicable

10

vpn_name

The current number of local-transactional sessions (connections) in use on the Message VPN.

message_vpn.vpn.transacted_sessions_xa_used

not applicable

10

vpn_name

The current number of XA-transactional sessions (connections) in use on the VPN.

message_vpn.vpn.current_transactions

not applicable

10

vpn_name

The current number of open transactions on the Message VPN.

message_vpn.vpn.maximum_transactions

not applicable

10

vpn_name

The maximum number of open transactions permitted on the Message VPN.

message_vpn.vpn.transactions_local_used

not applicable

10

vpn_name

The current number of open local transactions on the Message VPN.

message_vpn.vpn.transactions_xa_used

not applicable

10

vpn_name

The current number of open XA transactions on the Message VPN.

message_vpn.vpn.current_egress_flows

not applicable

10

vpn_name

The current number of outgoing consumer flows for the Message VPN.

message_vpn.vpn.maximum_egress_flows

not applicable

10

vpn_name

The maximum number of outgoing consumer flows permitted for the Message VPN.

message_vpn.vpn.current_ingress_flows

not applicable

10

vpn_name

The current number of incoming publisher flows for the Message VPN.

message_vpn.vpn.maximum_ingress_flows

not applicable

10

vpn_name

The maximum number of incoming publisher flows permitted for the Message VPN.

message_spool.message_vpn.vpn.queues.unbound_and_enabled_with_messages

not applicable

10

vpn_name

The number of queues on a Message VPN that are unbound and have messages in the queue. This metric is derived.

derived_metrics.vpn.vpn_enabled

not applicable 10

vpn_name

Indicates whether the message VPN is enabled or disabled:

  • 1—Enabled
  • 0—Disabled

This metric is derived.

derived_metrics.vpn.vpn_state

not applicable 10

vpn_name

Indicates the state of the message VPN:

  • 1—Up
  • 0—Down

This metric is derived.

derived_metrics.vpn_resource_utilization.total_clients_connected_utilization_percentage

percentage

10

vpn_name

The percentage of Message VPN connections in use. This metric is derived.

derived_metrics.vpn_resource_utilization.total_clients_connected_service_smf_utilization_percentage

percentage

10

vpn_name

The percentage of SMF connections in use. This metric is derived.

derived_metrics.vpn_resource_utilization.total_clients_connected_service_web_utilization_percentage

percentage

10

vpn_name

The percentage of Web Messaging connections in use. This metric is derived.

derived_metrics.vpn_resource_utilization.total_clients_connected_service_rest_incoming_utilization_percentage

percentage

10

vpn_name

The percentage of incoming REST connections in use. This metric is derived.

derived_metrics.vpn_resource_utilization.total_clients_connected_service_rest_outgoing_utilization_percentage

percentage

10

vpn_name

The percentage of outgoing REST connections in use. This metric is derived.

derived_metrics.vpn_resource_utilization.total_clients_connected_service_mqtt_utilization_percentage

percentage

10

vpn_name

The percentage of MQTT connections in use. This metric is derived.

derived_metrics.vpn_resource_utilization.total_clients_connected_service_amqp_utilization_percentage

percentage

10

vpn_name

The percentage of AMQP connections in use. This metric is derived.

derived_metrics.vpn_resource_utilization.total_subscription_utilization_percentage

percentage

10

vpn_name

The percentage of total unique subscriptions in use. This metric is derived.

Message VPN Replication Statistics

Metric
Name
Unit (If Applicable) Polling
Frequency
in Seconds
In Addition to
Common Tags,
Other Tags to Use
Description

derived_metrics.vpn.replication_state

not applicable 10  

Produces the following values based on message VPN replication state:

  • 1 — replication is enabled with the Active replication state.
  • 0 — replication is enabled with the Standby replication state.
  • -1 — replication is off.

This metric is derived.

derived_metrics.vpn.replication_status

not applicable 10

 

Replicated message Message VPNs are enabled, bridges are connected, and have a bound queue. This metric is derived. For more information, see Data Center Replication for Disaster Recovery.

derived_metrics.vpn.replication_sync_eligible.downgrade

not applicable

10

 

Message VPN replication has degraded and is now asynchronous. This metric is derived. For more information, see Data Center Replication for Disaster Recovery.

derived_metrics.vpn.replication_sync_eligible.reject

not applicable

10

 

Message VPN replication has degraded and synchronous messages and transactions are being rejected. This metric is derived. For more information, see Data Center Replication for Disaster Recovery.

replication.message_vpns.message_vpn.stats.active_stats.message_processing.async_msgs_queued_to_standby not applicable 10

vpn_name

The number of messages queued to the standby broker using asynchronous replication. This metric is collected.
replication.message_vpns.message_vpn.stats.active_stats.message_processing.sync_msgs_queued_to_standby_as_async not applicable 10

vpn_name

The number of messages that were eligible for synchronous replication but were queued to the standby broker as asynchronous messages. This metric is collected.

Multi-Node Routing Statistics

Metric
Name
Unit (If Applicable) Polling
Frequency
in Seconds
In Addition to
Common Tags,
Other Tags to Use
Description

neighbor.neighbors.neighbor.stats.current_message_rate_messages_per_second.data_rate.ingress

messages/second

10

neighbor_name

The rate of incoming messages per second over the Multi-Node Routing (MNR) link.

neighbor.neighbors.neighbor.stats.current_message_rate_messages_per_second.data_rate.egress

messages/second

10

neighbor_name

The rate of outgoing message per second over an MNR link.

neighbor.neighbors.neighbor.stats.ingress_discards.total_ingress_discards

not applicable

10

neighbor_name

The number of incoming message discards for an MNR link.

neighbor.neighbors.neighbor.stats.egress_discards.total_egress_discards

not applicable

10

neighbor_name

The number of outgoing message discards for an MNR link.

derived_metrics.mnr.neighbor.status

not applicable

10

neighbor_name

The status of the Multi-Node Routing (MNR) neighbor is healthy. This metric is derived.

neighbor.neighbors.neighbor.connections.connection.round_trip_time_smooth_us

microseconds (µs)

10

neighbor_name

Round-trip time in microseconds (µs) for the MNR connection.

neighbor.neighbors.neighbor.connections.connection.blocked_cycles_percent

not applicable 10

neighbor_name

Percentage of time the MNR connection is blocked due to back pressure and cannot publish messages.

Appliance Event Broker and Software Event Broker Specific Metrics

The following metrics are for Insights with self-managed appliance and software event brokers. They are not available for event broker services in Solace Cloud.

neighbor.neighbors.neighbor.stats.messages_counts.data_messages.received

messages

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of data messages received from an MNR neighbor.

neighbor.neighbors.neighbor.stats.messages_counts.data_messages.sent

messages

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of data messages sent to an MNR neighbor.

neighbor.neighbors.neighbor.stats.bytes_counts.data_bytes.received

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of data bytes received from an MNR neighbor.

neighbor.neighbors.neighbor.stats.bytes_counts.data_bytes.sent

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of data bytes sent to an MNR neighbor.

neighbor.neighbors.neighbor.stats.compressed_bytes_counts.data_bytes.received

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of compressed data bytes received from an MNR neighbor.

neighbor.neighbors.neighbor.stats.compressed_bytes_counts.data_bytes.sent

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of compressed data bytes sent to an MNR neighbor.

neighbor.neighbors.neighbor.stats.current_bytes_rate_bytes_per_second.data_rate.ingress

bytes/second

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The rate of incoming data bytes per second over the MNR link.

neighbor.neighbors.neighbor.stats.current_bytes_rate_bytes_per_second.data_rate.egress

bytes/second

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The rate of outgoing data bytes per second over the MNR link.

neighbor.neighbors.neighbor.stats.compression_decompression_stats.compressed_bytes_counts.data_bytes.received

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of compressed data bytes received from an MNR neighbor (compression/decompression statistics).

neighbor.neighbors.neighbor.stats.compression_decompression_stats.compressed_bytes_counts.data_bytes.sent

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The total number of compressed data bytes sent to an MNR neighbor (compression/decompression statistics).

neighbor.neighbors.neighbor.stats.compression_decompression_stats.compression_ratios.data_bytes.received

ratio

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The compression ratio for data bytes received from an MNR neighbor.

neighbor.neighbors.neighbor.stats.compression_decompression_stats.compression_ratios.data_bytes.sent

ratio

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The compression ratio for data bytes sent to an MNR neighbor.

neighbor.neighbors.neighbor.stats.egress_discards.data_transmit_congestion

messages

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The number of outgoing data messages discarded due to transmit congestion on an MNR link.

neighbor.neighbors.neighbor.stats.egress_discards.data_compression_transmit_congestion

messages

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The number of outgoing compressed data messages discarded due to transmit congestion on an MNR link.

neighbor.neighbors.neighbor.stats.egress_discards.ttl_exceeded

messages

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The number of outgoing messages discarded because the Time-To-Live (TTL) was exceeded on an MNR link.

neighbor.neighbors.neighbor.connections.connection.receive_queue_bytes

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The number of bytes in the receive queue for an MNR neighbor connection.

neighbor.neighbors.neighbor.connections.connection.send_queue_bytes

bytes

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The number of bytes in the send queue for an MNR neighbor connection.

neighbor.neighbors.neighbor.connections.connection.fast_retransmits

count

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The number of fast retransmits on an MNR neighbor connection.

neighbor.neighbors.neighbor.connections.connection.timed_retransmits

count

10

neighbor_name

connect_via

This metric applies to appliance event brokers and software event brokers only.

The number of timed retransmits on an MNR neighbor connection.