Insights Metrics: P-R

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

This page contains metrics and statistics for:

Partitioned Queue Statistics

Metric
Name		 Unit (If Applicable) Polling
Frequency
in Seconds		 In Addition to
Common Tags,
Other Tags to Use 		Description
queues.queue.info.partition_count not applicable 30

vpn_name

queue_name

partitioned_queue: true

The number of configured partitions for a queue. An administrator sets the number of partitions when creating or modifying a queue. For more information, see Partitioned Queues.
queues.queue.info.partition_oper_count not applicable 30

vpn_name

queue_name

partitioned_queue: true

The average number of partitions currently allocated and operational for a queue.

The number of allocated and operational partitions for a queue can vary from the configured partition count (as shown by the queues.queue.info.partition_count metric above) due to the scaling process that occurs after configuring partition changes for a queue. The scaling process can have the following states:

  • Ready—The operational count should match the configured count.

  • ScalingUp—The operational count should be less than the configured count.

  • ScalingDown—The operational count should be greater than the configured count.

Configuring changes to the partition count of a queue triggers the rebalancing process, which can take time to complete.

queues.queue.info.partition_rebalance_status not applicable 30

vpn_name

queue_name

partitioned_queue: true

Indicates the rebalancing status for the partitions of a partitioned queue. This metric can return the following states:

  • 1—Ready—No rebalancing activity has been triggered for the partitioned queue.

  • 2—Holddown—The partition queue requires rebalancing, which will begin after the configured delay.

  • 3—Rebalancing—The rebalancing logic is adjusting the partition-to-flow mappings for the partition queue.

For more information, see Partition Rebalancing.
queues.queue.info.partition_scale_status not applicable 30

vpn_name

queue_name

partitioned_queue: true

Indicates when a partitioned queue scales up its partitions. This metric can return the following states:

  • 1—Ready—The partitioned queue has the expected number of partitions.

  • 2—ScalingUp—The partitioned queue requires more partitions and is scaling the partition count up.

  • 3—ScalingDown—The partitioned queue has too many partitions and is scaling the partition count down.

  • -1—Returned by queues with partition states that can't be mapped. For example, exclusive queues that can't be partitioned would return a -1.

For more information, see Partition Scaling.

Redundancy Statistics (for High-Availability)

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

derived_metrics.redundancy.up_or_disabled

not applicable 10  

A value of 1 when the redundancy status is up or is shutdown, otherwise 0.

derived_metrics.redundancy.primary_is_local_active

not applicable 10  

A value of 1 when the primary event broker is local active, otherwise 0. This metric is derived.

derived_metrics.redundancy.backup_is_local_active

not applicable 10  

A value of 1 when the backup event broker is local active, otherwise 0. This metric is derived.

derived_metrics.redundancy.is_local_active

not applicable 10  

A value of 1 when either the primary or backup event broker is active, otherwise 0.

derived_metrics.redundancy.is_service_active

not applicable 10  

A value of 1 when redundancy is shutdown or when either the primary or backup event broker is local active or mate active.

derived-metrics.redundancy.adb_links_status

not applicable 10  

A value of 1 when redundancy or the message spool is shutdown or if the ADB link status is up.

derived-metrics.message_spool_service_status

not applicable 10  

 

A value of1 when one of the High-Availability (HA) broker’s message spool is shutdown, or is enabled and currently active.

derived-metrics.message_spool_standby_status

not applicable 10  

A value of 1 when the standby broker’s message spool status is in AD-Standby and capable of taking activity should the currently active broker fail.

Queue Rate Statistics

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

queues.queue.rates.qendpt_data_rates.current_ingress_byte_rate_per_second

bytes/second

 30

vpn_name

queue_name

The incoming message rate for the queue endpoint measured in bytes per second.

queues.queue.rates.qendpt_data_rates.current_ingress_rate_per_second

messages/second

 30

vpn_name

queue_name

The incoming message rate for the queue endpoint measured in messages per second.

queues.queue.rates.qendpt_data_rates.current_egress_byte_rate_per_second

bytes/second

 30

vpn_name

queue_name

The outgoing message rate for the queue endpoint measured in bytes per second.

queues.queue.rates.qendpt_data_rates.current_egress_rate_per_second

messages/second

 30

vpn_name

queue_name

The outgoing message rate for the queue endpoint measured in messages per second.

Queue Statistics

These metrics are not collected for the backup site in a Disaster Recovery configuration to avoid alert duplication, unless ACK is disabled for the backup site.

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

queues.queue.info.bind_count

not applicable

 30

vpn_name

queue_name

The number of consumers bound to the queue.

queues.queue.info.num_messages_spooled

not applicable

 30

vpn_name

queue_name

The number of messages spooled.

queues.queue.info.current_spool_usage_in_mb

MB

 30

vpn_name

queue_name

The size (MB) of all messages currently spooled.

derived_metrics.queue_resource_utilization.spool_utilization_percentage

percentage

 30

vpn_name

queue_name

The percentage of the Message Spool disk space in use. This metric is derived.

derived_metrics.queues.unbound_and_enabled_with_messages

