Skip to main content

How to customize log message using application data in log4Perl using MDC

In log messages it is often need to pass application data which is common to a set of log messages. One example is to log a requestID of an API call which uniquely identifies all log messages belongs to processing a particular API call.

One approach is to pass the requestID in all log messages by appending the log message with requestID.

Another approach is to use log4Perl::MDC (Mapped Diagnostic Context). Using MDC we can store Thread Specific data and which can be accessed by logger. The thread specific data of a parent thread is accessible to its child thread as well.

Below program explains this.

  use Log::Log4perl;  
  Log::Log4perl::init("log4perl.conf");  
  method();  
  sub method {  
  Log::Log4perl::MDC->put("requestId","req00008");  
 
  my $logger = Log::Log4perl->get_logger("");  

  $logger->info("Received a request");  
  $logger->debug("Received a request");  
  }

Here we have set a Thread specific data key value pair using Log::Log4perl::MDC->put(). 

Logger will use the following configuration to print requestId from MDC to log message.

 log4perl.rootLogger=TRACE, errorlog  
 log4perl.appender.errorlog=Log::Log4perl::Appender::File  
 log4perl.appender.errorlog.filename=c:/perl/log-dir/error.log  
 log4perl.appender.errorlog.mode=append  
 log4perl.appender.errorlog.Threshold = INFO  
 log4perl.appender.errorlog.layout=Log::Log4perl::Layout::PatternLayout  
 log4perl.appender.errorlog.layout.ConversionPattern=%d{ISO8601}|%X{requestId}|%C|%m%n  


%X{requestId} - indicates that the information will be obtained from MDC with key ='requestId'

The log message will be as below.

2015-08-05 15:32:45,766|req00008|main|Received a request

Comments

Post a Comment

Popular posts from this blog

How to create a minikube single node cluster for learning Kubernetes

In this post I will explain how to setup a minikube single node kubernetes cluster using AWS EC2 instance which would help anyone who is trying to learn kubernetes and also help them to gain practical knowledge in kubernetes by running kubernetes commands, creating kubernetes objects etc. Minikube is a single node kubernetes cluster which means a kubernetes cluster with only one node that is a single VM. Minikube is only used for learning purposes and it is not an alternative for a real kubernetes cluster and should not be used for development and production usage. In this example I have launched an AWS EC2 instance with below configuration where I will install minikube and related tools. AWS EC2 Instance Configuration AMI: Ubuntu Free tier eligible 64 bit Instance type : t2-large ( For me t2-small or t2-micro is giving performance issues due to less memory) Once the EC2 instance is up and running, login to the instance using below command on terminal. If you are using wi...
27 comments
Read more

log4j - How to write log to multiple log files using log4j.properties

In Java applications some times you may need to write your log messages to specific log files with its own specific log properties. If you are using log4j internally then first step that you need to do is to have a proper log4j.properties file. Below example shows 2 log4j appenders which write to 2 different log files, one is a debug log and another one is a reports log. Debug log file can have all log messages and reports log can have log messages specific to reporting on say splunk monitoring. # Root logger option log4j.rootLogger=ALL,STDOUT,debugLog log4j.logger.reportsLogger=INFO,reportsLog log4j.additivity.reportsLogger=false     log4j.appender.STDOUT=org.apache.log4j.ConsoleAppender log4j.appender.STDOUT.layout=org.apache.log4j.PatternLayout log4j.appender.STDOUT.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %C:%L - %m%n     # Direct log messages to a log file log4j.appender.debugLog=org.apache.log4j.RollingFileAppen...
25 comments
Read more

Create SNMP Client in JAVA Using SNMP4j

Please follow the below mentioned steps to write a very simple SNMP4J application using Java and eclipse IDE. First you need to download a copy of SNMP4J.jar. You can get it from http://www.snmp4j.org/html/download.html Then you need to decide how you are going to test your application. Check whether you have access to any real network devices like Cisco routers or Juniper routers or whether you are aware of any SNMP agent running on any of your servers.There is nothing to worry if you cannot find one , you can start SNMP agent on your desktop machine as well. Here I am giving an example of how you can use your Windows machine to test your application by starting the SNMP service on the machine. I am using a Windows XP machine and below are the steps needed to start SNMP agent on the machine. 1. Go to Start->Control Panel -> Add or Remove Programs -> Add or Remove Windows Components      Select or Check "Management and Monitoring Tools". ...
16 comments
Read more