log-rs

Quarkus log extension

License	License Apache License, Version 2.0
Categories	Categories Quarkus Container Microservices
GroupId	GroupId org.lorislab.quarkus
ArtifactId	ArtifactId log-rs
Last Version	Last Version 0.3.0
Release Date	Release Date Jun 25, 2020
Type	Type jar
Description	Description log-rs Quarkus log extension
Project Organization	Project Organization lorislab

Download log-rs

Filename	Size
log-rs-0.3.0.pom
log-rs-0.3.0.jar	8 KB
log-rs-0.3.0-sources.jar	5 KB
log-rs-0.3.0-javadoc.jar	403 KB
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.lorislab.quarkus/log-rs/ -->
<dependency>
    <groupId>org.lorislab.quarkus</groupId>
    <artifactId>log-rs</artifactId>
    <version>0.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.lorislab.quarkus/log-rs/
implementation 'org.lorislab.quarkus:log-rs:0.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.lorislab.quarkus/log-rs/
implementation ("org.lorislab.quarkus:log-rs:0.3.0")

Apache Buildr

'org.lorislab.quarkus:log-rs:jar:0.3.0'

Apache Ivy

<dependency org="org.lorislab.quarkus" name="log-rs" rev="0.3.0">
  <artifact name="log-rs" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.lorislab.quarkus', module='log-rs', version='0.3.0')
)

Scala SBT

libraryDependencies += "org.lorislab.quarkus" % "log-rs" % "0.3.0"

Leiningen