not applicable

 30

vpn_name

queue_name

This metric returns the number of messages spooled on a queue with no clients consuming from the queue.

queues.queue.replay_state.replay_state

not applicable

 30

vpn_name

queue_name

The replay state of a queue. The possible replay states are:

  • -1—N/A—Message replay has never been requested for the endpoint.

  • 0—Failed—A replay has failed and the endpoint is waiting for acknowledgment of the unbind request it sent to the event broker as a failure indication.

  • 1—Initializing—A message replay has been requested and will begin after all live messages have been removed from the endpoint.

  • 2—Active—Message replay is in progress. The endpoint is currently receiving messages from the replay log.

  • 3—Pending Complete—Message replay has reached the end of the replay log but there are still unacknowledged replayed messages on the endpoint. New live messages are being delivered to the endpoint. However, replay can still fail, in which case the unacknowledged replayed messages would be deleted from the endpoint.

  • 4—Complete—The last requested replay has finished and no replay is in progress.

For more information, see Initiating Message Replay.

queues.queue.replay_state.last_replayed_message_sent_time_seconds

 not applicable 30

vpn_name

queue_name

The time of day when the queue replayed the last message in a replay session.

The time is measured in seconds, from the start of the last message being replayed.

If this metric's value is not available, the information won't be visible in the Datadog Insights account.

queues.queue.replay_state.last_replay_start_time_seconds

 not applicable 30

vpn_name

queue_name

The time of day that the most recent replay operation was initiated for the queue.

The time is measured in seconds, from the start of the last message being replayed.

If this metric's value is not available, the information won't be visible in the Datadog Insights account.

queues.queue.replay_state.last_replay_complete_time_seconds

 not applicable 30

vpn_name

queue_name

The length of time it took the most recent replay operation to complete for the queue.

The time is measured in seconds, from the start of the last message being replayed.

If this metric's value is not available, the information won't be visible in the Datadog Insights account.

queues.queue.stats.message_spool_stats.replay_stats.replays_initiated

 not applicable 30

vpn_name

queue_name

The number of times that message replay has been initiated for a queue.

queues.queue.stats.message_spool_stats.replay_stats.replays_succeeded

 not applicable 30

vpn_name

queue_name

The number of times that message replay completed successfully for a queue.

queues.queue.stats.message_spool_stats.replay_stats.replays_failed

 not applicable 30

vpn_name

queue_name

The number of times that message replay failed to complete for a queue.

queues.queue.stats.message_spool_stats.replay_stats.replayed_messages_sent

 not applicable 30

vpn_name

queue_name

The count for a queue of messages successfully replayed and sent during a messaging replay operation.

queues.queue.stats.message_spool_stats.replay_stats.replayed_messages_acked

 not applicable 30

vpn_name

queue_name

The count for a queue of replayed messages acknowledged by a receiving client.

Replication Statistics

Metric
Name		 Unit (If Applicable) Polling
Frequency
in Seconds		 In Addition to
Common Tags,
Other Tags to Use 		Description
replication.stats.standby_stats.ack_propagation.ack_prop_msgs_rx not applicable 10  

The number of acknowledgment propagation messages received by the backup site.
replication.stats.standby_stats.ack_propagation.out_of_seq_rx not applicable 10   The number of acknowledgment propagation messages received by the backup site that are out of sequence.
replication.stats.standby_stats.ack_propagation.recon_req_tx not applicable 10   The number of reconcile requests sent by the backup site back to the active site.
replication.stats.standby_stats.transaction_replication.transaction_requests not applicable 10   The total number of transaction requests received by the backup site.
replication.stats.standby_stats.transaction_replication.transaction_requests_fail not applicable 10   The number of transaction requests that failed on the standby site.
replication.stats.standby_stats.transaction_replication.transaction_requests_success not applicable 10   The number of transaction requests successfully processed on the backup site.

REST Delivery Point 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

rest.rest_delivery_points.rest_delivery_point.stats.http_post_request_messages_sent

not applicable

 30

rdp_name

vpn_name

The number of HTTP POST requests sent to the post-request-target (string to use when sending requests) when delivering messages to consumers.

rest.rest_delivery_points.rest_delivery_point.stats.http_post_request_messages_sent_connection_closed

not applicable

 30

rdp_name

vpn_name

The number of closed HTTP connections between the RDP and post-request-target.

rest.rest_delivery_points.rest_delivery_point.stats.http_post_response_messages_received

not applicable

 30

rdp_name

vpn_name

The total number of POST responses received from the post-request-target.

rest.rest_delivery_points.rest_delivery_point.stats.http_post_response_messages_received_successful

not applicable

 30

rdp_name

vpn_name

The number of successful HTTP POST responses received from the post-request-target.

rest.rest_delivery_points.rest_delivery_point.stats.http_post_response_messages_received_error

not applicable

 30

rdp_name

vpn_name

The number of HTTP errors when issuing a POST request to the post-request-target.

derived_metrics.rest_delivery_point.status

not applicable

 30

 

The REST Delivery Point (RDP) endpoint status is healthy. This metric is derived.