Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ID-4887: Only log warning on disabled of old property tomcat.accesslog #154

Merged
merged 2 commits into from
Jan 8, 2025
Merged

ID-4887: Only log warning on disabled of old property tomcat.accesslog #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53b0a99
ID-4887: Only log warning on disabled of old property since enabled i…
oyri Jan 8, 2025
45ee0c4
ID-4887: readme: spring boot 3 before spring boot 2
oyri Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2023, Digitaliseringsdirektoratet (Digdir)
Copyright (c) 2025, Digitaliseringsdirektoratet (Digdir)
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
46 changes: 24 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,29 @@ mvn clean install

## Usage
The library can be imported through maven with (see latest version under [releases](https://github.com/felleslosninger/idporten-access-log-spring-boot-starter/releases)):

### Spring Boot 3:
```xml
<dependency>
<groupId>no.idporten.logging</groupId>
<artifactId>idporten-access-log-spring-boot-3-starter</artifactId>
<version>2.6.0</version>
</dependency>
```

And you probably already have included these:
```xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-instrumentation-api</artifactId>
</dependency>
```

### Spring Boot 2:
Warning: This version is not maintained anymore, use Spring Boot 3 version instead.

Expand Down Expand Up @@ -63,28 +86,6 @@ And you probably already have included these:
</dependency>
```

### Spring Boot 3:
```xml
<dependency>
<groupId>no.idporten.logging</groupId>
<artifactId>idporten-access-log-spring-boot-3-starter</artifactId>
<version>2.4.0</version>
</dependency>
```

And you probably already have included these:
```xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-instrumentation-api</artifactId>
</dependency>
```

### Configuration
The library is configured through the application.yml/yaml or the active spring profile yaml-file.
```yaml
Expand All @@ -101,6 +102,7 @@ server:
accesslog:
enabled: true # default is true if not set
```
Only include this property if you need to disable access logging, since it is always default enabled.

Use your own logback-access.xml file or configure debug-logging:
```yaml
Expand Down
8 changes: 4 additions & 4 deletions ...ring-boot-3-starter/src/main/java/no/idporten/logging/access/AccessLogsConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ public WebServerFactoryCustomizer<TomcatServletWebServerFactory> accessLogsCusto

log.info("Initialize accessLogsCustomizer for Tomcat Access Logging as JSON. Use config-file: {}", logbackConfigFile);

if (deprecatedTomcatAccessLogProperty != null && !deprecatedTomcatAccessLogProperty.equals("enabled")) { // deprecated property is set, and set to something else than 'enabled'
log.warn("Property 'tomcat.accesslog' is deprecated. Use 'server.tomcat.accesslog.enabled=false' instead.");
if (deprecatedTomcatAccessLogProperty != null && deprecatedTomcatAccessLogProperty.equals("disabled")) { // deprecated property is set to 'disabled'
log.warn("Property 'tomcat.accesslog' is deprecated. Use 'server.tomcat.accesslog.enabled=false' instead or remove if you need Tomcat access logging.");
}

return factory -> {
Expand Down Expand Up @@ -91,8 +91,8 @@ public TraceIdAccessLogDecorator traceIdAccessLogDecorator() {
* Use application provided logback-access.xml if property digdir.access.logging.config-file is configured,
* otherwise check if debug-level is configured.
*
* @param configFile
* @param debug
* @param configFile logback-access.xml
* @param debug only used when configFile is default logback-access.xml
*/
protected String checkIfDebugFeatureEnabledAndConfigureLogbackfile(String configFile, String debug) {

Expand Down
Loading