Welcome!

Java IoT Authors: Elizabeth White, Pat Romanski, Harry Trott, Philippe Abdoulaye, Scott Sobhani

Related Topics: Java IoT, Open Source Cloud, IoT User Interface

Java IoT: Article

Asynchronous Logging Using Spring

Create applications that require high-volume logging without impacting an application’s performance

Each application developer faces the problem of logging usage information. On the one hand, the more logging that's done the easier it is to detect and locate the source of problems. On the other hand, large volume logging might impair an application's performance.

This problem is typically solved by defining various log levels dependent on a program's maturity. For example, a program in developmental stages would have a higher logging requirements; logging requirements would be relatively lower in the production phase. If an application requires a lot of logging for audit purposes, then special measures are required to protect performance.

This article provides a possible solution for this problem by using Spring asynchronous support.

Rationale for High-Volume Logging
Logging is used extensively to help find problems within applications. A developer who finds a problem can investigate it by enabling debug logging. He may then reproduce the problem, or create additional logging if needed. Programmers usually require extensive logging to locate problems.

However, the aforementioned process is not a universal solution. If a developer comes across a one-time event that does not happen again, then he has to uncover and fix the problem using only existing log data. For instance, a security problem should not be resolved by enabling full logging and waiting for another intrusion. Such cases require a lot of logging upfront.

Above and beyond the use of logging for application development, regulatory compliance requirements also demand a minimum amount of logging.

Possible Solutions
The simplest solution would be to log everything synchronously, right inside business logic methods. Of course this solution would reduce processing speed, but if an application does not have strict performance requirements, it might not be a problem.

A developer may also use some existing solutions, such as synchronous logging. Examples include log4j, AsyncAppender, and JMS. The latter is especially useful if none of the logging events should be lost.

Very often logging operations are not very fast because, for reliability purposes, these logs are often written either to a database or to a remote server. In addition, data may be subject to operations before they can be logged.

Consider a simple case when logging is needed, but performance should not be affected.

Please note that threads may not necessarily execute in the same order as they were called, so you'll have to sort the logged events by timestamp in order to have them in chronological order.

Spring 3.0 Asynchronous Support
Overview

Spring 2.0 provided a TaskExecutor abstraction that could be used for running asynchronous tasks. Evolution to version 3.0 enabled annotations to be used for this purpose. Refer to the Task Execution and Scheduling section in the Spring 3.0 documentation.

There are several built-in TaskExecutor implementations, and not all of them are asynchronous. For example, the SyncTaskExecutor invokes a task in the calling thread.

This article will concentrate on the ThreadPoolTaskExecutor - the most commonly used implementation in the Java 5 environment.

The ThreadPoolTaskExecutor provides the following configurable parameters:

pool-size: Defines the size of a pool; it also accepts a "core-max" range. The "core" is the initial number of threads in a pool; the "max" is the maximum number of threads. If only one number is defined, then the core and max are the same size.

Please note that the executor will first use the core number of threads, and then add threads to the pool only when the queue is full.

queue-capacity: Refers to the size of the task queue when all threads are busy. By default the queue is unlimited. That might lead to an OutOfMemory exception and disrupt the application, therefore, a specific queue size should be defined.

rejection-policy: A parameter that determines what should happen if both the thread pool and queue are full. In this case the task is rejected, and then the rejection policy determines what should happen to it.

The following policies are supported:

  • AbortPolicy: Executor will throw a TaskRejectedException
  • DiscardPolicy: Tasks will be skipped
  • DiscardOldestPolicy: Oldest tasks will be skipped
  • CallerRunsPolicy: Task will be executed in caller thread (synchronously)

Spring 3.0 allows bean configuration using both Annotations and XML. We will consider Annotation and XML configuration of TaskExecutors only.

Here is a simple business class that requires logging.

@Service
public class BankOperator {

@Autowired

private BusinessLogger businessLogger;

public void transferMoney() {

//... business logic for transferring money
// writing log
businessLogger.logMoneyTransfer(new Date(), "John", new BigDecimal(100));
}
}

As you can see the businessLogger has a specific method for a specific business operation. Developers always pass the current timestamp and a number of parameters. The timestamp is needed because the logging method will be invoked asynchronously at an arbitrary time in the future. The list of parameters will depend on what kind of logging is done. Usually this kind of logging is saved to a database, so developers need a number of parameters that will be mapped to the fields of the database table.

The maximum possible amount of operations should utilize asynchronous logging.

