Page Comparison

Adeptia Connect logs messages in console as well as in the log database during the execution of a service (for example, a Process Flow) to help you monitor and troubleshoot the application. Message logging is done at four levels: ERROR, NOTICE, INFO, and DEBUG. The NOTICE log level captures all the notable events in the application including the error messages. For example, the Cluster and Queue Processor component log messages at the NOTICE log level. Adeptia Connect logs startup message for the microservices when they start.

The following sections describe the types of logging, benefits and constraints, format of log messages, logging configuration, and configurable properties.

There are two types of logging that Adeptia Connect supports. 

Anchor
Asynchronous logging Asynchronous logging

Asynchronous logging

By default, Asynchronous logging is enabled in Adeptia Connect.

Click here to get more details. AnchorSynchronous loggingSynchronous loggingSynchronous logging

In Synchronous logging, the application logs the messages as and when there is one to be logged and execution of the service is put on hold until the complete message is written in the log. For example, If there are three error messages generated during a Process Flow execution, the execution proceeds to the next stage only after these three error messages are logged. The same execution thread is used for logging also which leads to a stalled execution of the service for the time while the messages are being logged.

AnchorAsynchronous loggingAsynchronous loggingAsynchronous logging

 In Asynchronous logging, the logging happens in a thread that is separate from the service execution thread. This leads to an uninterrupted execution of the service as it does not need to wait for the logging to be completed. An effective logging mechanism depends on two key factors, low latency and maximum throughput. 

• Latency: Time taken for performing the action and producing the result. 
• Throughput: The number of actions executed per unit of time.

InfoAdeptia recommends that you use asynchronous logging to substantially improve

Asynchronous logging substantially improves the throughput and

lower

lowers the latency in the overall execution of

the service

a service.

The following sections describe the benefits and constraints, format of log messages, logging properties.

Anchor
Benefits and constraints Benefits and constraints

Benefits and constraints of Asynchronous logging

Asynchronous logging benefits a user in terms of achieving lower latency and maximum throughput. 

• Maximum throughput: With an asynchronous logger, it can log messages at a higher rate in comparison to synchronous logger.
• Lower latency: As the logging occurs in a separate thread, it significantly lowers the latency to the minimum in the overall execution of the service.

Although asynchronous logging can give significant performance benefits, it has the following limitations to take into account:

• In case of an abrupt shutdown which is a rare scenario, the log messages get are lost if they are present in the async Asynchronous queue and have not been already logged.
  

  Info
  In case of graceful shutdown, Adeptia Connect implements a shutdown hook to ensure that all logs in the queue are logged before bringing the application down.

  
  

• In case of a vast number of messages to be logged, the log may display the messages with a delay or after the execution of the service.

Anchor
Format of log messages Format of log messages

Format of log messages

The actual message in the log is accompanied by several other useful information. All the information in the logs is stored in key-value pair format. Storing the information in key-value pair format in the logs has its advantage – the mapped key-value pattern proves to be useful as it tells you what is the meaning of each field that is being printed on the console or file and the log database.

The following example gives you an idea about the log message format:

2020-03-17 12:52:48,785 INFO [Adeptia Connect 3.2 Kernel Thread] system com system com.adeptia.indigo.event.QuartzEventFactory.activateAutoCleanupService(QuartzEventFactory.java:636)

- category category="initializeEvent" groupId="administrators" message="DEFAULT.autoCleanup will run at: Sat May 23 03:00:00 UTC 2020" nodeName="10.0.0.72" userId="admin"

Anchor

properties

properties

Logging

properties

Logging parameters properties are pre-configured in the application. However, if you want to update the configuration parameters, you can follow the steps below to navigate to the Asynchronous logging properties window and update the properties:

Navigate to Systems > Asynchronous Logging.

Image Removed

If required, you can configure the logger properties in server-configure.properties file. Follow the steps below to perform this action:

The following table contains the list of configurable properties:

Restart the Connect Server.

Configuring SMTP and Windows NTEvent Appender 

In case you have been using SMTP and Windows NTEvent Appender for message logging in the previous version, you need to configure these two Appenders in this version of Adeptia Connect.

• SMTP Appender
• Windows NTEvent Appender

If you want the log messages to be delivered to your email, you need to configure the SMTP Appender and update its properties as explained below:

The following table contains the list of configurable properties:

If you want the log messages to be recorded in the Event Viewer, you need to configure the Windows NTEvent Log Appender and update its properties as explained below:

On the left pane. expand Windows  Logs and then select Application to take a look at the log messages. 

for Adeptia Connect microservices. However, you can configure them based on your requirement. For a complete list of logging properties related to different microservices, refer to the application properties page.