README.md

EasyLog Site | Source Code

EasyLog for non-Spring projects - example

This is the example that demonstrates how to use EasyLog for non-Spring projects

pom.xml

AspectJ Maven Plugin

    <build>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>aspectj-maven-plugin</artifactId>
                <version>1.11</version>
                <configuration>
                    <complianceLevel>1.8</complianceLevel>
                    <source>1.8</source>
                    <target>1.8</target>
                    <verbose>true</verbose>
                    <Xlint>ignore</Xlint>
                    <encoding>UTF-8</encoding>
                </configuration>
                <executions>
                    <execution>
                        <id>aspectj-compile</id>
                        <goals>
                            <goal>compile</goal>
                            <goal>test-compile</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        ...
        </plugins>
    </build>

Extend EasyLoggerNoSpring

@Aspect
public class MyLogger extends EasyLoggerNoSpring {

    @Around("execution(* *(..)) && @within(annotation)")
    public Object classLog(ProceedingJoinPoint jp, LogIt annotation) throws Throwable {
        return logItClassLevel(jp, annotation);
    }

    @Around("execution(* *(..)) && @annotation(annotation)")
    public Object methodLog(ProceedingJoinPoint jp, LogIt annotation) throws Throwable {
        return logItMethodLevel(jp, annotation);
    }

    @AfterThrowing(pointcut = "execution(* *(..)) && @within(annotation)", throwing = "e")
    public void classExceptionLog(JoinPoint jp, LogIt annotation, Throwable e) {
        logExceptionClassLevel(jp, annotation, e);
    }

    @AfterThrowing(pointcut = "execution(* *(..)) && @annotation(annotation)", throwing = "e")
    public void methodExceptionLog(JoinPoint jp, LogIt annotation, Throwable e) {
        logExceptionMethodLevel(jp, annotation, e);
    }

}

Just copy and past.

If you use IntelliJ make sure that you use AJC compiler if this wasn't set automatically.

Also you may need to clear target folder (mvn clean or just right click and delete on it).

Maven commands work as expected.

LogIt annotation

LogIt annotation without parameters

    @LogIt
    public Universe bigBang(int numberOfStars, int numberOfBlackHoles) {
        blackHoles = IntStream.range(0, numberOfBlackHoles).boxed()
                .map(item -> new BlackHole(randomName("BlackHole-")))
        ...
    }

Log output will look like this

13:36:06.021 [main] INFO  UneasyLogger - 
-> public Universe Universe.bigBang(int numberOfStars, int numberOfBlackHoles)
"numberOfStars": 3,
"numberOfBlackHoles": 3

13:36:06.205 [main] INFO  UneasyLogger - 
Execution/Response time:  162ms
<- Universe Universe.bigBang(int numberOfStars, int numberOfBlackHoles)
{
  "stars": [
    {
      "name": "Star-b90637a4-81bb-4c46-9c05-99ecf2dc0502",
      "type": "RED_GIANT",
      "planets": [
        {
          "name": "Planet-c5308178-4ebe-46c6-a02a-f78d489afc99",
          "haveSatellites": true
        },
        {
          "name": "Planet-1d13015a-a552-4492-8f1f-62e63912c1a3",
          "haveSatellites": true
        }
      ]
    },
    {
      "name": "Star-db998dc1-533a-4663-96c5-088e8be1e87f",
      "type": "WHITE_DWARF",
      "planets": []
    },
    {
      "name": "Star-307f313c-8baf-4baa-b3db-1528caf328bd",
      "type": "RED_DWARF",
      "planets": [
        {
          "name": "Planet-2e198389-3ca8-47bf-916d-c4c4359a0b54",
          "haveSatellites": false
        }
      ]
    }
  ],
  "blackHoles": [
    {
      "name": "BlackHole-b1bd222d-a4d3-456d-af87-ac72e4624cbb"
    },
    {
      "name": "BlackHole-4885c353-2aec-4022-98cc-e497cfb4dec6"
    },
    {
      "name": "BlackHole-1697001a-70e2-405e-9082-383b2d33dd80"
    }
  ],
  "dateOfCreation": "Jun 29, 2018 1:36:06 PM"
}

LogIt annotation with parameters - example

    @LogIt(label = "DEBUG BIG BANG ISSUE",
            level = Level.DEBUG,
            ignoreParameters = {"numberOfBlackHoles"},
            maskFields = {"type"})
    public Universe bigBang(int numberOfStars, int numberOfBlackHoles) {
        blackHoles = IntStream.range(0, numberOfBlackHoles).boxed()
                .map(item -> new BlackHole(randomName("BlackHole-")))
        ...
    }

Log output

13:53:15.363 [main] DEBUG UneasyLogger - 
DEBUG BIG BANG ISSUE
-> public Universe Universe.bigBang(int numberOfStars, int numberOfBlackHoles<NOT_LOGGED>)
"numberOfStars": 3

13:53:15.564 [main] DEBUG UneasyLogger - 
Execution/Response time:  155ms
DEBUG BIG BANG ISSUE
<- Universe Universe.bigBang(int numberOfStars, int numberOfBlackHoles<NOT_LOGGED>)
{
  "stars": [
    {
      "planets": [
        {
          "haveSatellites": true,
          "name": "Planet-7c331df9-0fe5-4ebf-957e-458a7333b6e5"
        }
      ],
      "name": "Star-da910321-eb6f-4702-b361-5baafb786339",
      "type": "XXXMASKEDXXX"
    },
    {
      "planets": [
        {
          "haveSatellites": true,
          "name": "Planet-5f216b9e-3a74-4097-a556-83efe0984c9e"
        },
        {
          "haveSatellites": false,
          "name": "Planet-b3dd6a9b-7d96-499b-8ba9-ef646842d938"
        }
      ],
      "name": "Star-b24baf86-a8ad-48b9-a88b-e7673725adcf",
      "type": "XXXMASKEDXXX"
    },
    {
      "planets": [
        {
          "haveSatellites": false,
          "name": "Planet-9c74dcca-8a16-49cd-b99d-6bafeabb689c"
        },
        {
          "haveSatellites": false,
          "name": "Planet-bd98faf6-1499-47b2-9175-4c12929761c5"
        }
      ],
      "name": "Star-28ee8435-a4f1-448e-9d4c-324339be9371",
      "type": "XXXMASKEDXXX"
    }
  ],
  "blackHoles": [
    {
      "name": "BlackHole-3db09a77-ca1f-4d23-90ad-6894d1a8cf69"
    },
    {
      "name": "BlackHole-494eca83-cdd8-40d9-95c7-ec1d851545f4"
    },
    {
      "name": "BlackHole-1f56b7eb-0028-45d1-bea1-d8e2ad2b7888"
    }
  ],
  "dateOfCreation": "Jun 29, 2018 1:53:15 PM"
}