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 W said…
thanks for this code!
Anonymous said…
Holy moly crackaschmoly, i only took the xml part, formatted as .properties, had the rest, works!
othmane saadane said…
Gmail may block this email unless you authorized less secure apps in the account used as source of message.
Thanks so much brother !

Popular posts from this blog

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
Column --> ID
    Row             1

Users_CERTIFICATIONS

Validating CSV Files

What is CsvValidator ?
  A Java framework which validates any CSV files something similar to XML validation using XSD.

Why should I use this ?
  You don't have to use this and in fact its easy to write something your own and also checkout its source code for reference.

Why did I write this ?
  Some of our projects integrate with third party application which exchanges information in CSV files so I thought of writing a generic validator which can be hooked in multiple projects or can be used by QA for integration testing.

What is the license clause ?
GNU GPL v2

Are there any JUnit test cases for me checkout ?
 Yes, source

How to integrate in my existing project ?

Just add the Jar which can be downloaded from here CsvValidator.jar and you are good.

Instantiate CsvValidator constructor which takes these 3 arguements

         // filename is the the file to be validated and here is a sample         // list - defines all the fields in the above csv file ( a field has index, type, isOptional, rege…

ArrayList vs LinkedList vs HashSet Performance Comparision

ConclusionsInserting & Reading sequentially from Collection prefer LinkedList/ArrayListInserting & Reading/Deleting by Search/equals from Collection prefer HashSetInserting, ArrayList & LinkedList performs best while HashSet takes double the timeReading, HashSet performs best while ArrayList & LinkedList are marginally lessDeleting, HashSet performs 10 times better than ArrayList & ArrayList performs 4 times better than LinkedList. LinkedList is slow because of sequencial search Bottom line : unless you are not going to iterate using for(Integer i : list ) then prefer HashSet
Inserting/Reading/Deleting integer's from zero till countJDK7Collectionactioncounttime msArrayListInsert1000/1LinkedListInsert1000/1HashSetInsert1000/1ArrayListInsert100005LinkedListInsert100004HashSetInsert100007ArrayListInsert10000011LinkedListInsert10000011HashSetInsert10000021ArrayListGet/Read1000LinkedListGet/Read1000HashSetGet/Read1000ArrayListGet/Read100004LinkedListGet/Read100003Has…