Skip to main content

Simple setup Log4j with GMail and recieve all errors as email

Receive all server exceptions as email, never miss one, easy to share and discuss with the others

Follow these simple steps to configure Log4j to use GMail.


Step 1: Add dependencies

        <dependency>
            <groupId>javax.mail</groupId>
            <artifactId>mail</artifactId>
            <version>1.4</version>
        </dependency>
      
        <!-- Log4j -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.16</version>
            <exclusions>
                <exclusion>
                    <groupId>javax.mail</groupId>
                    <artifactId>mail</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>javax.jms</groupId>
                    <artifactId>jms</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>com.sun.jdmk</groupId>
                    <artifactId>jmxtools</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>com.sun.jmx</groupId>
                    <artifactId>jmxri</artifactId>
                </exclusion>
            </exclusions>
        </dependency>


Step 2: Sample logging file, inline comments are self explanatory
        https://github.com/intesar/Log4jGmail/blob/master/src/main/resources/log4j.xml

    <?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
    <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
       
        <!-- Appends events to console : compliments SMTPAppender -->
        <appender name="Console" class="org.apache.log4j.ConsoleAppender">
            <layout class="org.apache.log4j.PatternLayout">
                <param name="ConversionPattern" value="[${name}] - %d{ISO8601} - %X{login} - %m%n" />
            </layout>
        </appender>

        <!-- SMTP will only log error events -->
        <appender name="Email" class="org.apache.log4j.net.SMTPAppender">
            <param name="BufferSize" value="1" /> <!-- default is 512, changed for test cases to work -->
            <!-- GMail will not work without this, log4j 1.2.16 is required this why earlier versions required hack-->
            <param name="SMTPProtocol" value="smtps" />
            <param name="SMTPHost" value="smtp.gmail.com" />
            <param name="SMTPPort" value="465" />
            <param name="SMTPUsername" value="<email>" /> <!-- example@gmail.com -->
            <param name="SMTPPassword" value="<passowrd>" /> <!-- passowrd -->
            <param name="To" value="mdshannan@gmail.com" />
            <param name="Subject" value="Zytoon.me Error Log" />
            <layout class="org.apache.log4j.PatternLayout">
                <param name="ConversionPattern" value="[${name}] - %d{ISO8601} - %X{login} - %m%n" />
            </layout>
        </appender>

        <appender name="EMAIL_ASYNC" class="org.apache.log4j.AsyncAppender">
            <param name="BufferSize" value="1"/>
            <appender-ref ref="Email"/>
        </appender>

        <root>
            <priority value="trace" />
            <appender-ref ref="Email" />
            <appender-ref ref="Console" />
        </root>

    </log4j:configuration>


Sample Code

    import org.apache.log4j.Logger;

    public class App {

        private static Logger logger = Logger.getLogger(App.class);

        public static void main(String[] args) throws InterruptedException {

            logger.trace("trace message");

            logger.warn("warn message");

            logger.error("error message, a very long error message!");

            Thread.sleep(2000);
        }
    }

Fork it on Github https://github.com/intesar/Log4jGmail

Comments

Fernando Wermus said…
thanks for this code!
June 27, 2013 at 6:24 PM
Anonymous said…
Holy moly crackaschmoly, i only took the xml part, formatted as .properties, had the rest, works!
November 7, 2014 at 2:10 AM
Unknown said…
Gmail may block this email unless you authorized less secure apps in the account used as source of message.
Thanks so much brother !
February 15, 2016 at 1:11 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