Skip to content

Commit f1c0bbd

Browse files
maximevwmaximevw
committed
Prepare release 1.2.0
- Update dependencies - Improve documentation for usage of `autolog-aspectj` module
1 parent 604745c commit f1c0bbd

File tree

9 files changed

+65
-40
lines changed

9 files changed

+65
-40
lines changed

‎CHANGELOG.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
55
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [Unreleased]
7+
## [1.2.0] - 2020-10-24
88
### Added
99
- Add a new module `autolog-aspectj` to allow usage of Autolog annotations in applications using AspectJ weaving.
1010
- Add the ability to use custom logger names instead of the default one (`"Autolog"`):
@@ -51,6 +51,7 @@ annotations `@AutoLogMethodInput` or `@AutoLogMethodInOut`.
5151
### Added
5252
- Initial release.
5353

54-
[Unreleased]: https://github.com/maximevw/autolog/compare/v1.1.0...HEAD
54+
[Unreleased]: https://github.com/maximevw/autolog/compare/v1.2.0...HEAD
55+
[1.2.0]: https://github.com/maximevw/autolog/releases/tag/v1.2.0
5556
[1.1.0]: https://github.com/maximevw/autolog/releases/tag/v1.1.0
5657
[1.0.0]: https://github.com/maximevw/autolog/releases/tag/v1.0.0

‎README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ the following Maven dependencies:
3737
<dependency>
3838
<groupId>com.github.maximevw</groupId>
3939
<artifactId>autolog-spring</artifactId>
40-
<version>1.1.0</version>
40+
<version>1.2.0</version>
4141
</dependency>
4242
```
4343
* In an application using AspectJ weaving for logging automation by AOP:
4444
```xml
4545
<dependency>
4646
<groupId>com.github.maximevw</groupId>
4747
<artifactId>autolog-aspectj</artifactId>
48-
<version>1.1.0</version>
48+
<version>1.2.0</version>
4949
</dependency>
5050
```
5151
* In a classic Java application, you can use logging methods provided by Autolog without automation by AOP (not
@@ -54,7 +54,7 @@ recommended):
5454
<dependency>
5555
<groupId>com.github.maximevw</groupId>
5656
<artifactId>autolog-core</artifactId>
57-
<version>1.1.0</version>
57+
<version>1.2.0</version>
5858
</dependency>
5959
```
6060

@@ -99,7 +99,31 @@ In Spring Boot applications, the `LoggerManager` can be configured in the applic
9999
of `LoggerInterface` implementations to register in the property `autolog.loggers`) thanks to the auto-configuration
100100
class `AutologAutoConfiguration`.
101101

102-
### Basic example
102+
### Usage with AspectJ weaving
103+
104+
In order to use AspectJ weaving for logging automation by AOP, in addition to the dependency to `autolog-aspectj`,
105+
ensure to have `org.aspectj:aspectjrt` in your classpath and to compile your application using AspectJ weaving,
106+
including the dependency to `autolog-aspectj` in the weaved dependencies.
107+
108+
At the starting of your application, insert the following code to instantiate the `LoggerManager` required by Autolog
109+
for logging automation:
110+
```java
111+
public class HelloApplication {
112+
public static void main(final String[] args) {
113+
// Instantiate Autolog.
114+
final LoggerManager loggerManager = new LoggerManager();
115+
// Register any loggers you want to use. See LoggerManager documentation for further details.
116+
// loggerManager.register(...);
117+
AspectJLoggerManager.getInstance().init(loggerManager);
118+
119+
// Put the code of your application here...
120+
}
121+
}
122+
```
123+
124+
Now, you can use Autolog annotations into your application.
125+
126+
### Basic example with a Spring application
103127

104128
Assuming your application is a REST API developed with Spring Web framework using an implementation of Slf4j for
105129
logging.

‎autolog-aspectj/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>com.github.maximevw</groupId>
99
<artifactId>autolog</artifactId>
10-
<version>1.1.0</version>
10+
<version>1.2.0</version>
1111
</parent>
1212

1313
<artifactId>autolog-aspectj</artifactId>
@@ -20,7 +20,7 @@
2020
<dependency>
2121
<groupId>com.github.maximevw</groupId>
2222
<artifactId>autolog-core</artifactId>
23-
<version>1.1.0</version>
23+
<version>1.2.0</version>
2424
<exclusions>
2525
<!-- Do not include Logback transitively for the applications not using it -->
2626
<exclusion>

