feat: Added janino to have conditions in logging config

Closes #107
devatherock · Oct 28, 2021 · b8a6929 · b8a6929
1 parent eb9547a
commit b8a6929
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,12 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- [#107](https://github.com/devatherock/artifactory-badge/issues/107): `janino` to have conditions in logging config
+- `dependencycheck` gradle plugin to detect vulnerable dependencies
+
 ### Changed
-- chore(deps): update plugin io.micronaut.application to v2.0.5
 - chore: Added changelog-updater for creating missed changelog entries
-- chore(deps): update plugin com.diffplug.spotless to v5.15.1
-- chore(deps): update plugin io.micronaut.application to v2.0.6
-- chore(deps): update plugin com.diffplug.spotless to v5.15.2
 - chore(deps): update dependency org.projectlombok:lombok to v1.18.22
 - chore(deps): update plugin com.diffplug.spotless to v5.17.0
 - chore(deps): update plugin io.micronaut.application to v2.0.7

diff --git a/README.md b/README.md
@@ -18,7 +18,16 @@ docker run --rm \
   devatherock/artifactory-badge:latest
 ```
 
-### Environment variables for configuration
+### Configurable properties
+#### application.yml
+
+```yaml
+logger:
+  levels:
+    io.micronaut.http.server.netty.NettyHttpServer: TRACE # Optional. To enable HTTP server access logs
+```
+
+#### Environment variables
 
 | Name                                  |   Required   |   Default        |   Description                                                                     |
 |---------------------------------------|--------------|------------------|-----------------------------------------------------------------------------------|
@@ -31,6 +40,7 @@ docker run --rm \
 | LOGGER_LEVELS_IO_GITHUB_DEVATHEROCK   |   false      |   INFO           |   [SLF4J](http://www.slf4j.org/api/org/apache/commons/logging/Log.html) log level, for custom code  |
 | MICRONAUT_ENVIRONMENTS                |   false      |   (None)         |   Setting the value to `local` will mock the calls to the artifactory. Only for testing purposes  |
 | MICRONAUT_SERVER_PORT                 |   false      |   8080           |   Port in which the app listens on                                                |
+| MICRONAUT_CONFIG_FILES                |   true       |   (None)         |   Path to YAML config files. The YAML files can be used to specify complex, object and array properties  |
 | JAVA_OPTS                             |   false      |   (None)         |   Additional JVM arguments to be passed to the container's java process           |
 
 ### Endpoints
@@ -70,7 +80,8 @@ docker run --rm \
 and set the environment variable `JAVA_OPTS` to `-Dlogback.configurationFile=/path/to/custom/logback.xml`
 
 ### JSON logs
+Refer [logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) documentation to customize the field names and formats in the log
 
-To output logs as JSON, set the environment variable `JAVA_OPTS` to `-Dlogback.configurationFile=logback-json.xml`. Refer
-[logstash-logback-encoder](https://github.com/logstash/logstash-logback-encoder) documentation to customize the field names and 
-formats in the log
+- With the default logging config, if `MICRONAUT_ENVIRONMENTS` environment variable has the value `local`, logs will be in plain text(not JSON) format. Else they will be in JSON format
+- To output logs as JSON all the time, set the environment variable `JAVA_OPTS` to `-Dlogback.configurationFile=logback-json.xml`
+- To output logs as plain text(not JSON) all the time, set the environment variable `JAVA_OPTS` to `-Dlogback.configurationFile=logback-plain.xml`
diff --git a/build.gradle b/build.gradle
@@ -7,6 +7,7 @@ plugins {
     id 'org.sonarqube' version '3.3'
     id 'com.github.kt3k.coveralls' version '2.12.0'
     id 'com.diffplug.spotless' version '5.17.0'
+    id 'org.owasp.dependencycheck' version '6.4.1.1'
 }
 
 version "0.4.0"
@@ -48,8 +49,11 @@ dependencies {
     implementation "io.micronaut.cache:micronaut-cache-caffeine"
 
     implementation group: 'net.logstash.logback', name: 'logstash-logback-encoder', version: '6.6'
+    implementation group: 'org.codehaus.janino', name: 'janino', version: '3.1.6'
+    implementation group: 'io.netty', name: 'netty-all', version: '4.1.69.Final'
 
     runtimeOnly "ch.qos.logback:logback-classic:1.2.6"
+
     testAnnotationProcessor platform("io.micronaut:micronaut-bom:$micronautVersion")
     testAnnotationProcessor "io.micronaut:micronaut-inject-java"
     testImplementation "io.micronaut:micronaut-inject-groovy"

diff --git a/src/main/resources/logback-json.xml b/src/main/resources/logback-json.xml
@@ -6,5 +6,4 @@
     <root level="INFO">
         <appender-ref ref="STDOUT" />
     </root>
-    <logger name="io.micronaut.http.server.netty.NettyHttpServer" level="TRACE" />
 </configuration>
diff --git a/src/main/resources/logback-plain.xml b/src/main/resources/logback-plain.xml
@@ -0,0 +1,14 @@
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <withJansi>true</withJansi>
+        <!-- encoders are assigned the type
+             ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+		<appender-ref ref="STDOUT" />
+    </root>
+</configuration>
diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml
@@ -7,11 +7,19 @@
             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
         </encoder>
     </appender>
+
+    <appender name="JSON" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder class="net.logstash.logback.encoder.LogstashEncoder" />
+    </appender>
 
     <root level="INFO">
-        <appender-ref ref="STDOUT" />
+    	<if condition='property("MICRONAUT_ENVIRONMENTS").contains("local")'>
+    		<then>	
+        		<appender-ref ref="STDOUT" />
+        	</then>
+        	<else>
+       			<appender-ref ref="JSON" />
+       		</else>
+       	</if>
     </root>
-    <logger name="io.micronaut.http.server.netty.NettyHttpServer" level="TRACE" />
-    <!--<logger name="io.micronaut.http.client" level="DEBUG" /> -->
-    <!--<logger name="io.micronaut.context.condition" level="TRACE" />-->
 </configuration>