Insights Metrics: C

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

This page contains metrics and statistics for:

Cache Instance Statistics

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

cache_instances.cache_instance.remote.status.cpu_utilization

percentage

 10

cache_cluster_name

cache_instance_name

cache_name

vpn_name

The remote cache instance’s CPU utilization percentage.

cache_instances.cache_instance.remote.status.cache_requests_received

 not applicable 10

cache_cluster_name

cache_instance_name

cache_name

vpn_name

The remote cache instance cache lookup requests received from client connections.

cache_instances.cache_instance.remote.status.stats.stat_name_Cached_Topics.current_value

 not applicable 10

cache_cluster_name

cache_instance_name

cache_name

vpn_name

The total number of cached topics (indexes) on the remote cache instance.

cache_instances.cache_instance.remote.status.stats.stat_name_Messages_Cached.current_value

 not applicable 10

cache_cluster_name

cache_instance_name

cache_name

vpn_name

The current number of cached messages on the remote cache instance.

cache_instances.cache_instance.remote.status.stats.stat_name_Messages_Cached_cumulative.current_value

 not applicable 10

cache_cluster_name

cache_instance_name

cache_name

vpn_name

The total number of messages cached by the remote cache instance since the cache was empty.

cache_instances.cache_instance.remote.status.stats.stat_name_Message_Bytes_Cached.current_value

bytes

 10

cache_cluster_name

cache_instance_name

cache_name

vpn_name

The current number of bytes consumed by cached messages on the remote cache instance (measured in bytes).

cache_instances.cache_instance.remote.status.stats.stat_name_Message_Bytes_Cached_cumulative.current_value

bytes

 10

cache_cluster_name

cache_instance_name

cache_name

vpn_name

The current number of bytes consumed by cached messages on the remote cache instance (measured in bytes) since the cache was empty.

derived_metrics.cache_instance.status

 not applicable 10

 

The cache instance status is healthy. This metric is derived.

derived_metrics.cache_instance.lost_message

 not applicable 10

 

The cache instance is reporting a lost-message status. This metric is derived.

derived_metrics.cache_instance_resource_utilization.topic_utilization_percentage

percentage

 10

 

The percentage of topics in use. This metric is derived.

derived_metrics.cache_instance_resource_utilization.memory_utilization_percentage

percentage

 10

 

The percentage of memory in use. This metric is derived.

derived_metrics.cache_instance_resource_utilization.message_memory_utilization_percentage

percentage

 10  

The percentage of cached message bytes in use. This metric is derived.

derived_metrics.cache_instance_resource_utilization.request_queue_utilization_percentage

percentage

 10  

The percentage of queues in use. This metric is derived.

Certificate Expiry Monitoring Statistics

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

service.ssl.server_certificate.days_to_expire.count

not applicable

 60

 

The number of days remaining before the event broker's SSL certificate expires. This metric is derived.

solace_insights_agent.cert_poll_objects_expected

not applicable

 300

cert_type

The number of certificate-bearing configuration wrappers found in the SEMP responses from the event broker. This metric is used in combination with the cert_poll_objects_parsed metric to detect silent metric absence when certificate data stops being reported.

solace_insights_agent.cert_poll_objects_parsed

not applicable

 300

cert_type

The number of certificate content blocks successfully extracted from the SEMP responses of the event broker. If the value for this metric is less than the value of the cert_poll_objects_expected metric, it indicates potential event broker schema drift or certificate content issues.

solace_insights_agent.cert_poll_execute_result_code

not applicable

 300

cert_type, code

The result of the SEMP certificate polling request. The possible values are:

  • ok—indicates SEMP succeeded.

  • error—indicates an event broker error, network failure, or parse failure.

  • parse_error—indicates the event broker returned OK but the response structure was unexpected.

client_certificate_authority.days_to_expire.count

not applicable

 300

ca_name, serial_number, common_name

The number of days remaining before a client authentication CA certificate expires. Client authentication CA certificates are used to validate client certificates during mutual TLS authentication.

domain_certificate_authority.days_to_expire.count

not applicable

 300

ca_name, serial_number, common_name

The number of days remaining before a domain validation CA certificate expires. Domain validation CA certificates are used to validate domain certificates for domain-based authentication.

rdp.ssl.client_certificate.days_to_expire.count

not applicable

 300

rest_consumer_name, rdp_name, vpn_name, serial_number, common_name

The number of days remaining before a REST Delivery Point (RDP) REST consumer client certificate expires. RDP client certificates are used to authenticate connections from the event broker to REST consumer endpoints.

