Boomi Events Test

In Boomi AtomSphere, an event typically refers to a significant trigger within the Boomi platform that is used to monitor, manage, or respond to integration processes. When an error occurs during the execution of a process, an event is logged. This type of event captures issues like data validation failures, connection issues, or any system-level failures. This test reports the events generated by the target Boomi AtomSphere and helps administrators to minimize those errors .

Target of the test : Boomi AtomSphere

Agent deploying the test : An internal agent

Outputs of the test : One set of results for each Event typein the target 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.

Include Event Level

Specify the event levels in the Include Event Level text box. For example, the event levels include event information, errors or warnings. Provide comma separated values if there are more than one event type.

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

Error documents

Indicates the number of documents processed with errors for this event.

Number

A document is a fundamental unit of data that is processed through an integration process in Boomi AtomSphere. When an integration process encounters an issue, the document that causes the error is not processed in the usual way. Instead, it is converted into an error document, which contains information about the failure, such as error details, error codes, and the reason for the failure.

The detailed diagnosis of this measure lists the Boomi event details that includes Event ID, Status, Error Document Count, Inbound Document Count, Outbound Document Count, Event date, Event level, Event type, Error, Error type, Errored step label, Errored step type, Execution id, Process name, and Record date for the documents processed with errors.

Inbound documents

Indicates the number of documents processed using inbound connectors for this event.

Number

An inbound document refers to a document that is received by the Boomi integration platform from an external source or system. It is the data that enters the Boomi platform, triggering an integration process or workflow. This document can come in various formats such as a file, an API message, or a database record.

Each inbound document triggers an integration process. If there is a surge in the number of inbound documents, the Atom (or Molecule in a clustered setup) may experience increased load, leading to performance issues like slower processing times or higher resource consumption (CPU, memory).

Outbound documents

Indicates the number of documents processed using outbound connectors for this event.

Number

An outbound document refers to a document that is generated by a Boomi process and sent to an external system or destination. It is the data that is received by Boomi from external systems. Outbound documents typically represent the processed, transformed, or routed data that is being exported or transmitted to other systems, applications, or services.

When Boomi AtomSphere is processing a high volume of outbound documents, the Atom (or Molecule in a clustered setup) that handles these tasks will be under increased load. The increased demand on CPU and memory can lead to slower processing times and potential performance bottlenecks.