For example, if logging information depends on an account number, years of service and the balance of a bank account, then it's better to pass these three parameters to a logging method. The logging logic would be implemented, thereby, lessening the influence of logging on execution of the primary service.

XML - configuration
The configuration of ThreadPoolTaskExecutor looks like this:

<bean id="businessLogExecutor" class="org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor">
<property name="corePoolSize" value="1" />
<property name="maxPoolSize" value="1" />
<property name="queueCapacity" value="1" />
<property name="rejectedExecutionHandler" ref="callerRuns" />
</bean>

<bean id="callerRuns" class="java.util.concurrent.ThreadPoolExecutor.CallerRunsPolicy"/>

Spring 3.0 enables developers to use the ‘executor' element to create a ThreadPoolTaskExecutor instance:

<task:executor id="businessLogExecutor"
pool-size="5-25"
queue-capacity="100"
rejection-policy="CALLER_RUNS"/>

The logger class might look like the following:

public class AsyncBusinessLogger implements BusinessLogger {

private TaskExecutor taskExecutor;


public void setTaskExecutor(TaskExecutor taskExecutor) {

this.taskExecutor = taskExecutor;
}

public void logMoneyTransfer(final Date timestamp, final String customerName, final BigDecimal sum) {

taskExecutor.execute(new Runnable() {
public void run() {
System.out.println("Customer '" + customerName + "' transfered $" + sum + " on " + timestamp);
}
});
}
}

A BusinessLogger may resemble the following:

<bean id="businessLogger" class="com.axmor.async.logging.AsyncBusinessLogger">
<property name="taskExecutor" ref="businessLogExecutor" />
</bean>

Using XML configuration is a more flexible approach. A developer can tell many Business Loggers to use the same TaskExecutor, or tell a single Business Logger to use multiple TaskExecutors.

@Async annotation
To use the @Async annotation, turn on task annotation support by including the following in config.xml:

<task:annotation-driven />

In this case, the ThreadPoolTaskExecutor with default settings will be used.

To use the aforementioned executor, insert the following instead:

<task:annotation-driven executor="businessLogExecutor"/>

The logger will look like the following:

@Service
public class AsyncBusinessLogger implements BusinessLogger {

@Async

public void logMoneyTransfer(Date timestamp, String customerName, BigDecimal sum) {
System.out.println("Customer '" + customerName + "' transfered $" + sum + " on " + timestamp);
}
}

The result is simpler and cleaner code. But a less flexible configuration comes at a price: all methods annotated with @Async will use the same TaskExecutor throughout the application.

@Async vs TaskExecutor: when to use
Using the @Async annotation is much simpler than having to wire the task executor to call tasks manually.

Usually the @Async annotation is the preferred method.

In cases where a developer doesn't want to use a single TaskExecutor for all asynchronous operations, which is the case for @Async annotation, he will have to use TaskExecutors.

Conclusion
Developers should strongly consider using asynchronous logging when creating applications that require high-volume logging without impacting an application's performance.

The article shows how easy it is to create your own custom asynchronous logging using Spring 3.0 Async support.

More Stories By Mylnikov Sergey