[org.lorislab.quarkus/log-rs "0.3.0"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.lorislab.quarkus : log-cdi	jar	0.3.0
org.jboss.spec.javax.ws.rs : jboss-jaxrs-api_2.1_spec	jar

provided (1)

Group / Artifact	Type	Version
io.quarkus : quarkus-core	jar

Project Modules

There are no modules declared in this project.

quarkus-log

Quarkus log interceptor extension

This library is a Quarkus extension which implements the CDI bean log interceptor. Example:

[org.lor.qua.log.it.cdi.ModelService] (executor-thread-1) model(model:param1) started.
[org.lor.qua.log.it.cdi.ModelService] (executor-thread-1) model(model:param1):model:param1 [0.002s] succeed.

The default pattern is

<method_name>(<input_parameters>) started.
<method_name>(<input_parameters>):<return_type> [execution_time] succeed|failed.

Maven dependency

<dependency>
    <groupId>org.lorislab.quarkus</groupId>
    <artifactId>log-cdi</artifactId>
    <version>{latest-release-version}</version>
</dependency>

The standard log method for each parameter is the toString() Java method. You can overwrite this default configuration when you define a producer method which returns org.lorislab.quarkus.log.cdi.LogParamValue with annotation @Produces.

    @Produces
    public LogParamValue model() {
       return assignable(v -> "model:" + ((Model)v).param, Model.class);
    }

Annotations

org.lorislab.quarkus.log.cdi.LogService - bind class or method to the interceptor. Parameters:
- enabled - disable or enable log. Default: true
- stacktrace - log stacktrace of the method. Default: true
org.lorislab.quarkus.log.cdi.LogExclude - exclude class or method from the interceptor binding
org.lorislab.quarkus.log.cdi.LogReplaceValue - hide or mask value of the method parameters

Configuration

Build time

quarkus.lorislab.log.exclude - exclude class or method regex. Example: (.*?)(ExcludeService.*?$|ExcludeMethodService\\.excludeMethod$). Default: empty
quarkus.lorislab.log.packages - Binding the interceptor to all classes in these packages. Default: org.lorislab
quarkus.lorislab.log.only-public-method - Binding the interceptor only to public methods. Default: true
quarkus.lorislab.log.static-method - Binding the interceptor to static methods of the bean class. Default: true

Runtime time

quarkus.lorislab.log.enabled - enable or disable interceptor. Default: true
quarkus.lorislab.log."<fully-qualified name>".enabled - disable or enable an interceptor for class. Default: true
quarkus.lorislab.log."<fully-qualified name>".stacktrace - log stacktrace for the class. Default: true
quarkus.lorislab.log."<fully-qualified name>.<method_name>".enabled - disable or enable an interceptor for method. Default: true
quarkus.lorislab.log."<fully-qualified name>.<method_name>".stacktrace - log stacktrace for the method. Default: true
quarkus.lorislab.log.message.return-void - log void representation. Default: void
quarkus.lorislab.log.message.start - start log pattern. Default: {0}({1}) started. Indexes:
- 0 - method name
- 1 - input parameters
quarkus.lorislab.log.message.succeed - succeed log pattern. Default: {0}({1}):{2} [{3}s] succeed. Indexes:
- 0 - method name
- 1 - input parameters
- 2 - return value
- 3 - execution time
quarkus.lorislab.log.message.failed - failed log pattern. Default: {0}({1}):{2} [{3}s] failed. Indexes:
- 0 - method name
- 1 - input parameters
- 2 - return value
- 3 - execution time

Mutiny

For mutiny add maven dependency

<dependency>
    <groupId>org.lorislab.quarkus</groupId>
    <artifactId>log-mutiny</artifactId>
    <version>{latest-release-version}</version>
</dependency>

Interceptor for all methods which returns the Uni or Multi.

RestEasy

Maven dependency

<dependency>
    <groupId>org.lorislab.quarkus</groupId>
    <artifactId>log-resteasy</artifactId>
    <version>{latest-release-version}</version>
</dependency>

Example

[org.lor.qua.log.it.rs.TestRestController] (executor-thread-1) POST http://localhost:8081/test/post/param1 [true] started.
[org.lor.qua.log.it.rs.TestRestController] (executor-thread-1) POST http://localhost:8081/test/post/param1 [0.009s] finished [200-OK,true].

The default pattern is

<http_method_name> <URI> [<entity?>] started.
<http_method_name> <URI> [execution_time] finished [<response_code>-<response>,<entity?>].

Rest client example

[org.lor.qua.log.rs.RestClientLogInterceptor] (executor-thread-1) GET http://localhost:8081/client/get [false] started.
[org.lor.qua.log.rs.RestClientLogInterceptor] (executor-thread-1) GET http://localhost:8081/client/get [0.004s] finished [200-OK,true].

The default pattern for rest-client is

<http_method_name> <URI> [<entity?>] started.
<http_method_name> <URI> [execution_time] finished [<response_code>-<response>,<entity?>].

Configuration

quarkus.lorislab.log.rs.priority - interceptor priority. Default: 100
quarkus.lorislab.log.rs.enabled - enable or disable interceptor. Default: true
quarkus.lorislab.log.rs.exclude - exclude URI regex. Default: empty
quarkus.lorislab.log.rs.message.start - start request log pattern. Default: {0} {1} [{2}] started. Indexes:
- 0 - HTTP method name
- 1 - URI
- 2 - request entity true or false.
quarkus.lorislab.log.rs.message.succeed - finished request log pattern. Default: {0} {1} [{2}s] finished [{3}-{4},{5}]. Indexes:
- 0 - method name
- 1 - URI
- 2 - execution time
- 3 - response code
- 4 - response
- 5 - response entity true or false.
quarkus.lorislab.log.rs.client.priority - rest-client interceptor priority. Default: 100
quarkus.lorislab.log.rs.client.enabled - rest-client enable or disable interceptor. Default: true
quarkus.lorislab.log.rs.client.exclude - rest-client exclude URI regex. Default: empty
quarkus.lorislab.log.rs.client.message.start - rest-client start request log pattern. Default: {0} {1} [{2}] started. Indexes:
- 0 - HTTP method name
- 1 - URI
- 2 - request entity true or false.
quarkus.lorislab.log.rs.client.message.succeed - rest-client finished request log pattern. Default: {0} {1} [{2}s] finished [{3}-{4},{5}]. Indexes:
- 0 - method name
- 1 - URI
- 2 - execution time
- 3 - response code
- 4 - response
- 5 - response entity true or false.

Vertx-Web

For vertx-web add maven dependency

<dependency>
    <groupId>org.lorislab.quarkus</groupId>
    <artifactId>log-vertx-web</artifactId>
    <version>{latest-release-version}</version>
</dependency>

Example

[org.lor.qua.log.ver.web.VertxWebInterceptor] (vert.x-eventloop-thread-11) POST /test/post1/p1 [false] started.
[org.lor.qua.log.ver.web.VertxWebInterceptor] (vert.x-eventloop-thread-11) POST /test/post1/p1 [0.008s] finished [200-OK,true].

The default pattern is

<http_method_name> <URI> [<entity?>] started.
<http_method_name> <URI> [execution_time] finished [<response_code>-<response>,<entity?>].

Configuration

quarkus.lorislab.log.vertx.web.priority - interceptor priority. Default: 100
quarkus.lorislab.log.vertx.web.enabled - enable or disable interceptor. Default: true
quarkus.lorislab.log.vertx.web.exclude - exclude URI regex. Default: empty
quarkus.lorislab.log.vertx.web.message.start - start request log pattern. Default: {0} {1} [{2}] started. Indexes:
- 0 - HTTP method name
- 1 - URI
- 2 - request entity true or false.
quarkus.lorislab.log.vertx.web.message.succeed - finished request log pattern. Default: {0} {1} [{2}s] finished [{3}-{4},{5}]. Indexes:
- 0 - method name
- 1 - URI
- 2 - execution time
- 3 - response code
- 4 - response
- 5 - response entity true or false.

lorislab

Versions

Version
0.3.0 Jun 25, 2020
0.2.0 Jun 21, 2020
0.1.0 May 23, 2020

log-rs

License

Categories

GroupId

ArtifactId

Last Version

Release Date

Type

Description

Project Organization

Download log-rs

How to add to project

Dependencies

compile (2)

provided (1)

Project Modules

quarkus-log

Annotations

Configuration

Build time

Runtime time

Mutiny

RestEasy

Configuration

Vertx-Web

Configuration

lorislab

Versions