oauth_profile.ssl.client_certificate.days_to_expire.count

not applicable

 300

oauth_profile_name, serial_number, common_name

The number of days remaining before an OAuth profile client certificate expires. OAuth profile certificates are used for client certificate authentication when the event broker authenticates with OAuth providers.

kafka_receiver.ssl.client_certificate.days_to_expire.count

not applicable

 300

vpn_name, kafka_receiver_name, serial_number, common_name

The number of days remaining before a Kafka receiver client certificate expires. Kafka receiver certificates are used for client certificate authentication when the event broker receives messages from Kafka.

kafka_sender.ssl.client_certificate.days_to_expire.count

not applicable

 300

vpn_name, kafka_sender_name, serial_number, common_name

The number of days remaining before a Kafka sender client certificate expires. Kafka sender certificates are used for client certificate authentication when the event broker sends messages to Kafka.

bridge.ssl.server_certificate.days_to_expire.count

not applicable

 300

vpn_name, bridge_name, bridge_type, serial_number, common_name

The number of days remaining before a Message VPN bridge client certificate expires. Bridge client certificates are used for authentication when establishing outbound Message VPN bridge connections to remote event brokers. The bridge_type tag indicates the bridge type: dmr, replication, or static.

Client Statistics

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

client.global.stats.total_clients

 not applicable 10  

The total number of connections on the event broker.

client.global.stats.total_clients_connected

 not applicable 10  

The total number of connected clients.

client.global.stats.total_clients_connected_with_compression

 not applicable 10  

The total number of connected clients connected with compression enabled.

client.global.stats.total_clients_connected_with_ssl

 not applicable 10  

The total number of clients connected using the SSL protocol.

client.global.stats.total_clients_connected_service_smf

 not applicable 10  

The total number of clients connected using the Solace Message Format (SMF) protocol.

client.global.stats.total_clients_connected_service_web

 not applicable 10  

The total number of clients connected using the SSL protocol.

client.global.stats.total_clients_connected_service_rest

 not applicable 10  

The total number of clients connected using REST.

client.global.stats.total_clients_connected_service_mqtt

 not applicable 10  

The total number of clients connected using the MQTT protocol.

client.global.stats.client_data_messages_received

 not applicable 10  

The total number of data messages that were received.

client.global.stats.client_data_messages_sent

 not applicable 10  

The total number of data messages that were sent.

client.global.stats.client_persistent_messages_received

 not applicable 10  

The total number of persistent messages that were received.

client.global.stats.client_persistent_messages_sent

 not applicable 10  

The total number of persistent messages that were sent.

client.global.stats.client_non_persistent_messages_received

 not applicable 10  

The total number of non-persistent messages that were received.

client.global.stats.client_non_persistent_messages_sent

 not applicable 10  

The total number of non-persistent messages that were sent.

client.global.stats.client_direct_messages_received

 not applicable 10  

The total number of direct messages that were received.

client.global.stats.client_direct_messages_sent

 not applicable 10  

The total number of direct messages that were sent.

client.global.stats.client_data_bytes_received

bytes

 10  

The total of client data (bytes) that were received.

client.global.stats.client_persistent_bytes_received

bytes

 10  

The total of client persistent data (bytes) that were received.

client.global.stats.client_non_persistent_bytes_received

bytes

 10  

The total of client non-persistent data (bytes) that were received.

client.global.stats.client_direct_bytes_received

bytes

 10  

The total of client direct data (bytes) that were received.

client.global.stats.client_data_bytes_sent

bytes

 10  

The total of client data (bytes) that were sent.

client.global.stats.client_persistent_bytes_sent

bytes

 10  

The total of client persistent data (bytes) that were sent.

client.global.stats.client_non_persistent_bytes_sent

bytes

 10  

The total of client non-persistent data (bytes) that were sent.

client.global.stats.client_direct_bytes_sent

bytes

 10  

The total of client direct data (bytes) that were sent .

client.global.stats.current_login_req_received_rate_per_second

connections/second

    

The number of client connections per second.

client.global.stats.current_login_rsp_sent_rate_per_second

acknowledgements/second

 10  

The number of client connection acknowledgments per second.

client.global.stats.current_ingress_rate_per_second

messages/second

 10  

The incoming message rate (messages/second).

client.global.stats.current_egress_rate_per_second

messages/second

 10  

The outgoing message rate (messages/second).

client.global.stats.current_ingress_byte_rate_per_second

bytes/second

 10  

The incoming byte rate (bytes/second).