Mylnikov Sergey is a senior software engineer in the IBM Solution Group at Axmor Software. He has over seven years of experience in software development, as well as strong knowledge in Java SE/EE and web application development. He has been a technical lead and software architect in several successfully completed enterprise projects for US, UK, and Australian customers.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life sett...
There are several IoTs: the Industrial Internet, Consumer Wearables, Wearables and Healthcare, Supply Chains, and the movement toward Smart Grids, Cities, Regions, and Nations. There are competing communications standards every step of the way, a bewildering array of sensors and devices, and an entire world of competing data analytics platforms. To some this appears to be chaos. In this power panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, Bradley Holt, Developer Advocate a...
Cognitive Computing is becoming the foundation for a new generation of solutions that have the potential to transform business. Unlike traditional approaches to building solutions, a cognitive computing approach allows the data to help determine the way applications are designed. This contrasts with conventional software development that begins with defining logic based on the current way a business operates. In her session at 18th Cloud Expo, Judith S. Hurwitz, President and CEO of Hurwitz & ...
In his general session at 18th Cloud Expo, Lee Atchison, Principal Cloud Architect and Advocate at New Relic, discussed cloud as a ‘better data center’ and how it adds new capacity (faster) and improves application availability (redundancy). The cloud is a ‘Dynamic Tool for Dynamic Apps’ and resource allocation is an integral part of your application architecture, so use only the resources you need and allocate /de-allocate resources on the fly.
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, wh...
19th Cloud Expo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy. Meanwhile, 94% of enterpri...
SYS-CON Events announced today that Bsquare has been named “Silver Sponsor” of SYS-CON's @ThingsExpo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. For more than two decades, Bsquare has helped its customers extract business value from a broad array of physical assets by making them intelligent, connecting them, and using the data they generate to optimize business processes.
Internet of @ThingsExpo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devices - comp...
Machine Learning helps make complex systems more efficient. By applying advanced Machine Learning techniques such as Cognitive Fingerprinting, wind project operators can utilize these tools to learn from collected data, detect regular patterns, and optimize their own operations. In his session at 18th Cloud Expo, Stuart Gillen, Director of Business Development at SparkCognition, discussed how research has demonstrated the value of Machine Learning in delivering next generation analytics to imp...
There is little doubt that Big Data solutions will have an increasing role in the Enterprise IT mainstream over time. Big Data at Cloud Expo - to be held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA - has announced its Call for Papers is open. Cloud computing is being adopted in one form or another by 94% of enterprises today. Tens of billions of new devices are being connected to The Internet of Things. And Big Data is driving this bus. An exponential increase is...
The 19th International Cloud Expo has announced that its Call for Papers is open. Cloud Expo, to be held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, brings together Cloud Computing, Big Data, Internet of Things, DevOps, Digital Transformation, Microservices and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding business opportuni...
Cloud computing is being adopted in one form or another by 94% of enterprises today. Tens of billions of new devices are being connected to The Internet of Things. And Big Data is driving this bus. An exponential increase is expected in the amount of information being processed, managed, analyzed, and acted upon by enterprise IT. This amazing is not part of some distant future - it is happening today. One report shows a 650% increase in enterprise data by 2020. Other estimates are even higher....
The cloud market growth today is largely in public clouds. While there is a lot of spend in IT departments in virtualization, these aren’t yet translating into a true “cloud” experience within the enterprise. What is stopping the growth of the “private cloud” market? In his general session at 18th Cloud Expo, Nara Rajagopalan, CEO of Accelerite, explored the challenges in deploying, managing, and getting adoption for a private cloud within an enterprise. What are the key differences between wh...
Internet of @ThingsExpo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with the 19th International Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world and ThingsExpo Silicon Valley Call for Papers is now open.
It is one thing to build single industrial IoT applications, but what will it take to build the Smart Cities and truly society changing applications of the future? The technology won’t be the problem, it will be the number of parties that need to work together and be aligned in their motivation to succeed. In his Day 2 Keynote at @ThingsExpo, Henrik Kenani Dahlgren, Portfolio Marketing Manager at Ericsson, discussed how to plan to cooperate, partner, and form lasting all-star teams to change t...
Connected devices and the industrial internet are growing exponentially every year with Cisco expecting 50 billion devices to be in operation by 2020. In this period of growth, location-based insights are becoming invaluable to many businesses as they adopt new connected technologies. Knowing when and where these devices connect from is critical for a number of scenarios in supply chain management, disaster management, emergency response, M2M, location marketing and more. In his session at @Th...
SYS-CON Events announced today that ReadyTalk, a leading provider of online conferencing and webinar services, has been named Vendor Presentation Sponsor at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. ReadyTalk delivers audio and web conferencing services that inspire collaboration and enable the Future of Work for today’s increasingly digital and mobile workforce. By combining intuitive, innovative tec...
Amazon has gradually rolled out parts of its IoT offerings, but these are just the tip of the iceberg. In addition to optimizing their backend AWS offerings, Amazon is laying the ground work to be a major force in IoT - especially in the connected home and office. In his session at @ThingsExpo, Chris Kocher, founder and managing director of Grey Heron, explained how Amazon is extending its reach to become a major force in IoT by building on its dominant cloud IoT platform, its Dash Button strat...
industrial company for a multi-year contract initially valued at over $4.0 million. In addition to DataV software, Bsquare will also provide comprehensive systems integration, support and maintenance services. DataV leverages advanced data analytics, predictive reasoning, data-driven diagnostics, and automated orchestration of remediation actions in order to improve asset uptime while reducing service and warranty costs.
Vidyo, Inc., has joined the Alliance for Open Media. The Alliance for Open Media is a non-profit organization working to define and develop media technologies that address the need for an open standard for video compression and delivery over the web. As a member of the Alliance, Vidyo will collaborate with industry leaders in pursuit of an open and royalty-free AOMedia Video codec, AV1. Vidyo’s contributions to the organization will bring to bear its long history of expertise in codec technolo...