Boomi Atom Message Queue Service Status Test

Boomi Atom Message Queue (AMQ) Service is a feature within Dell Boomi's integration platform designed to provide asynchronous messaging between different components of your integration processes. It allows for better management of communication and data flow between systems, especially when dealing with large volumes of data or systems that need to work in an asynchronous manner. The Message Queue Service in Boomi Platform provides the following functionalities:

• View the messages in a message queue.

• View a message queue’s dead letters.

• Resend all or selected dead letters to the associated message queue.

• Clear all or selected messages from a message queue.

• Clear all or selected dead letters from a dead letter queue.

• Delete selected enqueued messages or dead letters

• Delete a selected message queue.

This test reports the health status of the queue summarizing the total count of queues, disk usage by the queues, and the count of queues with dead letter messages. If a message consistently fails and is sent to the Dead Letter Queue (DLQ), the target system may remain in an inconsistent state because the expected data has not been processed. This could lead to gaps in data or partial updates, which might affect downstream applications, reporting, or business processes. This is where this test helps the administrators to monitor the abnormal count of dead letter queues.

Target of the test : Boomi AtomSphere

Agent deploying the test : An internal agent

Outputs of the test : One set of results for the Boomi AtomSphere being monitored.

Configurable parameters for the test

Parameter	Description
Test period	How often should the test be executed
Host	The host for which the test is to be configured.
Port	The port number at which the specified host listens to. The default value is NULL.
JMX Remote Port	This parameter appears only if the mode is set to JMX. Here, specify the port at which the JMX listens for requests from remote hosts. Ensure that you specify the same port that you configured in the management.properties file in the <JAVA_HOME>\jre\lib\management folder used by the target application . To know more, refer to Enabling JMX Support for JREtopic in Monitoring Java Application document.
JNDI Name	This parameter appears only if the mode is set to JMX. The JNDIname is a lookup name for connecting to the JMX connector. By default, this is jmxrmi. If you have resgistered the JMX connector in the RMI registery using a different lookup name, then you can change this default value to reflect the same.
JMX User, JMX Password, and Confirm password	These parameters appear only if the Mode is set to JMX. If JMX requires authentication only (but no security), then ensure that the user and password parameters are configured with the credentials of a user with read-write access to JMX. To know how to create this user, refer to Configuring the eG Agent to Support JMX Authenticationtopic in Monitoring Java Application document. Confirm the password by retyping it in the Confirm Password text box.
Provider	This parameter appears only if the Mode is set to JMX. This test uses a JMX Provider to access the MBean attributes of the target Java application and collect metrics. Specify the package name of this JMX Provider here. By default, this is set to com.sun.jmx.remote.protocol.
Boomi Platform Base URL	Specify the URL - https://api.boomi.com/ that is used towards user registration for accessing the Boomi console.
Account ID	Specify the user Account ID that is auto-generated while registering the user in Boomi console. To know more, refer to Creating a new user and assigning user role in Boomi console topic in How does eG Enterprise Monitor Boomi AtomSphere? chapter.
Boomi User Account	Specify the email ID of the user in the Boomi User Account text box that is used towards user registration for accessing the Boomi console. To know more, refer to Creating a new user and assigning user role in Boomi console topic in How does eG Enterprise Monitor Boomi AtomSphere? chapter.
API Token	Specify the API token value that was generated using the Boomi console. To know how to generate the API token in Boomi console, refer to Creating a new API token in Boomi console in How does eG Enterprise Monitor Boomi Service?chapter.
Timeout	Specify the duration (in seconds) for which this test should wait for a response from Boomi AtomSphere. The default value is 120.
DD Frequency	Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test

Measurement	Description	Measurement Unit	Interpretation
Status	Indicates the running status of the Message Queues.		The values reported by this measure and its numeric equivalents are mentioned in the table below: Measure Value Numeric Value Stopped 0 Stopping 1 Paused for stop 70 Pausing for stop 75 Paused 80 Pausing 85 Init_updating 90 Initializing 95 Running 100 Note: By default, this measure reports the Measure Values listed in the table above to indicate the running status of the Message Queues. However, in the graph of this measure, values will be represented using the corresponding numeric equivalents only - i.e., 0 to 100. The detailed diagnosis of this measure lists the Account IDs which are problematic.
Health status	Indicates the health status of the Message Queues.		The values reported by this measure and its numeric equivalents are mentioned in the table below: Measure Value Numeric Value Getting Worried 0 Good 1 Note: By default, this measure reports the Measure Values listed in the table above to indicate the health status of the Message Queues. However, in the graph of this measure, states will be represented using the corresponding numeric equivalents only - i.e., 0 and 1. The detailed diagnosis of this measure lists the health status of the message queue.
Total dead letter messages	Indicates the total number of dead letter messages.	Number	In Boomi AtomSphere, a Dead Letter Message (DLM) refers to a message or data that could not be processed successfully by an integration process due to an error or failure. Ideally, the value of these measures should be low.
Queues with dead letter messages	Indicates the number of queues with dead letter messages.	Number
Queue count	Indicates the total number of queues.	Number
Maximum disk usage	Indicates the disk space utilized by the queue.	GB
Maximum thread number	Indicates the number of threads utilized by the queue.	Number
Maximum memory allocated	Indicates the maximum size of memory space allocated to the queue.	Percent
Maximum memory allocated to queue	Indicates the maximum percentage of memory space allocated to the queue.	Percent
Message store disk usage	Indicates the percentage of disk space utilized for storing the messages.	Percent
Temporary store disk usage	Indicates the percentage of disk space utilized for storing the messages temporarily.	Percent
Job scheduler store disk usage	Indicates the percentage of disk space utilized for job scheduling.	Percent
Memory usage	Indicates the percentage of memory utilized by the queue.	Percent	A low measure value is required.