Skip to main content

Log4j - Email errors using Gmail

Most of the small projects doesn't have a dedicated person to monitor log file all the times, and its handy to send these errors as email to an email list.

Pros

  1. Never miss an error.
  2. Delete Emails which you want to ignore because of invalid inputs or connectivity issues etc.
  3. Proactively identify bugs and fix them.
  4. Email list is handy i.e. multiple person can receive emails.
  5. If you have different modules in your project and different teams work on them, adding a Labels to your log can by handy since most of the Email Servers can Label emails and redirect them to different folders.
Cons
  1.    Sending email from code takes few seconds, workaround is the create Logger wrapper which logs in a separate thread.

log4j.properties

log4j.rootLogger=ERROR, gmail
log4j.appender.gmail=org.apache.log4j.net.SMTPAppender
log4j.appender.gmail.SMTPProtocol=smtps
log4j.appender.gmail.SMTPUsername=username@gmail.com
log4j.appender.gmail.SMTPPassword=password
log4j.appender.gmail.SMTPHost=smtp.gmail.com
log4j.appender.gmail.SMTPPort=465
log4j.appender.gmail.Subject=Some subject line
log4j.appender.gmail.To=username@gmail.com
log4j.appender.gmail.From=email-list@gmail.com
log4j.appender.gmail.layout=org.apache.log4j.PatternLayout
log4j.appender.gmail.layout.ConversionPattern=%d{MM/dd/yyyy HH:mm:ss}  [%M] %-5p %C - %m%n
log4j.appender.gmail.BufferSize=10


Required Jar files

Activation  download from here

Sample Code

public class Log4jGmailDemo {

    public static void main(String[] args) {
        try {
            int z = 4 / 0;
        } catch (RuntimeException re) {
            logger.error("Module-1", re);
        }
    }
    static Logger logger = Logger.getLogger(Log4jGmailDemo.class);
}

This is only if you are interested using Threads 


public class CustomLogger extends Logger {

    public CustomLogger(String clazz) {
        super(clazz);
    }

    @Override
    public void error(Object message) {
        Runnable runnable = new LoggerRunnable(this, message, null);
        LogExecutor.getInstance().execute(runnable);
    }

    @Override
    public void error(Object message, Throwable throwable) {
        Runnable runnable = new LoggerRunnable(this, message, throwable);
        LogExecutor.getInstance().execute(runnable);
    }

    public static Logger getLogger(Class clazz) {
        return new CustomLogger(clazz.getSimpleName());
    }
}

class LogExecutor {

    private static LogExecutor executor = new LogExecutor();

    private LogExecutor() {
    }
    private ExecutorService service = Executors.newFixedThreadPool(5);

    public static LogExecutor getInstance() {
        return executor;
    }

    public void execute(Runnable runnable) {
        service.execute(runnable);
    }
}

class LoggerRunnable implements Runnable {

    private Logger logger;
    private Object message;
    private Throwable throwable;

    public LoggerRunnable(Logger logger, Object message, Throwable throwable) {
        this.logger = logger;
        this.message = message;
        this.throwable = throwable;
    }

    @Override
    public void run() {
        logger.error(message, throwable);
    }
}

Sample Usage



public class Log4jGmailDemo {

    public static void main(String[] args) {
        try {
            int z = 4 / 0;
        } catch (RuntimeException re) {
            logger.error("Module-1", re);
        }
    }
    static Logger logger = CustomLogger.getLogger(Log4jGmailDemo.class);
}

Comments

Steven said…
Nice article. Just to add: you can use AsyncAppender to make non-blocking emailing of logs instead of writing your own.
May 26, 2011 at 8:10 PM
Post a Comment

Popular posts from this blog

Access multiple Databases in JPA

According to JPA specification we can define multiple "persistence-unit" elements (i.e. like below) in persistence.xml file and can easily refer them inside Dao layers as this. public class PolarDaoImpl {     @PersistenceContext(unitName="PolarPU")     protected EntityManager entityManager; -- } public class BearDaoImpl {     @PersistenceContext(unitName="BearPU")     protected EntityManager entityManager; -- } Checkout sample persistence.xml <?xml version="1.0" encoding="UTF-8"?> <persistence version="2.0" xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">     <!-- Database 1 -->     <persistence-unit name="PolarPU" transaction-type="RESOURCE_LOCAL">         <
3 comments
Read more

JPA 2 new feature @ElementCollection explained

@ElementCollection is new annotation introduced in JPA 2.0, This will help us get rid of One-Many and Many-One shitty syntax. Example 1: Stores list of Strings in an Entity @Entity public class Users implements Serializable {     private static final long serialVersionUID = 1L;     @Id     @GeneratedValue(strategy = GenerationType.AUTO)     private Long id;     @ElementCollection     private List<String> certifications = new ArrayList <String> ();     public Long getId() {         return id;     }     public void setId(Long id) {         this.id = id;     }     public List <String> getCertifications() {         return certifications;     }     public void setCertifications(List <String> certifications) {         this.certifications = certifications;     } .. }         Users u = new Users();         u.getCertifications().add("Sun Certified Java Programmer");         em.persist(u); Generated Tables    Users    Co
21 comments
Read more

Reuse JPA Entities as DTO

Note : Major design advantages of JPA Entities are they can detached and used across tiers and networks and later can by merged. Checkout this new way of querying entities in JPA 2.0 String ql = " SELECT new prepclass2.Employee (e.firstname, e.lastname) FROM Employee e "; List<Employee> dtos = em.createQuery(ql).getResultList(); The above query loads all Employee entities but with subset of data i.e. firstname, lastname. Employee entity looks like this. @Entity @Table(name="emp") public class Employee implements Serializable {     private static final long serialVersionUID = 1L;     @Id     @GeneratedValue(strategy = GenerationType.AUTO)     private Long id;     @Column     private String firstname;     @Column     private String lastname;     @Column     private String username;     @Column     private String street;     @Column     private String city;     @Column     private String state;     @Column     private String zipc
11 comments
Read more