‎autolog-aspectj/src/main/java/com/github/maximevw/autolog/aspectj/aspects/AutoLogPerformanceAspect.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
import com.github.maximevw.autolog.core.logger.LoggingUtils;
2929
import com.github.maximevw.autolog.core.logger.MethodPerformanceLogEntry;
3030
import com.github.maximevw.autolog.core.logger.MethodPerformanceLogger;
31-
import com.github.maximevw.autolog.core.logger.adapters.Log4j2Adapter;
3231
import com.github.maximevw.autolog.core.logger.performance.AdditionalDataProvider;
3332
import com.github.maximevw.autolog.core.logger.performance.PerformanceTimer;
3433
import org.apache.commons.lang3.StringUtils;

‎autolog-aspectj/src/test/java/com/github/maximevw/autolog/aspectj/configuration/AspectJLoggerManagerTest.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
* Licensed under the Apache License, Version 2.0 (the "License");
88
* you may not use this file except in compliance with the License.
99
* You may obtain a copy of the License at
10-
*
10+
*
1111
* http://www.apache.org/licenses/LICENSE-2.0
12-
*
12+
*
1313
* Unless required by applicable law or agreed to in writing, software
1414
* distributed under the License is distributed on an "AS IS" BASIS,
1515
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -48,7 +48,8 @@ class AspectJLoggerManagerTest {
4848
* provided by the {@link AspectJLoggerManager} singleton when it is not initialized.
4949
*/
5050
@Test
51-
@Order(0) // Always run it first to be sure that the singleton has not been already initialized.
51+
// Always run it first to be sure that the singleton has not been already initialized.
52+
@Order(0)
5253
public void givenNoSpecificLoggerManager_whenGetLoggerManager_returnDefaultLoggerManager() {
5354
final LoggerManager loggerManager = AspectJLoggerManager.getInstance().getLoggerManager();
5455
final List<LoggerInterface> registeredLoggers = loggerManager.getRegisteredLoggers();

‎autolog-core/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>com.github.maximevw</groupId>
99
<artifactId>autolog</artifactId>
10-
<version>1.1.0</version>
10+
<version>1.2.0</version>
1111
</parent>
1212

1313
<artifactId>autolog-core</artifactId>

‎autolog-coverage-reporting/pom.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<artifactId>autolog</artifactId>
99
<groupId>com.github.maximevw</groupId>
10-
<version>1.1.0</version>
10+
<version>1.2.0</version>
1111
</parent>
1212

1313
<artifactId>autolog-coverage-reporting</artifactId>
@@ -33,17 +33,17 @@
3333
<dependency>
3434
<groupId>com.github.maximevw</groupId>
3535
<artifactId>autolog-core</artifactId>
36-
<version>1.1.0</version>
36+
<version>1.2.0</version>
3737
</dependency>
3838
<dependency>
3939
<groupId>com.github.maximevw</groupId>
4040
<artifactId>autolog-aspectj</artifactId>
41-
<version>1.1.0</version>
41+
<version>1.2.0</version>
4242
</dependency>
4343
<dependency>
4444
<groupId>com.github.maximevw</groupId>
4545
<artifactId>autolog-spring</artifactId>
46-
<version>1.1.0</version>
46+
<version>1.2.0</version>
4747
</dependency>
4848
</dependencies>
4949

‎autolog-spring/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>com.github.maximevw</groupId>
99
<artifactId>autolog</artifactId>
10-
<version>1.1.0</version>
10+
<version>1.2.0</version>
1111
</parent>
1212

1313
<artifactId>autolog-spring</artifactId>
@@ -20,7 +20,7 @@
2020
<dependency>
2121
<groupId>com.github.maximevw</groupId>
2222
<artifactId>autolog-aspectj</artifactId>
23-
<version>1.1.0</version>
23+
<version>1.2.0</version>
2424
</dependency>
2525

2626
<dependency>

‎pom.xml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>com.github.maximevw</groupId>
88
<artifactId>autolog</artifactId>
9-
<version>1.1.0</version>
9+
<version>1.2.0</version>
1010
<packaging>pom</packaging>
1111

1212
<name>Autolog</name>
@@ -84,41 +84,41 @@
8484
<!-- Dependencies and plugins versions management -->
8585
<apiguardian.version>1.1.0</apiguardian.version>
8686
<aspectj.version>1.9.5</aspectj.version>
87-
<checkstyle.version>8.32</checkstyle.version>
88-
<commons-lang.version>3.10</commons-lang.version>
89-
<commons-text.version>1.8</commons-text.version>
90-
<compile-testing.version>0.18</compile-testing.version>
91-
<guava.version>29.0-jre</guava.version>
87+
<checkstyle.version>8.36.2</checkstyle.version>
88+
<commons-lang.version>3.11</commons-lang.version>
89+
<commons-text.version>1.9</commons-text.version>
90+
<compile-testing.version>0.19</compile-testing.version>
91+
<guava.version>30.0-jre</guava.version>
9292
<hamcrest.version>2.2</hamcrest.version>
93-
<jackson-databind.version>2.11.0</jackson-databind.version>
94-
<jackson-dataformat-xml.version>2.11.0</jackson-dataformat-xml.version>
95-
<jacoco-maven-plugin.version>0.8.5</jacoco-maven-plugin.version>
93+
<jackson-databind.version>2.11.3</jackson-databind.version>
94+
<jackson-dataformat-xml.version>2.11.3</jackson-dataformat-xml.version>
95+
<jacoco-maven-plugin.version>0.8.6</jacoco-maven-plugin.version>
9696
<jakarta-ws-rs.version>2.1.6</jakarta-ws-rs.version>
97-
<junit-jupiter.version>5.6.2</junit-jupiter.version>
98-
<junit-platform.version>1.6.2</junit-platform.version>
97+
<junit-jupiter.version>5.7.0</junit-jupiter.version>
98+
<junit-platform.version>1.7.0</junit-platform.version>
9999
<h2.version>1.4.200</h2.version>
100100
<license-maven-plugin.version>2.0.0</license-maven-plugin.version>
101101
<log4j2.version>2.13.3</log4j2.version>
102102
<logback.version>1.2.3</logback.version>
103-
<logstash-logback-encoder.version>6.3</logstash-logback-encoder.version>
104-
<lombok.version>1.18.12</lombok.version>
105-
<lombok-maven-plugin.version>1.18.10.0</lombok-maven-plugin.version>
103+
<logstash-logback-encoder.version>6.4</logstash-logback-encoder.version>
104+
<lombok.version>1.18.16</lombok.version>
105+
<lombok-maven-plugin.version>1.18.16.0</lombok-maven-plugin.version>
106106
<maven-checkstyle-plugin.version>3.1.1</maven-checkstyle-plugin.version>
107107
<maven-clean-plugin.version>3.1.0</maven-clean-plugin.version>
108108
<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
109109
<maven-enforcer-plugin.version>3.0.0-M2</maven-enforcer-plugin.version>
110110
<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
111-
<maven-javadoc-plugin.version>3.1.1</maven-javadoc-plugin.version>
112-
<maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
113-
<maven-shade-plugin.version>3.2.1</maven-shade-plugin.version>
111+
<maven-javadoc-plugin.version>3.2.0</maven-javadoc-plugin.version>
112+
<maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
113+
<maven-shade-plugin.version>3.2.4</maven-shade-plugin.version>
114114
<maven-source-plugin.version>3.2.1</maven-source-plugin.version>
115115
<maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
116-
<mockito.version>3.3.3</mockito.version>
117-
<owasp-dependency-check.version>5.3.2</owasp-dependency-check.version>
116+
<mockito.version>3.5.15</mockito.version>
117+
<owasp-dependency-check.version>6.0.2</owasp-dependency-check.version>
118118
<slf4j.version>1.7.30</slf4j.version>
119119
<slf4j-test.version>1.2.0</slf4j-test.version>
120-
<spring.version>5.2.5.RELEASE</spring.version>
121-
<spring-boot.version>2.2.6.RELEASE</spring-boot.version>
120+
<spring.version>5.2.9.RELEASE</spring.version>
121+
<spring-boot.version>2.3.4.RELEASE</spring-boot.version>
122122
<velocity.version>1.7</velocity.version>
123123
<velocity-tools.version>2.0</velocity-tools.version>
124124
</properties>

0 commit comments

Comments
 (0)