client.global.stats.current_ingress_persistent_rate_per_second

messages/second

 10  

The incoming persistent message rate (messages/second).

client.global.stats.current_ingress_nonpersistent_rate_per_second

messages/second

 10  

The incoming non-persistent message rate (messages/second).

client.global.stats.current_ingress_direct_rate_per_second

messages/second

 10  

The incoming direct message rate (messages/second).

client.global.stats.current_egress_byte_rate_per_second

bytes/second

 10  

The outgoing byte rate (bytes/second).

client.global.stats.current_egress_persistent_rate_per_second

messages/second

 10  

The outgoing persistent message rate (messages/second).

client.global.stats.current_egress_nonpersistent_rate_per_second

messages/second

 10  

The outgoing non-persistent message rate (messages/second).

client.global.stats.current_egress_direct_rate_per_second

messages/second

 10  

The outgoing direct message rate (messages/second).

client.global.stats.zip_stats.current_ingress_compressed_rate_per_second

messages/second

 10  

The incoming compressed message rate (messages/second).

client.global.stats.zip_stats.current_egress_compressed_rate_per_second

messages/second

 10  

The outgoing compressed message rate (messages/second).

client.global.stats.zip_stats.current_ingress_uncompressed_rate_per_second

messages/second

 10  

The incoming uncompressed message rate (messages/second).

client.global.stats.zip_stats.current_egress_uncompressed_rate_per_second

messages/second

 10  

The outgoing uncompressed-message rate (messages/second).

client.global.stats.ssl_stats.current_ingress_ssl_rate_per_second

messages/second

 10  

The incoming encrypted message rate (messages/second).

client.global.stats.ssl_stats.current_egress_ssl_rate_per_second

messages/second

 10  

The outgoing encrypted message rate (messages/second).

client.global.stats.ingress_discards.total_ingress_discards

 not applicable 10  

The total incoming message discards.

client.global.stats.egress_discards.total_egress_discards

 not applicable 10  

The total outgoing message discards.

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.

client.global.stats.current_ingress_persistent_byte_rate_per_second

bytes/second

 10  

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

The rate of incoming persistent message bytes per second across all clients.

client.global.stats.current_egress_persistent_byte_rate_per_second

bytes/second

 10  

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

The rate of outgoing persistent message bytes per second across all clients.

client.global.stats.current_ingress_nonpersistent_byte_rate_per_second

bytes/second

 10  

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

The rate of incoming non-persistent message bytes per second across all clients.

client.global.stats.current_egress_nonpersistent_byte_rate_per_second

bytes/second

 10  

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

The rate of outgoing non-persistent message bytes per second across all clients.

client.global.stats.current_ingress_direct_byte_rate_per_second

bytes/second

 10  

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

The rate of incoming direct message bytes per second across all clients.

client.global.stats.current_egress_direct_byte_rate_per_second

bytes/second

 10  

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

The rate of outgoing direct message bytes per second across all clients.

client.global.stats.zip_stats.ingress_compressed_bytes

bytes

 10  

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

The total number of compressed bytes received from all clients.

client.global.stats.zip_stats.egress_compressed_bytes

bytes

 10  

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

The total number of compressed bytes sent to all clients.

client.global.stats.zip_stats.ingress_uncompressed_bytes

bytes

 10  

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

The total number of uncompressed bytes received from all clients.

client.global.stats.zip_stats.egress_uncompressed_bytes

bytes

 10  

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

The total number of uncompressed bytes sent to all clients.

client.global.stats.zip_stats.ingress_compression_ratio

ratio

 10  

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

The compression ratio for incoming messages across all clients.

client.global.stats.zip_stats.egress_compression_ratio

ratio

 10  

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

The compression ratio for outgoing messages across all clients.

Client Username Statistics

These metrics are not collected for the backup site in a Disaster Recovery configuration to avoid alert duplication.

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

derived_metrics.client_username_resource_utilization.total_clients_utilization_percentage

percentage

 30  

The percentage of client username connections in use. This metric is derived.

derived_metrics.client_username_resource_utilization.total_clients_smf_utilization_percentage

percentage

 30  

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

derived_metrics.client_username_resource_utilization.total_clients_web_utilization_percentage

percentage

 30  

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

derived_metrics.client_username_resource_utilization.total_endpoints_utilization_percentage

percentage

 30  

The percentage of client username endpoints in use. This metric is derived.

Config-Sync Statistics

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

derived_metrics.config_sync.up_or_disabled

 not applicable 60  

The operational status of Config-Sync. This metric is derived.