Fluent Logging

Introduction

Fluent splunk-friendly logging with automatic escaping. Use this library to have a consistent logging format across your libraries and applications.

Using fluent-logging

Fluent splunk-friendly logging with automatic escaping; e.g

public class Demo {

    public static void main(String[] args) {
        new Demo().run();
    }

    protected void run() {
        // report starting conditions
        final Operation operation = operation("operation").with("argument", UUID.randomUUID()).started(this);
        //result operation does not print out the starting conditions, only success/failures
        final Operation resultOperation = resultOperation("resultOperation").with("argument", UUID.randomUUID()).started(this);


        try {
            // do some things
            int x = 1/0;
            // report success
            operation.wasSuccessful().yielding("result","{\"text\": \"hello world\"}").log();
            resultOperation.wasSuccessful().yielding("result","{\"text\": \"hello world\"}").log();

        } catch(Exception e) {
            // report failure
            operation.wasFailure().throwingException(e).log();
            resultOperation.wasFailure().throwingException(e).log();
        }
    }
}

Refer Demo.java for full source code of an example.

Operation might log:

09:42:28.503 [main] INFO  Demo - operation=demo id="bd09f108-2a4d-4e47-8b9f-d20c19c0dad0"
09:42:28.543 [main] INFO  Demo - operation=demo id="bd09f108-2a4d-4e47-8b9f-d20c19c0dad0" outcome=success result="{\"text\": \"hello world\"}"

on success, or:

10:02:13.484 [main] ERROR Demo - operation=demo id="bd09f108-2a4d-4e47-8b9f-d20c19c0dad0" outcome=failure exception="java.lang.ArithmeticException: / by zero"
java.lang.ArithmeticException: / by zero
    at Demo.run(Demo.java:19) [test-classes/:na]
    at Demo.main(Demo.java:10) [test-classes/:na]
    at ...

on failure.

while

Result Operation might log:

09:42:28.543 [main] INFO  Demo - operation=demo id="bd09f108-2a4d-4e47-8b9f-d20c19c0dad0" outcome=success result="{\"text\": \"hello world\"}" timeToComplete=25

on success, or:

10:02:13.484 [main] ERROR Demo - operation=demo id="bd09f108-2a4d-4e47-8b9f-d20c19c0dad0" outcome=failure exception="java.lang.ArithmeticException: / by zero" timeToComplete=2
java.lang.ArithmeticException: / by zero
    at Demo.run(Demo.java:19) [test-classes/:na]
    at Demo.main(Demo.java:10) [test-classes/:na]
    at ...

on failure.

The argument passed to the initiating started() (and, optionally, terminating log()) call is used to derive the logger name, and is usually the object which is the orchestrator of an operation. Alternatively, a specific slf4j logger instance can be passed.

Arguments (passed by with() and yielding() etc.) are escaped to allow Splunk to index them, e.g. double quotes are escaped.

See https://sites.google.com/a/ft.com/technology/systems/membership/logging-conventions for suggested argument key names.

Developing fluent-logging

Pull requests welcome!

mvn clean verify

How to release a new version?

For FT developers, each new commit to master is automatically built and pushed to FT's internal Nexus repo.
The Jenkins CI job can be found here: http://ftjen03760-lviw-uk-p:8181/job/fluent-logging/

FT Nexus

   <dependency>
       <groupId>com.ft.membership</groupId>
       <artifactId>fluent-logging</artifactId>
       <version>2.4.0</version>
   </dependency>

Non-FT developers wishing to use the repo, will have to build and deploy to their local maven repo before manually until Issue#1 is resolved.