Click here to close now.

Welcome!

Java Authors: Carmen Gonzalez, Kyle Samani, PagerDuty Blog, Lori MacVittie, Liz McMillan

Related Topics: Java, Open Source, AJAX & REA

Java: 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
Containers and microservices have become topics of intense interest throughout the cloud developer and enterprise IT communities. Accordingly, attendees at the upcoming 16th Cloud Expo at the Javits Center in New York June 9-11 will find fresh new content in a new track called PaaS | Containers & Microservices Containers are not being considered for the first time by the cloud community, but a current era of re-consideration has pushed them to the top of the cloud agenda. With the launch of Docker's initial release in March of 2013, interest was revved up several notches. Then late last...
The WebRTC Summit 2014 New York, to be held June 9-11, 2015, at the Javits Center in New York, NY, announces that its Call for Papers is open. Topics include all aspects of improving IT delivery by eliminating waste through automated business models leveraging cloud technologies. WebRTC Summit is co-located with 16th International Cloud Expo, @ThingsExpo, Big Data Expo, and DevOps Summit.
SOA Software has changed its name to Akana. With roots in Web Services and SOA Governance, Akana has established itself as a leader in API Management and is expanding into cloud integration as an alternative to the traditional heavyweight enterprise service bus (ESB). The company recently announced that it achieved more than 90% year-over-year growth. As Akana, the company now addresses the evolution and diversification of SOA, unifying security, management, and DevOps across SOA, APIs, microservices, and more.
After making a doctor’s appointment via your mobile device, you receive a calendar invite. The day of your appointment, you get a reminder with the doctor’s location and contact information. As you enter the doctor’s exam room, the medical team is equipped with the latest tablet containing your medical history – he or she makes real time updates to your medical file. At the end of your visit, you receive an electronic prescription to your preferred pharmacy and can schedule your next appointment.
GENBAND has announced that SageNet is leveraging the Nuvia platform to deliver Unified Communications as a Service (UCaaS) to its large base of retail and enterprise customers. Nuvia’s cloud-based solution provides SageNet’s customers with a full suite of business communications and collaboration tools. Two large national SageNet retail customers have recently signed up to deploy the Nuvia platform and the company will continue to sell the service to new and existing customers. Nuvia’s capabilities include HD voice, video, multimedia messaging, mobility, conferencing, Web collaboration, deskt...
The Open Compute Project is a collective effort by Facebook and a number of players in the datacenter industry to bring lessons learned from the social media giant's giant IT deployment to the rest of the world. Datacenters account for 3% of global electricity consumption – about the same as all of Switzerland or the Czech Republic -- according to people I met at the recent Open Compute Summit in San Jose. With increasing mobility at the edge of the cloud and vast new dataflows being predicted with the growth of the Internet of Things (and The Coming Age of Many Zettabytes) in the near...
The list of ‘new paradigm’ technologies that now surrounds us appears to be at an all time high. From cloud computing and Big Data analytics to Bring Your Own Device (BYOD) and the Internet of Things (IoT), today we have to deal with what the industry likes to call ‘paradigm shifts’ at every level of IT. This is disruption; of course, we understand that – change is almost always disruptive.
SYS-CON Events announced today that Cisco, the worldwide leader in IT that transforms how people connect, communicate and collaborate, has been named “Gold Sponsor” of SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. Cisco makes amazing things happen by connecting the unconnected. Cisco has shaped the future of the Internet by becoming the worldwide leader in transforming how people connect, communicate and collaborate. Cisco and our partners are building the platform for the Internet of Everything by connecting the...
SYS-CON Media announced today that @WebRTCSummit Blog, the largest WebRTC resource in the world, has been launched. @WebRTCSummit Blog offers top articles, news stories, and blog posts from the world's well-known experts and guarantees better exposure for its authors than any other publication. @WebRTCSummit Blog can be bookmarked ▸ Here @WebRTCSummit conference site can be bookmarked ▸ Here
Temasys has announced senior management additions to its team. Joining are David Holloway as Vice President of Commercial and Nadine Yap as Vice President of Product. Over the past 12 months Temasys has doubled in size as it adds new customers and expands the development of its Skylink platform. Skylink leads the charge to move WebRTC, traditionally seen as a desktop, browser based technology, to become a ubiquitous web communications technology on web and mobile, as well as Internet of Things compatible devices.
SYS-CON Events announced today that robomq.io will exhibit at SYS-CON's @ThingsExpo, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. robomq.io is an interoperable and composable platform that connects any device to any application. It helps systems integrators and the solution providers build new and innovative products and service for industries requiring monitoring or intelligence from devices and sensors.
Docker is an excellent platform for organizations interested in running microservices. It offers portability and consistency between development and production environments, quick provisioning times, and a simple way to isolate services. In his session at DevOps Summit at 16th Cloud Expo, Shannon Williams, co-founder of Rancher Labs, will walk through these and other benefits of using Docker to run microservices, and provide an overview of RancherOS, a minimalist distribution of Linux designed expressly to run Docker. He will also discuss Rancher, an orchestration and service discovery platf...
Sonus Networks introduced the Sonus WebRTC Services Solution, a virtualized Web Real-Time Communications (WebRTC) offer, purpose-built for the Cloud. The WebRTC Services Solution provides signaling from WebRTC-to-WebRTC applications and interworking from WebRTC-to-Session Initiation Protocol (SIP), delivering advanced real-time communications capabilities on mobile applications and on websites, which are accessible via a browser.
SYS-CON Events announced today that Aria Systems, the leading innovator in recurring revenue, has been named “Bronze Sponsor” of SYS-CON's @ThingsExpo, which will take place on June 9–11, 2015, at the Javits Center in New York, NY. Proven by the world’s most demanding enterprises, including AAA NCNU, Constant Contact, Falck, Hootsuite, Pitney Bowes, Telekom Denmark, and VMware, Aria helps enterprises grow their recurring revenue businesses. With Aria’s end-to-end active monetization platform, global brands can get to market faster with a wider variety of products and services, while maximizin...
SYS-CON Events announced today that Vitria Technology, Inc. will exhibit at SYS-CON’s @ThingsExpo, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. Vitria will showcase the company’s new IoT Analytics Platform through live demonstrations at booth #330. Vitria’s IoT Analytics Platform, fully integrated and powered by an operational intelligence engine, enables customers to rapidly build and operationalize advanced analytics to deliver timely business outcomes for use cases across the industrial, enterprise, and consumer segments.
SYS-CON Events announced today that Akana, formerly SOA Software, has been named “Bronze Sponsor” of SYS-CON's 16th International Cloud Expo® New York, which will take place June 9-11, 2015, at the Javits Center in New York City, NY. Akana’s comprehensive suite of API Management, API Security, Integrated SOA Governance, and Cloud Integration solutions helps businesses accelerate digital transformation by securely extending their reach across multiple channels – mobile, cloud and Internet of Things. Akana enables enterprises to share data as APIs, connect and integrate applications, drive part...
SYS-CON Events announced today that Solgenia will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY, and the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. Solgenia is the global market leader in Cloud Collaboration and Cloud Infrastructure software solutions. Designed to “Bridge the Gap” between Personal and Professional Social, Mobile and Cloud user experiences, our solutions help large and medium-sized organizations dr...
SYS-CON Events announced today that Liaison Technologies, a leading provider of data management and integration cloud services and solutions, has been named "Silver Sponsor" of SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York, NY. Liaison Technologies is a recognized market leader in providing cloud-enabled data integration and data management solutions to break down complex information barriers, enabling enterprises to make smarter decisions, faster.
The 3rd International Internet of @ThingsExpo, co-located with the 16th International Cloud Expo - to be held June 9-11, 2015, at the Javits Center in New York City, NY - announces that its Call for Papers is open. The Internet of Things (IoT) is the biggest idea since the creation of the Worldwide Web more than 20 years ago.
SYS-CON Events announced today that CommVault has been named “Bronze Sponsor” of SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY, and the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. A singular vision – a belief in a better way to address current and future data management needs – guides CommVault in the development of Singular Information Management® solutions for high-performance data protection, universal availability and sim...