Compare commits

..

No commits in common. "main" and "0.0.2" have entirely different histories.
main ... 0.0.2

91 changed files with 894 additions and 3366 deletions

11
.github/README.md vendored
View file

@ -1,11 +0,0 @@
# Micronaut Logging support
Enhanced logging for Micronaut using MDC or request header.
[![maven](https://img.shields.io/maven-central/v/io.kokuwa.micronaut/micronaut-logging.svg?label=maven)](https://central.sonatype.com/artifact/io.kokuwa.micronaut/micronaut-logging)
[![license](https://img.shields.io/badge/license-EUPL%201.2-blue)](https://git.kokuwa.io/kokuwaio/micronaut-logging/src/branch/main/LICENSE)
[![issues](https://img.shields.io/gitea/issues/open/kokuwaio/micronaut-logging?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/micronaut-logging/issues)
[![prs](https://img.shields.io/gitea/pull-requests/open/kokuwaio/micronaut-logging?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/micronaut-logging/pulls)
[![build](https://ci.kokuwa.io/api/badges/kokuwaio/micronaut-logging/status.svg)](https://ci.kokuwa.io/repos/kokuwaio/micronaut-logging/)
For more documention see: [git.kokuwa.io/kokuwaio/micronaut-logging](https://git.kokuwa.io/kokuwaio/micronaut-logging)

View file

@ -1,12 +0,0 @@
# https://just.systems/man/en/
[private]
@default:
just --list --unsorted
# Run linter.
@lint:
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/yamllint
docker run --rm --read-only --volume=$(pwd):$(pwd):rw --workdir=$(pwd) kokuwaio/markdownlint --fix
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/renovate-config-validator
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) woodpeckerci/woodpecker-cli lint

View file

@ -1,9 +0,0 @@
# Default state for all rules
default: true
# MD009 - Trailing spaces
MD009:
strict: true
# MD013 - Line length
MD013: false

View file

@ -1,16 +0,0 @@
when:
instance: ci.kokuwa.io
repo: kokuwaio/micronaut-logging
event: [manual, push]
branch: main
path: [.woodpecker/deploy.yaml, pom.xml, src/main/**]
steps:
maven:
image: maven:3.9.10-eclipse-temurin-17
commands: mvn deploy --settings=.woodpecker/maven/settings.xml
environment:
MAVEN_GPG_KEY: {from_secret: woodpecker_gpg_key}
SONATYPE_ORG_USERNAME: {from_secret: sonatype_org_username}
SONATYPE_ORG_PASSWORD: {from_secret: sonatype_org_password}

View file

@ -1,21 +0,0 @@
when:
event: [manual, pull_request, push]
branch: main
path: [.woodpecker/lint.yaml, renovate.json, "**/*.y*ml", "**/*.md"]
steps:
renovate:
image: kokuwaio/renovate-config-validator
depends_on: []
when: [path: [.woodpecker/lint.yaml, renovate.json]]
yaml:
image: kokuwaio/yamllint
depends_on: []
when: [path: [.woodpecker/lint.yaml, .yamllint.yaml, "**/*.y*ml"]]
markdown:
image: kokuwaio/markdownlint
depends_on: []
when: [path: [.woodpecker/lint.yaml, .markdownlint.yaml, "**/*.md"]]

View file

@ -1,23 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
<interactiveMode>false</interactiveMode>
<localRepository>/woodpecker/.m2</localRepository>
<servers>
<server>
<id>git.kokuwa.io</id>
<username>${env.FORGEJO_USERNAME}</username>
<password>${env.FORGEJO_PASSWORD}</password>
</server>
<server>
<id>sonatype.org</id>
<username>${env.SONATYPE_ORG_USERNAME}</username>
<password>${env.SONATYPE_ORG_PASSWORD}</password>
</server>
</servers>
<mirrors>
<mirror>
<url>http://mirror.woodpecker.svc.cluster.local/maven2</url>
<mirrorOf>central</mirrorOf>
</mirror>
</mirrors>
</settings>

View file

@ -1,29 +0,0 @@
when:
instance: ci.kokuwa.io
repo: kokuwaio/micronaut-logging
event: deployment
branch: main
steps:
maven:
image: maven:3.9.10-eclipse-temurin-17
commands:
# setup git with ssk key signing
- git config user.email "$GIT_USER_EMAIL"
- git config user.name "$GIT_USER_NAME"
- git config commit.gpgsign true
- git config gpg.format ssh
- git config user.signingkey /run/secrets/sign.pub
- install -m 400 /dev/null /run/secrets/sign && echo "$GIT_SIGN_KEY" > /run/secrets/sign
- install -m 444 /dev/null /run/secrets/sign.pub && echo "$GIT_SIGN_PUB" > /run/secrets/sign.pub
# release
- mvn release:prepare release:perform --settings=.woodpecker/maven/settings.xml
environment:
MAVEN_GPG_KEY: {from_secret: woodpecker_gpg_key}
GIT_SIGN_KEY: {from_secret: woodpecker_sign_key}
GIT_SIGN_PUB: {from_secret: woodpecker_sign_pub}
FORGEJO_USERNAME: {from_secret: woodpecker_username}
FORGEJO_PASSWORD: {from_secret: woodpecker_password}
SONATYPE_ORG_USERNAME: {from_secret: sonatype_org_username}
SONATYPE_ORG_PASSWORD: {from_secret: sonatype_org_password}

View file

@ -1,9 +0,0 @@
when:
event: [manual, pull_request]
path: [.woodpecker/verify.yaml, pom.xml, src/**]
steps:
test:
image: maven:3.9.10-eclipse-temurin-17
commands: mvn verify --settings=.woodpecker/maven/settings.xml -P-deploy

View file

@ -1,15 +0,0 @@
extends: default
## see https://yamllint.readthedocs.io/en/stable/rules.html
rules:
# no need for document start
document-start: disable
# line length is not important
line-length: disable
# force double quotes everywhere
quoted-strings:
quote-type: double
required: only-when-needed

489
LICENSE
View file

@ -1,288 +1,201 @@
EUROPEAN UNION PUBLIC LICENCE v. 1.2
EUPL © the European Union 2007, 2016
This European Union Public Licence (the EUPL) applies to the Work (as defined
below) which is provided under the terms of this Licence. Any use of the Work,
other than as authorised under this Licence is prohibited (to the extent such
use is covered by a right of the copyright holder of the Work).
The Work is provided under the terms of this Licence when the Licensor (as
defined below) has placed the following notice immediately following the
copyright notice for the Work:
Licensed under the EUPL
or has expressed by any other means his willingness to license under the EUPL.
1. Definitions
In this Licence, the following terms have the following meaning:
- The Licence: this Licence.
- The Original Work: the work or software distributed or communicated by the
Licensor under this Licence, available as Source Code and also as Executable
Code as the case may be.
- Derivative Works: the works or software that could be created by the
Licensee, based upon the Original Work or modifications thereof. This Licence
does not define the extent of modification or dependence on the Original Work
required in order to classify a work as a Derivative Work; this extent is
determined by copyright law applicable in the country mentioned in Article 15.
- The Work: the Original Work or its Derivative Works.
- The Source Code: the human-readable form of the Work which is the most
convenient for people to study and modify.
- The Executable Code: any code which has generally been compiled and which is
meant to be interpreted by a computer as a program.
- The Licensor: the natural or legal person that distributes or communicates
the Work under the Licence.
- Contributor(s): any natural or legal person who modifies the Work under the
Licence, or otherwise contributes to the creation of a Derivative Work.
- The Licensee or You: any natural or legal person who makes any usage of
the Work under the terms of the Licence.
- Distribution or Communication: any act of selling, giving, lending,
renting, distributing, communicating, transmitting, or otherwise making
available, online or offline, copies of the Work or providing access to its
essential functionalities at the disposal of any other natural or legal
person.
2. Scope of the rights granted by the Licence
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
sublicensable licence to do the following, for the duration of copyright vested
in the Original Work:
- use the Work in any circumstance and for all usage,
- reproduce the Work,
- modify the Work, and make Derivative Works based upon the Work,
- communicate to the public, including the right to make available or display
the Work or copies thereof to the public and perform publicly, as the case may
be, the Work,
- distribute the Work or copies thereof,
- lend and rent the Work or copies thereof,
- sublicense rights in the Work or copies thereof.
Those rights can be exercised on any media, supports and formats, whether now
known or later invented, as far as the applicable law permits so.
In the countries where moral rights apply, the Licensor waives his right to
exercise his moral right to the extent allowed by law in order to make effective
the licence of the economic rights here above listed.
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
any patents held by the Licensor, to the extent necessary to make use of the
rights granted on the Work under this Licence.
3. Communication of the Source Code
The Licensor may provide the Work either in its Source Code form, or as
Executable Code. If the Work is provided as Executable Code, the Licensor
provides in addition a machine-readable copy of the Source Code of the Work
along with each copy of the Work that the Licensor distributes or indicates, in
a notice following the copyright notice attached to the Work, a repository where
the Source Code is easily and freely accessible for as long as the Licensor
continues to distribute or communicate the Work.
4. Limitations on copyright
Nothing in this Licence is intended to deprive the Licensee of the benefits from
any exception or limitation to the exclusive rights of the rights owners in the
Work, of the exhaustion of those rights or of other applicable limitations
thereto.
5. Obligations of the Licensee
The grant of the rights mentioned above is subject to some restrictions and
obligations imposed on the Licensee. Those obligations are the following:
Attribution right: The Licensee shall keep intact all copyright, patent or
trademarks notices and all notices that refer to the Licence and to the
disclaimer of warranties. The Licensee must include a copy of such notices and a
copy of the Licence with every copy of the Work he/she distributes or
communicates. The Licensee must cause any Derivative Work to carry prominent
notices stating that the Work has been modified and the date of modification.
Copyleft clause: If the Licensee distributes or communicates copies of the
Original Works or Derivative Works, this Distribution or Communication will be
done under the terms of this Licence or of a later version of this Licence
unless the Original Work is expressly distributed only under this version of the
Licence — for example by communicating EUPL v. 1.2 only. The Licensee
(becoming Licensor) cannot offer or impose any additional terms or conditions on
the Work or Derivative Work that alter or restrict the terms of the Licence.
Compatibility clause: If the Licensee Distributes or Communicates Derivative
Works or copies thereof based upon both the Work and another work licensed under
a Compatible Licence, this Distribution or Communication can be done under the
terms of this Compatible Licence. For the sake of this clause, Compatible
Licence refers to the licences listed in the appendix attached to this Licence.
Should the Licensee's obligations under the Compatible Licence conflict with
his/her obligations under this Licence, the obligations of the Compatible
Licence shall prevail.
Provision of Source Code: When distributing or communicating copies of the Work,
the Licensee will provide a machine-readable copy of the Source Code or indicate
a repository where this Source will be easily and freely available for as long
as the Licensee continues to distribute or communicate the Work.
Legal Protection: This Licence does not grant permission to use the trade names,
trademarks, service marks, or names of the Licensor, except as required for
reasonable and customary use in describing the origin of the Work and
reproducing the content of the copyright notice.
6. Chain of Authorship
The original Licensor warrants that the copyright in the Original Work granted
hereunder is owned by him/her or licensed to him/her and that he/she has the
power and authority to grant the Licence.
Each Contributor warrants that the copyright in the modifications he/she brings
to the Work are owned by him/her or licensed to him/her and that he/she has the
power and authority to grant the Licence.
Each time You accept the Licence, the original Licensor and subsequent
Contributors grant You a licence to their contributions to the Work, under the
terms of this Licence.
7. Disclaimer of Warranty
The Work is a work in progress, which is continuously improved by numerous
Contributors. It is not a finished work and may therefore contain defects or
bugs inherent to this type of development.
For the above reason, the Work is provided under the Licence on an as is basis
and without warranties of any kind concerning the Work, including without
limitation merchantability, fitness for a particular purpose, absence of defects
or errors, accuracy, non-infringement of intellectual property rights other than
copyright as stated in Article 6 of this Licence.
This disclaimer of warranty is an essential part of the Licence and a condition
for the grant of any rights to the Work.
8. Disclaimer of Liability
Except in the cases of wilful misconduct or damages directly caused to natural
persons, the Licensor will in no event be liable for any direct or indirect,
material or moral, damages of any kind, arising out of the Licence or of the use
of the Work, including without limitation, damages for loss of goodwill, work
stoppage, computer failure or malfunction, loss of data or any commercial
damage, even if the Licensor has been advised of the possibility of such damage.
However, the Licensor will be liable under statutory product liability laws as
far such laws apply to the Work.
9. Additional agreements
While distributing the Work, You may choose to conclude an additional agreement,
defining obligations or services consistent with this Licence. However, if
accepting obligations, You may act only on your own behalf and on your sole
responsibility, not on behalf of the original Licensor or any other Contributor,
and only if You agree to indemnify, defend, and hold each Contributor harmless
for any liability incurred by, or claims asserted against such Contributor by
the fact You have accepted any warranty or additional liability.
10. Acceptance of the Licence
The provisions of this Licence can be accepted by clicking on an icon I agree
placed under the bottom of a window displaying the text of this Licence or by
affirming consent in any other similar way, in accordance with the rules of
applicable law. Clicking on that icon indicates your clear and irrevocable
acceptance of this Licence and all of its terms and conditions.
Similarly, you irrevocably accept this Licence and all of its terms and
conditions by exercising any rights granted to You by Article 2 of this Licence,
such as the use of the Work, the creation by You of a Derivative Work or the
Distribution or Communication by You of the Work or copies thereof.
11. Information to the public
In case of any Distribution or Communication of the Work by means of electronic
communication by You (for example, by offering to download the Work from a
remote location) the distribution channel or media (for example, a website) must
at least provide to the public the information requested by the applicable law
regarding the Licensor, the Licence and the way it may be accessible, concluded,
stored and reproduced by the Licensee.
12. Termination of the Licence
The Licence and the rights granted hereunder will terminate automatically upon
any breach by the Licensee of the terms of the Licence.
Such a termination will not terminate the licences of any person who has
received the Work from the Licensee under the Licence, provided such persons
remain in full compliance with the Licence.
13. Miscellaneous
Without prejudice of Article 9 above, the Licence represents the complete
agreement between the Parties as to the Work.
If any provision of the Licence is invalid or unenforceable under applicable
law, this will not affect the validity or enforceability of the Licence as a
whole. Such provision will be construed or reformed so as necessary to make it
valid and enforceable.
The European Commission may publish other linguistic versions or new versions of
this Licence or updated versions of the Appendix, so far this is required and
reasonable, without reducing the scope of the rights granted by the Licence. New
versions of the Licence will be published with a unique version number.
All linguistic versions of this Licence, approved by the European Commission,
have identical value. Parties can take advantage of the linguistic version of
their choice.
14. Jurisdiction
Without prejudice to specific agreement between parties,
- any litigation resulting from the interpretation of this License, arising
between the European Union institutions, bodies, offices or agencies, as a
Licensor, and any Licensee, will be subject to the jurisdiction of the Court
of Justice of the European Union, as laid down in article 272 of the Treaty on
the Functioning of the European Union,
- any litigation arising between other parties and resulting from the
interpretation of this License, will be subject to the exclusive jurisdiction
of the competent court where the Licensor resides or conducts its primary
business.
15. Applicable Law
Without prejudice to specific agreement between parties,
- this Licence shall be governed by the law of the European Union Member State
where the Licensor has his seat, resides or has his registered office,
- this licence shall be governed by Belgian law if the Licensor has no seat,
residence or registered office inside a European Union Member State.
Appendix
Compatible Licences according to Article 5 EUPL are:
- GNU General Public License (GPL) v. 2, v. 3
- GNU Affero General Public License (AGPL) v. 3
- Open Software License (OSL) v. 2.1, v. 3.0
- Eclipse Public License (EPL) v. 1.0
- CeCILL v. 2.0, v. 2.1
- Mozilla Public Licence (MPL) v. 2
- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
works other than software
- European Union Public Licence (EUPL) v. 1.1, v. 1.2
- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
Reciprocity (LiLiQ-R+).
The European Commission may update this Appendix to later versions of the above
licences without producing a new version of the EUPL, as long as they provide
the rights granted in Article 2 of this Licence and protect the covered Source
Code from exclusive appropriation.
All other changes or additions to this Appendix require the production of a new
EUPL version.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

157
README.md
View file

@ -1,44 +1,131 @@
# Micronaut Logging support
Enhanced logging for Micronaut using MDC or request header.
[![maven](https://img.shields.io/maven-central/v/io.kokuwa.micronaut/micronaut-logging.svg?label=maven)](https://central.sonatype.com/artifact/io.kokuwa.micronaut/micronaut-logging)
[![license](https://img.shields.io/badge/license-EUPL%201.2-blue)](https://git.kokuwa.io/kokuwaio/micronaut-logging/src/branch/main/LICENSE)
[![issues](https://img.shields.io/gitea/issues/open/kokuwaio/micronaut-logging?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/micronaut-logging/issues)
[![prs](https://img.shields.io/gitea/pull-requests/open/kokuwaio/micronaut-logging?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/micronaut-logging/pulls)
[![build](https://ci.kokuwa.io/api/badges/kokuwaio/micronaut-logging/status.svg)](https://ci.kokuwa.io/repos/kokuwaio/micronaut-logging/)
Include in your `pom.xml`:
```xml
<dependency>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>micronaut-logging</artifactId>
<version>${version.io.kokuwa.micronaut.logging}</version>
<scope>runtime</scope>
</dependency>
<dependency>
<!-- you can replace jsonp with jackson if you prefer jackson -->
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jsonp</artifactId>
<scope>runtime</scope>
</dependency>
```
## Features
* Version [3.x](https://github.com/kokuwaio/micronaut-logging/tree/3.x) is based on SLF4J 1.7 & Logback 1.2 & Micronaut 3.x
* Version [4.x](https://github.com/kokuwaio/micronaut-logging/tree/main) is based on SLF4J 2.0 & Logback 1.4 & Micronaut 4.x
* [set log level based on MDC values](docs/features/logback_mdc_level.md)
* [add default xml](docs/features/logback_default.md)
* [preconfigured appender for different environments](docs/features/logback_appender.md)
* [set log level based on HTTP request header](docs/features/http_log_level.md)
* [add HTTP path parts to MDC](docs/features/http_mdc_path.md)
* [add HTTP header to MDC](docs/features/http_mdc_header.md)
* [add authentication information from HTTP request to MDC](docs/features/http_mdc_authentication.md)
### Preconfigured Appender
Buildin appender:
* console format
* stackdriver format (with support for error reporting)
### Set log level based on MDC values
Confguration:
* *enabled*: enable MDC filter (`true` is default)
* *key*: MDC key, is optional (will use name instead, see example `user` below)
* *level*: log level to use (`TRACE` is default)
* *loggers*: whitelist of logger names, matches all loggers if empty
* *values*: values for matching MDC key, matches all values if empty
Example for setting different values for different values/logger:
```
logger:
levels:
io.kokuwa: INFO
mdc:
gateway-debug:
key: gateway
level: DEBUG
loggers:
- io.kokuwa
values:
- 6a1bae7f-eb6c-4c81-af9d-dc15396584e2
- fb3318f1-2c73-48e9-acd4-a2be3c9f9256
gateway-trace:
key: gateway
level: TRACE
loggers:
- io.kokuwa
- io.micronaut
values:
- 257802b2-22fe-4dcc-bb99-c1db2a47861f
```
Example for omiting level and key:
```
logger:
levels:
io.kokuwa: INFO
mdc:
gateway:
loggers:
- io.kokuwa
values:
- 257802b2-22fe-4dcc-bb99-c1db2a47861f
- 0a44738b-0c3a-4798-8210-2495485f10b2
```
Example for minimal configuration:
```
logger:
levels:
io.kokuwa: INFO
mdc:
user: {}
```
### Set log level based on HTTP request header
Confguration:
* *enabled*: enable HTTP request filter (`true` is default)
* *order*: order for [Ordered](https://github.com/micronaut-projects/micronaut-core/blob/master/core/src/main/java/io/micronaut/core/order/Ordered.java) (highest is default)
* *pattern*: filter pattern (`/**` is default)
* *header*: name of HTTP header (`x-log-level` is default)
Example with default configuration:
```
logger:
request:
header:
enabled: true
order: -2147483648
pattern: /**
header: x-log-level
```
### Add princial for request to MDC
Confguration:
* *enabled*: enable HTTP principal filter (`true` is default)
* *order*: order for [Ordered](https://github.com/micronaut-projects/micronaut-core/blob/master/core/src/main/java/io/micronaut/core/order/Ordered.java) ([ServerFilterPhase.SECURITY.after()](https://github.com/micronaut-projects/micronaut-core/blob/v2.0.1/http/src/main/java/io/micronaut/http/filter/ServerFilterPhase.java#L54) is default)
* *pattern*: filter pattern (`/**` is default)
* *key*: name of MDC header (`principal` is default)
Example with default configuration:
```
logger:
request:
principal:
enabled: true
order: 39250
pattern: /**
key: principal
```
## Build & Release
### Dependency updates
Display dependency updates:
```
mvn versions:display-property-updates -U
```
Update dependencies:
```
mvn versions:update-properties
```
### Release locally
Run:
```
mvn release:prepare release:perform release:clean -B
```
## Open Topics
* configure mdc on refresh event
* add stackdriver per configuration
* add fluent per configuration
* read **serviceName** and **serviceVersion** from yaml
* support auto select appender with custom `logback.xml`

View file

@ -1,35 +0,0 @@
# Set log level based on HTTP request header
With this features it is possible to set the log level while processing a request by adding the http header `x-log-level` with value `TRACE`. This log level is propagated to HTTP client requests.
## Properties
Property | Description | Default
-------- | ----------- | -------
`logger.http.level.enabled` | filter enabled? | `true`
`logger.http.level.path` | filter path | `/**`
`logger.http.level.order` | order for [Ordered](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/core/src/main/java/io/micronaut/core/order/Ordered.java) | [ServerFilterPhase.FIRST.before()](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/http/src/main/java/io/micronaut/http/filter/ServerFilterPhase.java#L34)
`logger.http.level.header` | name of HTTP header | `x-log-level`
`logger.http.level.propagation.enabled` | propagation enabled? | `true`
`logger.http.level.propagation.path` | propagation path | `/**`
`logger.http.level.propagation.order` | order for [Ordered](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/core/src/main/java/io/micronaut/core/order/Ordered.java) | [Order.HIGHEST_PRECEDENCE](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/core/src/main/java/io/micronaut/core/order/Ordered.java#L30)
`logger.http.level.propagation.header` | name of HTTP header | see `logger.http.level.header`
## Examples
Default configuration:
```yaml
logger:
http:
level:
enabled: true
order: -1000
path: /**
header: x-log-level
propagation:
enabled: true
order: 2147483648
path: /**
header: ${logger.http.level.header}
```

View file

@ -1,29 +0,0 @@
# Add authentication information to MDC
This only applies to HTTP requests with successful security authentication.
## Properties
Property | Description | Default
-------- | ----------- | -------
`logger.http.authentication.enabled` | filter enabled? | `true`
`logger.http.authentication.path` | filter path | `/**`
`logger.http.authentication.order` | order for [Ordered](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/core/src/main/java/io/micronaut/core/order/Ordered.java) | [ServerFilterPhase.SECURITY.after()](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/http/src/main/java/io/micronaut/http/filter/ServerFilterPhase.java#L54)
`logger.http.authentication.prefix` | prefix to MDC key | ``
`logger.http.authentication.name` | MDC key of authentication name | `principal`
`logger.http.authentication.attributes` | authentication attributes to add to MDC, | `[]`
## Examples
Configuration for adding some jwt claims:
```yaml
logger:
http:
authentication:
prefix: jwt.
name: sub
attributes:
- aud
- azp
```

View file

@ -1,28 +0,0 @@
# Add HTTP headers to MDC
## Properties
Property | Description | Default
-------- | ----------- | -------
`logger.http.header.enabled` | filter enabled? | `true`
`logger.http.header.path` | filter path | `/**`
`logger.http.header.order` | order for [Ordered](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/core/src/main/java/io/micronaut/core/order/Ordered.java) | [ServerFilterPhase.FIRST.before()](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/http/src/main/java/io/micronaut/http/filter/ServerFilterPhase.java#L34)
`logger.http.header.prefix` | prefix to MDC key | ``
`logger.http.header.names` | http header names to add to MDC | `[]`
## Examples
Configuration for b3-propagation:
```yaml
logger:
http:
header:
prefix: header.
names:
- x-request-id
- x-b3-traceId
- x-b3-parentspanid
- x-b3-spanid
- x-b3-sampled
```

View file

@ -1,25 +0,0 @@
# Add HTTP path parts to MDC
## Properties
Property | Description | Default
-------- | ----------- | -------
`logger.http.path.enabled` | filter enabled? | `true`
`logger.http.path.path` | filter path | `/**`
`logger.http.path.order` | order for [Ordered](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/core/src/main/java/io/micronaut/core/order/Ordered.java) | [ServerFilterPhase.FIRST.before()](https://github.com/micronaut-projects/micronaut-core/blob/v3.2.0/http/src/main/java/io/micronaut/http/filter/ServerFilterPhase.java#L34)
`logger.http.path.prefix` | prefix to MDC key | ``
`logger.http.path.patterns` | patterns with groups to add to MDC | `[]`
## Examples
Configuration for adding ids:
```yaml
logger:
http:
path:
prefix: path.
patterns:
- \/gateway\/(?<gatewayId>[a-f0-9\-]{36})
- \/gateway\/(?<gatewayId>[a-f0-9\-]{36})\/configuration\/(?<config>[a-z]+)
```

View file

@ -1,14 +0,0 @@
# Appender
## Available Appender
* console with jansi for developers
* gcp logging format (with support for error reporting)
* json
## AutoSelect appender
1. if `LOGBACK_APPENDER` is set this appender will be used
2. if GCP is detected gcp appender will be used
3. if Kubernetes is detected json appender will be used
4. console appender else

View file

@ -1,16 +0,0 @@
# Add default logback.xml
If no `logback.xml` by user is provided a default [logback.xml](../../src/main/resources/io/kokuwa/logback/logback-default.xml) is loaded. Otherwise use custom [logback.xml](../../src/main/resources/io/kokuwa/logback/logback-example.xml):
```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="false">
<logger name="io.micronaut.logging.PropertiesLoggingLevelsConfigurer" levels="WARN" />
<root level="INFO">
<autoAppender />
</root>
</configuration>
```

View file

@ -1,66 +0,0 @@
# Set log level based on MDC values
This can be used to change the log level based on MDC valus. E.g. change log levels for specific users/services etc.
## Properties
Property | Description | Default
-------- | ----------- | -------
`logger.mdc.enabled` | MDC enabled? | `true`
`logger.mdc.<key>` | MDC key to use | ``
`logger.mdc.<key>.key` | MDC key override, see complex example below for usage | `<key>`
`logger.mdc.<key>.level` | log level to use | `TRACE`
`logger.mdc.<key>.loggers` | passlist of logger names, matches all loggers if empty | `[]`
`logger.mdc.<key>.values` | values for matching MDC key, matches all values if empty | `[]`
## Examples
Minimal configuration that logs everything with `TRACE` if MDC `principal` is present:
```yaml
logger:
levels:
io.kokuwa: INFO
mdc:
principal: {}
```
Configuration that logs everything with `TRACE` for logger `io.kokuwa` if MDC `gateway` matches one value:
```yaml
logger:
levels:
io.kokuwa: INFO
mdc:
gateway:
loggers:
- io.kokuwa
values:
- 257802b2-22fe-4dcc-bb99-c1db2a47861f
- 0a44738b-0c3a-4798-8210-2495485f10b2
```
Complex example with setting different values for different values/logger:
```yaml
logger:
levels:
io.kokuwa: INFO
mdc:
gateway-debug:
key: gateway
level: DEBUG
loggers:
- io.kokuwa
values:
- 6a1bae7f-eb6c-4c81-af9d-dc15396584e2
- fb3318f1-2c73-48e9-acd4-a2be3c9f9256
gateway-trace:
key: gateway
level: TRACE
loggers:
- io.kokuwa
- io.micronaut
values:
- 257802b2-22fe-4dcc-bb99-c1db2a47861f
```

456
pom.xml
View file

@ -1,73 +1,80 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa</groupId>
<artifactId>maven-parent</artifactId>
<version>0.1.0</version>
<relativePath />
</parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>micronaut-logging</artifactId>
<version>5.0.1-SNAPSHOT</version>
<version>0.0.2</version>
<name>Logging Support for Micronaut</name>
<description>Enhanced logging using MDC or request header.</description>
<url>https://git.kokuwa.io/kokuwaio/micronaut-logging</url>
<name>Micronaut Logging Support</name>
<description>TODO</description>
<url>https://github.com/kokuwaio/micronaut-logging</url>
<inceptionYear>2020</inceptionYear>
<organization>
<name>Kokuwa.io</name>
<url>http://kokuwa.io</url>
</organization>
<licenses>
<license>
<name>EUPL-1.2</name>
<url>https://eupl.eu/1.2/en</url>
<distribution>repo</distribution>
<name>Apache License 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0</url>
</license>
</licenses>
<developers>
<developer>
<id>stephan.schnabel</id>
<name>Stephan Schnabel</name>
<url>https://schnabel.org</url>
<email>stephan@schnabel.org</email>
<timezone>Europe/Berlin</timezone>
</developer>
</developers>
<scm>
<url>https://git.kokuwa.io/kokuwaio/micronaut-logging</url>
<connection>scm:git:https://git.kokuwa.io/kokuwaio/micronaut-logging.git</connection>
<developerConnection>scm:git:https://git.kokuwa.io/kokuwaio/micronaut-logging.git</developerConnection>
<tag>HEAD</tag>
<url>https://github.com/kokuwaio/micronaut-logging</url>
<connection>scm:git:https://github.com/kokuwaio/micronaut-logging.git</connection>
<developerConnection>scm:git:https://github.com/kokuwaio/micronaut-logging.git</developerConnection>
<tag>0.0.2</tag>
</scm>
<issueManagement>
<system>forgejo</system>
<url>https://git.kokuwa.io/kokuwaio/micronaut-logging/issues</url>
<system>github</system>
<url>https://github.com/kokuwaio/micronaut-logging/issues</url>
</issueManagement>
<ciManagement>
<system>woodpecker</system>
<url>https://ci.kokuwa.io/repos/kokuwaio/micronaut-logging</url>
</ciManagement>
<distributionManagement>
<snapshotRepository>
<id>sonatype.org</id>
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
</snapshotRepository>
</distributionManagement>
<properties>
<project.build.outputTimestamp>2025-06-27T18:11:48Z</project.build.outputTimestamp>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.release>17</maven.compiler.release>
<!-- ===================================================================== -->
<!-- ============================= Libaries ============================== -->
<!-- ===================================================================== -->
<version.ch.qos.logback.contrib>0.1.5</version.ch.qos.logback.contrib>
<version.io.micronaut>2.0.1</version.io.micronaut>
</properties>
<dependencyManagement>
<dependencies>
<!-- micronaut -->
<dependency>
<groupId>io.micronaut.platform</groupId>
<artifactId>micronaut-platform</artifactId>
<version>4.9.0</version>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-bom</artifactId>
<version>${version.io.micronaut}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- logback -->
<dependency>
<groupId>ch.qos.logback.contrib</groupId>
<artifactId>logback-json-classic</artifactId>
<version>${version.ch.qos.logback.contrib}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback.contrib</groupId>
<artifactId>logback-json-core</artifactId>
<version>${version.ch.qos.logback.contrib}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback.contrib</groupId>
<artifactId>logback-jackson</artifactId>
<version>${version.ch.qos.logback.contrib}</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
@ -75,18 +82,9 @@
<!-- micronaut -->
<dependency>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-http</artifactId>
<artifactId>micronaut-runtime</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>io.micronaut.security</groupId>
<artifactId>micronaut-security</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-api</artifactId>
</dependency>
<dependency>
<groupId>io.micronaut.test</groupId>
<artifactId>micronaut-test-junit5</artifactId>
@ -107,360 +105,52 @@
<artifactId>micronaut-security-jwt</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jackson</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<scope>test</scope>
</dependency>
<!-- library -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
<!-- slf4j/logback -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<!-- logging -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<groupId>ch.qos.logback.contrib</groupId>
<artifactId>logback-jackson</artifactId>
</dependency>
<dependency>
<groupId>ch.qos.logback.contrib</groupId>
<artifactId>logback-json-classic</artifactId>
</dependency>
</dependencies>
<build>
<defaultGoal>verify</defaultGoal>
<pluginManagement>
<testResources>
<testResource>
<directory>src/test/resources</directory>
<filtering>true</filtering>
</testResource>
</testResources>
<plugins>
<!-- add compiler processors -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.14.0</version>
<configuration>
<implicit>class</implicit>
<showDeprecation>true</showDeprecation>
<showWarnings>true</showWarnings>
<failOnWarning>true</failOnWarning>
<compilerArgument>-Xlint:all,-processing</compilerArgument>
<annotationProcessorPaths>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${version.org.projectlombok}</version>
</path>
<path>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-inject-java</artifactId>
<version>${version.io.micronaut}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>3.1.4</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>3.2.7</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<version>3.1.4</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-invoker-plugin</artifactId>
<version>3.9.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.4.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.11.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>3.1.1</version>
<configuration>
<preparationGoals>verify</preparationGoals>
<preparationProfiles>check</preparationProfiles>
<goals>deploy</goals>
<releaseProfiles>deploy,release</releaseProfiles>
<signTag>true</signTag>
<scmReleaseCommitComment>@{prefix} prepare release @{releaseLabel} [CI SKIP]</scmReleaseCommitComment>
<tagNameFormat>@{project.version}</tagNameFormat>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.3.1</version>
<configuration>
<propertiesEncoding>ISO-8859-1</propertiesEncoding>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.3.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.5.3</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
<version>1.4.0</version>
</plugin>
<plugin>
<groupId>org.sonatype.central</groupId>
<artifactId>central-publishing-maven-plugin</artifactId>
<version>0.8.0</version>
</plugin>
<plugin>
<groupId>net.revelc.code.formatter</groupId>
<artifactId>formatter-maven-plugin</artifactId>
<version>2.27.0</version>
<configuration>
<configFile>${project.basedir}/src/eclipse/formatter.xml</configFile>
</configuration>
</plugin>
<plugin>
<groupId>net.revelc.code</groupId>
<artifactId>impsort-maven-plugin</artifactId>
<version>1.12.0</version>
<configuration>
<removeUnused>true</removeUnused>
<groups>java.,javax.,jakarta.,org.</groups>
</configuration>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<!-- run invoker tests -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-invoker-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>install</goal>
<goal>integration-test</goal>
<goal>verify</goal>
</goals>
<configuration>
<cloneProjectsTo>${project.build.directory}/its</cloneProjectsTo>
<mergeUserSettings>true</mergeUserSettings>
<goals>test</goals>
<streamLogs>false</streamLogs>
<streamLogsOnFailures>true</streamLogsOnFailures>
</configuration>
</execution>
</executions>
</plugin>
<!-- disable default executions -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<executions>
<execution>
<id>default-install</id>
<phase />
</execution>
</executions>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>dev</id>
<activation>
<property>
<name>!env.CI</name>
</property>
</activation>
<properties>
<maven.test.redirectTestOutputToFile>true</maven.test.redirectTestOutputToFile>
</properties>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
<executions>
<execution>
<phase>validate</phase>
<goals>
<goal>pom</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>net.revelc.code</groupId>
<artifactId>impsort-maven-plugin</artifactId>
<executions>
<execution>
<phase>validate</phase>
<goals>
<goal>sort</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>net.revelc.code.formatter</groupId>
<artifactId>formatter-maven-plugin</artifactId>
<executions>
<execution>
<phase>validate</phase>
<goals>
<goal>format</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>check</id>
<activation>
<property>
<name>env.CI</name>
</property>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
<executions>
<execution>
<phase>validate</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>net.revelc.code</groupId>
<artifactId>impsort-maven-plugin</artifactId>
<executions>
<execution>
<phase>validate</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>net.revelc.code.formatter</groupId>
<artifactId>formatter-maven-plugin</artifactId>
<executions>
<execution>
<phase>validate</phase>
<goals>
<goal>validate</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>deploy</id>
<activation>
<property>
<name>env.CI</name>
</property>
</activation>
<build>
<plugins>
<!-- add source/javadoc -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- sign before upload -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>sign</goal>
</goals>
<configuration>
<signer>bc</signer>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.sonatype.central</groupId>
<artifactId>central-publishing-maven-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<publishingServerId>sonatype.org</publishingServerId>
<autoPublish>true</autoPublish>
<waitUntil>published</waitUntil>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>

View file

@ -1,8 +0,0 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["local>kokuwaio/renovate-config", ":reviewer(stephan.schnabel)"],
"packageRules": [{
"matchPackageNames": ["io.kokuwa.micronaut:mirconaut-logging-it"],
"enabled": false
}]
}

View file

@ -1,404 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<profiles version="23">
<profile kind="CodeFormatterProfile" name="kokuwa.io" version="23">
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_ellipsis" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_for_statment" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.comment.new_lines_at_block_boundaries" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_package" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_annotation_type_member_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true" />
<setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_enum_constant_declaration" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.align_with_spaces" value="false" />
<setting id="org.eclipse.jdt.core.formatter.continuation_indentation" value="2" />
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_before_code_block" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_switch_case_expressions" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_package" value="1" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_local_declarations" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags" value="false" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_or_operator_multicatch" value="true" />
<setting id="org.eclipse.jdt.core.formatter.enabling_tag" value="@formatter:on" />
<setting id="org.eclipse.jdt.core.formatter.comment.count_line_length_from_starting_position" value="true" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_record_components" value="16" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_multiplicative_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_explicitconstructorcall_arguments" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_method" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameterized_type_references" value="0" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_logical_operator" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_annotation_declaration_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_record_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_enum_constant" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_multiplicative_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_and_in_type_parameter" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_assignment_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_type_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_for" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_abstract_method" value="1" />
<setting id="org.eclipse.jdt.core.formatter.keep_enum_constant_declaration_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.align_variable_declarations_on_columns" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invocation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_union_type_in_multicatch" value="16" />
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body" value="0" />
<setting id="org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_catch_clause" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_parameterized_type_reference" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="16" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiplicative_operator" value="16" />
<setting id="org.eclipse.jdt.core.formatter.keep_anonymous_type_declaration_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_switch_case_expressions" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_shift_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header" value="true" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_end_of_code_block" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_bitwise_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_parameters" value="0" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_loops" value="16" />
<setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_block_comment" value="false" />
<setting id="org.eclipse.jdt.core.formatter.keep_simple_for_body_on_same_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_switch_case_arrow_operator" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_unary_operator" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.format_line_comment_starting_on_first_column" value="true" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_annotation" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_ellipsis" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_try_resources" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_assert" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_enum_constant" value="49" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.text_block_indentation" value="0" />
<setting id="org.eclipse.jdt.core.formatter.align_type_members_on_columns" value="false" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment" value="0" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_module_statements" value="16" />
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_names_descriptions" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_enum_constant" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_if_then_body_block_on_one_line" value="one_line_preserve" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_parameters" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.format_guardian_clause_on_one_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_if" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_permitted_types" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block_in_case" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_constructor_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression_chain" value="0" />
<setting id="org.eclipse.jdt.core.formatter.comment.format_header" value="true" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_annotations" value="0" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression" value="16" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_assertion_message_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_method_declaration" value="0" />
<setting id="org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines" value="2147483647" />
<setting id="org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries" value="true" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_bitwise_operator" value="16" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_resources_in_try" value="80" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation" value="16" />
<setting id="org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_allocation_expression" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.format_source_code" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_array_initializer" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_field" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_method" value="1" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_throw" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_not_operator" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_type_annotation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.format_html" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation_type_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_delcaration" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_if" value="16" />
<setting id="org.eclipse.jdt.core.formatter.indent_empty_lines" value="false" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_arguments" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_unary_operator" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_enum_constant" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_annotation" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_package" value="49" />
<setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_label" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_cast" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_case" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_type_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_permitted_types_in_type_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_record_header" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_bitwise_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.comment.javadoc_do_not_separate_block_tags" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_try" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_lambda_arrow" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.indent_tag_description" value="false" />
<setting id="org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_record_constructor" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_string_concatenation" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_allocation_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiple_fields" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_array_initializer" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_shift_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_catch" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_shift_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_local_declarations" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_simple_do_while_body_on_same_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_annotation_type_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_record_components" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.wrap_outer_expressions_when_nested" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_paren_in_cast" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation_type_member_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_for_loop_header" value="0" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_additive_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.keep_simple_getter_setter_on_one_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block_in_case_after_arrow" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_string_concatenation" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_lambda_arrow" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.join_lines_in_comments" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_record_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_relational_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_field_declarations" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_between_import_groups" value="1" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_at_in_annotation_type_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_logical_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_invocation" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_imports" value="1" />
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_record_declaration" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_throws" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_switch_statement" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_increments" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_default" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_inits" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.disabling_tag" value="@formatter:off" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="16" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_imports" value="1" />
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_end_of_method_body" value="0" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_if_while_statement" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_brace_in_block" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_return" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_case" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_field" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations" value="1" />
<setting id="org.eclipse.jdt.core.formatter.keep_switch_body_block_on_one_line" value="one_line_never" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_for" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_catch" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_anonymous_type_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_inits" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_block" value="true" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_switch_case_with_arrow" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_switch" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_descriptions_grouped" value="true" />
<setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="120" />
<setting id="org.eclipse.jdt.core.formatter.use_on_off_tags" value="false" />
<setting id="org.eclipse.jdt.core.formatter.keep_method_body_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_brackets_in_array_allocation_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_loop_body_block_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_constant" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_method_declaration" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_for" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_type_declaration_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_additive_operator" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_field_declarations" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_constructor" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_relational_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_record_declaration_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_lambda_body" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.compact_else_if" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_catch" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invocation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation" value="16" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_try" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_parameter" value="0" />
<setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment" value="false" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_relational_operator" value="0" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer" value="16" />
<setting id="org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve" value="1" />
<setting id="org.eclipse.jdt.core.formatter.align_arrows_in_switch_on_columns" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_case" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_additive_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_if" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_string_concatenation" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="true" />
<setting id="org.eclipse.jdt.core.formatter.align_selector_in_method_invocation_on_expression_first_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_record_declaration" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_labeled_statement" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_switch_case_with_arrow_on_one_line" value="one_line_never" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_switch_case_with_colon" value="0" />
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_after_code_block" value="0" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression" value="80" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_type" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_type" value="49" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_local_variable" value="49" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_default" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_between_different_tags" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_additive_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invocation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_field" value="49" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_conditional_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.join_line_comments" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_shift_operator" value="0" />
<setting id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations" value="false" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_try_clause" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.keep_code_block_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_throws" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_record_components" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_bitwise_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_conditional" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_try" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_try_resources" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer" value="2" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_record_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_assignment_operator" value="false" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_switch" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_parameters" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_switch_case_with_arrow" value="0" />
<setting id="org.eclipse.jdt.core.formatter.keep_lambda_body_block_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_method" value="49" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_parameterized_type_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_record_constructor_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line" value="true" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_assertion_message" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_constructor_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk" value="1" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_member_type" value="1" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_logical_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression" value="16" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_record_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_if" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_relational_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_postfix_operator" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_cast" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="true" />
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration" value="16" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_throws" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_last_class_body_declaration" value="0" />
<setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_body" value="true" />
<setting id="org.eclipse.jdt.core.formatter.keep_simple_while_body_on_same_line" value="false" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_logical_operator" value="true" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_between_statement_group_in_switch" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_lambda_declaration" value="common_lines" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_permitted_types" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_reference" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.keep_enum_declaration_on_one_line" value="one_line_if_empty" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_constant" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_type_declaration" value="end_of_line" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_multiplicative_operator" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_package" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_for" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_increments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_explicitconstructorcall_arguments" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header" value="true" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_constructor_declaration" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_throws" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional" value="insert" />
<setting id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description" value="false" />
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_code_block" value="0" />
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="tab" />
<setting id="org.eclipse.jdt.core.formatter.wrap_before_string_concatenation" value="true" />
<setting id="org.eclipse.jdt.core.formatter.lineSplit" value="120" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation" value="do not insert" />
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch" value="insert" />
</profile>
</profiles>

View file

@ -1,3 +0,0 @@
invoker.environmentVariables.KUBERNETES_SERVICE_HOST=
invoker.environmentVariables.LOGBACK_APPENDER=
invoker.environmentVariables.GOOGLE_CLOUD_PROJECT=

View file

@ -1 +0,0 @@
invoker.environmentVariables.LOGGER_LEVELS_IO_KOKUWA_MICRONAUT_LOGGING=DEBUG

View file

@ -1,12 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-level-from-micronaut</artifactId>
</project>

View file

@ -1,22 +0,0 @@
// verify log
String expected = "^[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{0,3} main DEBUG i.k.m.logging.LoggingTest test-output-marker$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log.replaceAll("\u001B\\[[;\\d]*m", ""))) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
System.out.println("[BASE64] " + Base64.getEncoder().encodeToString(log.getBytes()));
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1 +0,0 @@
invoker.environmentVariables.LOGBACK_APPENDER=GCP

View file

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-gcp-from-env</artifactId>
<dependencies>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jsonp</artifactId>
</dependency>
</dependencies>
</project>

View file

@ -1,21 +0,0 @@
// verify log
String expected = "^\\{\"time\":\"202[3-9]-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{0,3}Z\",\"severity\":\"INFO\",\"thread\":\"main\",\"logger\":\"io.kokuwa.micronaut.logging.LoggingTest\",\"message\":\"test-output-marker\",\"raw-message\":\"test-output-marker\"}$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log)) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1 +0,0 @@
invoker.environmentVariables.GOOGLE_CLOUD_PROJECT=value

View file

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-gcp-from-gcloud</artifactId>
<dependencies>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jsonp</artifactId>
</dependency>
</dependencies>
</project>

View file

@ -1,21 +0,0 @@
// verify log
String expected = "^\\{\"time\":\"202[3-9]-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{0,3}Z\",\"severity\":\"INFO\",\"thread\":\"main\",\"logger\":\"io.kokuwa.micronaut.logging.LoggingTest\",\"message\":\"test-output-marker\",\"raw-message\":\"test-output-marker\"}$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log)) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1,3 +0,0 @@
invoker.environmentVariables.LOGBACK_APPENDER=GCP
invoker.environmentVariables.SERVICE_NAME=test-service
invoker.environmentVariables.SERVICE_VERSION=0.1.2

View file

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-gcp-with-service</artifactId>
<dependencies>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jsonp</artifactId>
</dependency>
</dependencies>
</project>

View file

@ -1,21 +0,0 @@
// verify log
String expected = "^\\{\"time\":\"202[3-9]-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{0,3}Z\",\"severity\":\"INFO\",\"thread\":\"main\",\"logger\":\"io.kokuwa.micronaut.logging.LoggingTest\",\"message\":\"test-output-marker\",\"raw-message\":\"test-output-marker\",\"serviceContext\":\\{\"service\":\"test-service\",\"version\":\"0.1.2\"}}$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log)) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1 +0,0 @@
invoker.environmentVariables.LOGBACK_APPENDER=JSON

View file

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-json-from-env-serde-jackson</artifactId>
<dependencies>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jackson</artifactId>
</dependency>
</dependencies>
</project>

View file

@ -1,21 +0,0 @@
// verify log
String expected = "^\\{\"timestamp\":\"[0-9]{13}\",\"level\":\"INFO\",\"thread\":\"main\",\"logger\":\"io.kokuwa.micronaut.logging.LoggingTest\",\"message\":\"test-output-marker\",\"raw-message\":\"test-output-marker\"}$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log)) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1 +0,0 @@
invoker.environmentVariables.LOGBACK_APPENDER=JSON

View file

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-json-from-env-serde-jsonp</artifactId>
<dependencies>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jsonp</artifactId>
</dependency>
</dependencies>
</project>

View file

@ -1,21 +0,0 @@
// verify log
String expected = "^\\{\"timestamp\":\"[0-9]{13}\",\"level\":\"INFO\",\"thread\":\"main\",\"logger\":\"io.kokuwa.micronaut.logging.LoggingTest\",\"message\":\"test-output-marker\",\"raw-message\":\"test-output-marker\"}$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log)) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1 +0,0 @@
invoker.environmentVariables.LOGBACK_APPENDER=JSON

View file

@ -1,12 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-json-from-env-serde-missing</artifactId>
</project>

View file

@ -1,5 +0,0 @@
// verify log
return org.codehaus.plexus.util.FileUtils
.fileRead(basedir + "/build.log")
.contains("Failed to get object mapper from micronaut, please check your classpath");

View file

@ -1 +0,0 @@
invoker.environmentVariables.KUBERNETES_SERVICE_HOST=value

View file

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-json-from-kubernetes</artifactId>
<dependencies>
<dependency>
<groupId>io.micronaut.serde</groupId>
<artifactId>micronaut-serde-jsonp</artifactId>
</dependency>
</dependencies>
</project>

View file

@ -1,21 +0,0 @@
// verify log
String expected = "^\\{\"timestamp\":\"[0-9]{13}\",\"level\":\"INFO\",\"thread\":\"main\",\"logger\":\"io.kokuwa.micronaut.logging.LoggingTest\",\"message\":\"test-output-marker\",\"raw-message\":\"test-output-marker\"}$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log)) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1,12 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-text</artifactId>
</project>

View file

@ -1,22 +0,0 @@
// verify log
String expected = "^[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{0,3} main INFO i.k.m.logging.LoggingTest test-output-marker$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log.replaceAll("\u001B\\[[;\\d]*m", ""))) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
System.out.println("[BASE64] " + Base64.getEncoder().encodeToString(log.getBytes()));
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1,12 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
</parent>
<artifactId>mirconaut-logging-it-log-text</artifactId>
</project>

View file

@ -1,21 +0,0 @@
// verify log
String expected = "^TRACE io.kokuwa.micronaut.logging.LoggingTest test-output-marker$";
String[] logs = org.codehaus.plexus.util.FileUtils.fileRead(basedir + "/build.log").split("\n");
for (String log : logs) {
if (!log.contains("test-output-marker")) {
continue;
}
if (java.util.regex.Pattern.matches(expected, log)) {
return true;
} else {
System.out.println("marker found, but formatting invalid:");
System.out.println("[EXPECTED] " + expected);
System.out.println("[ACTUAL] " + log);
return false;
}
}
System.out.println("marker not found");
return false;

View file

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%-5level %logger{40} %msg%n</pattern>
</encoder>
</appender>
<logger name="io.kokuwa.micronaut.logging" level="TRACE" />
<root level="WARN">
<appender-ref ref="STDOUT" />
</root>
</configuration>

View file

@ -1,122 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>mirconaut-logging-it</artifactId>
<version>LOCAL-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>log-text</module>
<module>log-json-from-env</module>
<module>log-json-from-kubernetes</module>
<module>log-gcp-from-env</module>
<module>log-gcp-from-gcloud</module>
<module>level-from-micronaut</module>
<module>logback-xml-custom</module>
</modules>
<properties>
<project.build.outputTimestamp>2025-06-27T00:00:00Z</project.build.outputTimestamp>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.release>17</maven.compiler.release>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>micronaut-logging</artifactId>
<version>@project.version@</version>
</dependency>
<dependency>
<groupId>io.micronaut.platform</groupId>
<artifactId>micronaut-platform</artifactId>
<version>4.9.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<!-- micronaut -->
<dependency>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-runtime</artifactId>
</dependency>
<dependency>
<groupId>io.micronaut.test</groupId>
<artifactId>micronaut-test-junit5</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.kokuwa.micronaut</groupId>
<artifactId>micronaut-logging</artifactId>
<scope>runtime</scope>
</dependency>
</dependencies>
<build>
<testSourceDirectory>${project.basedir}/../src/test/java</testSourceDirectory>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.14.0</version>
<configuration>
<implicit>class</implicit>
<showDeprecation>true</showDeprecation>
<showWarnings>true</showWarnings>
<failOnWarning>true</failOnWarning>
<compilerArgument>-Xlint:all,-processing</compilerArgument>
<annotationProcessorPaths>
<path>
<groupId>io.micronaut</groupId>
<artifactId>micronaut-inject-java</artifactId>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.3.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.5.3</version>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<!-- remove default invocations -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>default-resources</id>
<phase />
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<executions>
<execution>
<id>default-compile</id>
<phase />
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

View file

@ -1,13 +0,0 @@
package io.kokuwa.micronaut.logging;
@io.micronaut.test.extensions.junit5.annotation.MicronautTest
public class LoggingTest {
@org.junit.jupiter.api.Test
void log() {
var log = org.slf4j.LoggerFactory.getLogger(LoggingTest.class);
log.trace("test-output-marker");
log.debug("test-output-marker");
log.info("test-output-marker");
}
}

View file

@ -4,7 +4,7 @@ import java.util.Objects;
import java.util.Optional;
import java.util.function.Supplier;
import jakarta.inject.Singleton;
import javax.inject.Singleton;
import org.slf4j.LoggerFactory;
@ -12,6 +12,7 @@ import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.turbo.TurboFilter;
import io.micronaut.context.annotation.BootstrapContextCompatible;
import io.micronaut.context.annotation.Requires;
import io.micronaut.core.annotation.Internal;
/**
* Utility class for Logback operations.
@ -21,6 +22,7 @@ import io.micronaut.context.annotation.Requires;
@Requires(classes = LoggerContext.class)
@BootstrapContextCompatible
@Singleton
@Internal
public class LogbackUtil {
private final LoggerContext context;

View file

@ -1,33 +1,48 @@
package io.kokuwa.micronaut.logging.layout;
package io.kokuwa.micronaut.logging;
import java.time.Instant;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.contrib.jackson.JacksonJsonFormatter;
import ch.qos.logback.contrib.json.classic.JsonLayout;
import io.micronaut.core.util.StringUtils;
import lombok.Getter;
import lombok.Setter;
/**
* GCP logging layout.
* Stackdriver layout.
*
* @author Stephan Schnabel
* @see "https://cloud.google.com/logging/docs/agent/configuration#process-payload"
* @see "https://cloud.google.com/error-reporting/reference/rest/v1beta1/ServiceContext"
*/
public class GcpJsonLayout extends JsonLayout {
@Getter
@Setter
public class StackdriverJsonLayout extends JsonLayout {
private static final String UNDEFINED = "_IS_UNDEFINED";
private static final String TIME_ATTR_NAME = "time";
private static final String TIMESTAMP_ATTR_NAME = "time";
private static final String SEVERITY_ATTR_NAME = "severity";
private Map<String, String> serviceContext;
private String serviceName;
private String serviceVersion;
private boolean includeExceptionInMessage;
public StackdriverJsonLayout() {
appendLineSeparator = true;
includeContextName = false;
includeMessage = true;
includeExceptionInMessage = true;
setJsonFormatter(new JacksonJsonFormatter());
}
@Override
protected Map<String, Object> toJsonMap(ILoggingEvent event) {
var map = new LinkedHashMap<String, Object>();
add(TIME_ATTR_NAME, includeTimestamp, Instant.ofEpochMilli(event.getTimeStamp()).toString(), map);
add(TIMESTAMP_ATTR_NAME, includeTimestamp, Instant.ofEpochMilli(event.getTimeStamp()).toString(), map);
add(SEVERITY_ATTR_NAME, includeLevel, String.valueOf(event.getLevel()), map);
add(THREAD_ATTR_NAME, includeThreadName, event.getThreadName(), map);
add(CONTEXT_ATTR_NAME, includeContextName, event.getLoggerContextVO().getName(), map);
@ -35,18 +50,18 @@ public class GcpJsonLayout extends JsonLayout {
addMap(MDC_ATTR_NAME, includeMDC, event.getMDCPropertyMap(), map);
add(FORMATTED_MESSAGE_ATTR_NAME, includeFormattedMessage, event.getFormattedMessage(), map);
add(MESSAGE_ATTR_NAME, includeMessage, event.getMessage(), map);
addThrowableInfo(EXCEPTION_ATTR_NAME, includeException, event, map);
addThrowableInfo(JsonLayout.EXCEPTION_ATTR_NAME, includeException, event, map);
addServiceContext(map);
return map;
}
private void addServiceContext(Map<String, Object> map) {
if (serviceContext == null) {
serviceContext = new LinkedHashMap<>(2);
if (StringUtils.isNotEmpty(serviceName) && !serviceName.endsWith(UNDEFINED)) {
serviceContext = new HashMap<>(2);
if (StringUtils.isNotEmpty(serviceName)) {
serviceContext.put("service", serviceName);
}
if (StringUtils.isNotEmpty(serviceVersion) && !serviceVersion.endsWith(UNDEFINED)) {
if (StringUtils.isNotEmpty(serviceVersion)) {
serviceContext.put("version", serviceVersion);
}
}
@ -54,12 +69,4 @@ public class GcpJsonLayout extends JsonLayout {
map.put("serviceContext", serviceContext);
}
}
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
public void setServiceVersion(String serviceVersion) {
this.serviceVersion = serviceVersion;
}
}

View file

@ -1,43 +0,0 @@
package io.kokuwa.micronaut.logging.configurator;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.spi.Configurator;
import ch.qos.logback.classic.util.DefaultJoranConfigurator;
import ch.qos.logback.core.joran.spi.JoranException;
import ch.qos.logback.core.spi.ContextAwareBase;
/**
* Use logback-default.xml if no configuration is provided by user.
*
* @author Stephan Schnabel
*/
public class DefaultConfigurator extends ContextAwareBase implements Configurator {
@SuppressWarnings("deprecation")
@Override
public ExecutionStatus configure(LoggerContext loggerContext) {
if (new DefaultJoranConfigurator().findURLOfDefaultConfigurationFile(false) != null) {
// there is a default logback file, use this one instead of our default
return ExecutionStatus.INVOKE_NEXT_IF_ANY;
}
var base = DefaultConfigurator.class.getResource("/io/kokuwa/logback/logback-default.xml");
if (base == null) {
addError("Failed to find logback.xml from io.kokuwa:micronaut-logging");
return ExecutionStatus.NEUTRAL;
}
try {
addInfo("Use logback.xml from io.kokuwa:micronaut-logging");
var configurator = new MicronautJoranConfigurator();
configurator.setContext(loggerContext);
configurator.doConfigure(base);
} catch (JoranException e) {
addError("Failed to load logback.xml from io.kokuwa:micronaut-logging", e);
return ExecutionStatus.NEUTRAL;
}
return ExecutionStatus.DO_NOT_INVOKE_NEXT_IF_ANY;
}
}

View file

@ -1,19 +0,0 @@
package io.kokuwa.micronaut.logging.configurator;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.core.joran.spi.ElementSelector;
import ch.qos.logback.core.joran.spi.RuleStore;
/**
* Add custom actions.
*
* @author Stephan Schnabel
*/
public class MicronautJoranConfigurator extends JoranConfigurator {
@Override
public void addElementSelectorAndActionAssociations(RuleStore rs) {
super.addElementSelectorAndActionAssociations(rs);
rs.addRule(new ElementSelector("configuration/root/autoAppender"), () -> new RootAutoSelectAppenderAction());
}
}

View file

@ -1,130 +0,0 @@
package io.kokuwa.micronaut.logging.configurator;
import java.util.Optional;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.PatternLayout;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.ConsoleAppender;
import ch.qos.logback.core.Layout;
import ch.qos.logback.core.encoder.LayoutWrappingEncoder;
import ch.qos.logback.core.joran.action.Action;
import ch.qos.logback.core.joran.spi.SaxEventInterpretationContext;
import io.kokuwa.micronaut.logging.layout.GcpJsonLayout;
import io.kokuwa.micronaut.logging.layout.JsonLayout;
import io.micronaut.core.util.StringUtils;
/**
* Auto select appender by environment.
*
* @author Stephan Schnabel
*/
public class RootAutoSelectAppenderAction extends Action {
private static final boolean IS_KUBERNETES = StringUtils.isNotEmpty(System.getenv("KUBERNETES_SERVICE_HOST"));
private static final boolean IS_GCP = StringUtils.isNotEmpty(System.getenv("GOOGLE_CLOUD_PROJECT"));
private static final String APPENDER_CONSOLE = "CONSOLE";
private static final String APPENDER_JSON = "JSON";
private static final String APPENDER_GCP = "GCP";
private static final String LOGBACK_APPENDER = "LOGBACK_APPENDER";
private static final String LOGBACK_PATTERN = "LOGBACK_PATTERN";
private static final String LOGBACK_PATTERN_DEFAULT = """
%cyan(%d{HH:mm:ss.SSS}) \
%gray(%-6.6thread) \
%highlight(%-5level) \
%magenta(%32logger{32}) \
%mdc \
%msg%n""";
@Override
public void begin(SaxEventInterpretationContext ic, String name, org.xml.sax.Attributes attributes) {
var rootLogger = LoggerContext.class.cast(context).getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
var rootLoggerAppenders = rootLogger.iteratorForAppenders();
if (rootLoggerAppenders.hasNext()) {
addWarn("Skip because appender already found: " + rootLoggerAppenders.next().getName());
return;
}
var envAppender = env(LOGBACK_APPENDER, null);
if (envAppender != null) {
setAppender(rootLogger, envAppender);
return;
}
if (IS_KUBERNETES) {
setAppender(rootLogger, APPENDER_JSON);
return;
}
if (IS_GCP) {
setAppender(rootLogger, APPENDER_GCP);
return;
}
setAppender(rootLogger, APPENDER_CONSOLE);
}
@Override
public void end(SaxEventInterpretationContext ic, String name) {}
private void setAppender(Logger rootLogger, String appenderName) {
addInfo("Use appender: " + appenderName);
var layout = switch (appenderName) {
case APPENDER_JSON -> json();
case APPENDER_GCP -> gcp();
case APPENDER_CONSOLE -> console();
default -> {
addError("Appender " + appenderName + " not found. Using console ...");
yield console();
}
};
layout.start();
var encoder = new LayoutWrappingEncoder<ILoggingEvent>();
encoder.setContext(context);
encoder.setLayout(layout);
encoder.start();
var appender = new ConsoleAppender<ILoggingEvent>();
appender.setContext(context);
appender.setName(appenderName);
appender.setEncoder(encoder);
appender.start();
rootLogger.addAppender(appender);
}
private Layout<ILoggingEvent> console() {
var layout = new PatternLayout();
layout.setContext(context);
layout.setPattern(env(LOGBACK_PATTERN, LOGBACK_PATTERN_DEFAULT));
return layout;
}
private Layout<ILoggingEvent> json() {
var layout = new JsonLayout();
layout.setContext(context);
return layout;
}
private Layout<ILoggingEvent> gcp() {
var layout = new GcpJsonLayout();
layout.setContext(context);
layout.setServiceName(env("SERVICE_NAME", null));
layout.setServiceVersion(env("SERVICE_VERSION", null));
return layout;
}
private String env(String name, String defaultValue) {
var envValue = Optional.ofNullable(System.getenv(name)).map(String::trim).filter(StringUtils::isNotEmpty);
var finalValue = envValue.orElse(defaultValue);
if (envValue.isPresent()) {
addInfo("Use provided config: " + name + "=" + finalValue);
} else {
addInfo("Use default config: " + name + "=" + finalValue);
}
return finalValue;
}
}

View file

@ -1,56 +0,0 @@
package io.kokuwa.micronaut.logging.http;
import java.util.Map;
import org.reactivestreams.Publisher;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import io.micronaut.core.async.publisher.Publishers;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.filter.HttpServerFilter;
import io.micronaut.http.filter.ServerFilterChain;
/**
* Base for all MDC related http filters.
*
* @author Stephan Schnabel
*/
public abstract class AbstractMdcFilter implements HttpServerFilter {
protected final Logger log = LoggerFactory.getLogger(getClass());
protected final int order;
protected final String prefix;
protected AbstractMdcFilter(Integer order, String prefix) {
this.order = order;
this.prefix = prefix;
}
@Override
public int getOrder() {
return order;
}
protected Publisher<MutableHttpResponse<?>> doFilter(
HttpRequest<?> request,
ServerFilterChain chain,
Map<String, String> mdc) {
if (mdc.isEmpty()) {
return chain.proceed(request);
}
mdc.forEach((key, value) -> MDC.put(addPrefix(key), value));
return Publishers.map(chain.proceed(request), response -> {
mdc.keySet().forEach(key -> MDC.remove(addPrefix(key)));
return response;
});
}
private String addPrefix(String key) {
return prefix == null ? key : prefix + key;
}
}

View file

@ -1,55 +0,0 @@
package io.kokuwa.micronaut.logging.http.level;
import java.util.Optional;
import org.reactivestreams.Publisher;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.annotation.Value;
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MutableHttpRequest;
import io.micronaut.http.annotation.Filter;
import io.micronaut.http.context.ServerRequestContext;
import io.micronaut.http.filter.ClientFilterChain;
import io.micronaut.http.filter.HttpClientFilter;
/**
* Propagates log-level from server request to client.
*
* @author Stephan Schnabel
*/
@Requires(beans = LogLevelServerFilter.class)
@Requires(property = LogLevelClientFilter.PREFIX + ".enabled", notEquals = StringUtils.FALSE)
@Filter("${" + LogLevelClientFilter.PREFIX + ".path:/**}")
public class LogLevelClientFilter implements HttpClientFilter {
public static final String PREFIX = "logger.http.level.propagation";
public static final int DEFAULT_ORDER = HIGHEST_PRECEDENCE;
private final String serverHeader;
private final String propagationHeader;
private final int order;
public LogLevelClientFilter(
@Value("${" + LogLevelServerFilter.PREFIX + ".header}") Optional<String> serverHeader,
@Value("${" + PREFIX + ".header}") Optional<String> propagationHeader,
@Value("${" + PREFIX + ".order}") Optional<Integer> order) {
this.serverHeader = serverHeader.orElse(LogLevelServerFilter.DEFAULT_HEADER);
this.propagationHeader = propagationHeader.orElse(this.serverHeader);
this.order = order.orElse(DEFAULT_ORDER);
}
@Override
public int getOrder() {
return order;
}
@Override
public Publisher<? extends HttpResponse<?>> doFilter(MutableHttpRequest<?> targetRequest, ClientFilterChain chain) {
ServerRequestContext.currentRequest()
.flatMap(currentRequest -> currentRequest.getHeaders().getFirst(serverHeader))
.ifPresent(level -> targetRequest.getHeaders().add(propagationHeader, level));
return chain.proceed(targetRequest);
}
}

View file

@ -1,68 +0,0 @@
package io.kokuwa.micronaut.logging.http.level;
import java.util.Map;
import java.util.Optional;
import jakarta.annotation.PostConstruct;
import jakarta.annotation.PreDestroy;
import org.reactivestreams.Publisher;
import ch.qos.logback.classic.turbo.TurboFilter;
import io.kokuwa.micronaut.logging.LogbackUtil;
import io.kokuwa.micronaut.logging.http.AbstractMdcFilter;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.annotation.Value;
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.annotation.Filter;
import io.micronaut.http.filter.ServerFilterChain;
import io.micronaut.http.filter.ServerFilterPhase;
import io.micronaut.runtime.context.scope.Refreshable;
/**
* Http request logging filter.
*
* @author Stephan Schnabel
*/
@Refreshable
@Requires(property = LogLevelServerFilter.PREFIX + ".enabled", notEquals = StringUtils.FALSE)
@Filter("${" + LogLevelServerFilter.PREFIX + ".path:/**}")
public class LogLevelServerFilter extends AbstractMdcFilter {
public static final String PREFIX = "logger.http.level";
public static final String DEFAULT_HEADER = "x-log-level";
public static final int DEFAULT_ORDER = ServerFilterPhase.FIRST.before();
public static final String MDC_KEY = "level";
public static final String MDC_FILTER = PREFIX;
private final LogbackUtil logback;
private final String header;
public LogLevelServerFilter(
LogbackUtil logback,
@Value("${" + PREFIX + ".header}") Optional<String> header,
@Value("${" + PREFIX + ".order}") Optional<Integer> order) {
super(order.orElse(DEFAULT_ORDER), null);
this.logback = logback;
this.header = header.orElse(DEFAULT_HEADER);
}
@PostConstruct
void startTurbofilter() {
logback.getTurboFilter(LogLevelTurboFilter.class, MDC_FILTER, LogLevelTurboFilter::new).start();
}
@PreDestroy
void stopTurbofilter() {
logback.getTurboFilter(LogLevelTurboFilter.class, MDC_FILTER).ifPresent(TurboFilter::stop);
}
@Override
public Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request, ServerFilterChain chain) {
return request.getHeaders().getFirst(header)
.map(level -> doFilter(request, chain, Map.of(MDC_KEY, level)))
.orElseGet(() -> chain.proceed(request));
}
}

View file

@ -1,77 +0,0 @@
package io.kokuwa.micronaut.logging.http.mdc;
import java.util.HashMap;
import java.util.Optional;
import java.util.Set;
import org.reactivestreams.Publisher;
import io.kokuwa.micronaut.logging.http.AbstractMdcFilter;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.annotation.Value;
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.annotation.Filter;
import io.micronaut.http.filter.ServerFilterChain;
import io.micronaut.http.filter.ServerFilterPhase;
import io.micronaut.runtime.context.scope.Refreshable;
import io.micronaut.security.authentication.Authentication;
/**
* Filter to add claims from authentication to MDC.
*
* @author Stephan Schnabel
*/
@Refreshable
@Requires(classes = Authentication.class)
@Requires(property = AuthenticationMdcFilter.PREFIX + ".enabled", notEquals = StringUtils.FALSE)
@Filter("${" + AuthenticationMdcFilter.PREFIX + ".path:/**}")
public class AuthenticationMdcFilter extends AbstractMdcFilter {
public static final String PREFIX = "logger.http.authentication";
public static final String DEFAULT_NAME = "principal";
public static final int DEFAULT_ORDER = ServerFilterPhase.SECURITY.after();
private final String name;
private final Set<String> attributes;
public AuthenticationMdcFilter(
@Value("${" + PREFIX + ".name}") Optional<String> name,
@Value("${" + PREFIX + ".attributes}") Optional<Set<String>> attributes,
@Value("${" + PREFIX + ".prefix}") Optional<String> prefix,
@Value("${" + PREFIX + ".order}") Optional<Integer> order) {
super(order.orElse(DEFAULT_ORDER), prefix.orElse(null));
this.name = name.orElse(DEFAULT_NAME);
this.attributes = attributes.orElseGet(Set::of);
if (name.isPresent() || !this.attributes.isEmpty()) {
log.info("Configured with name {} and attributes {}", this.name, this.attributes);
}
}
@Override
public Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request, ServerFilterChain chain) {
// get authentication
var authenticationOptional = request.getUserPrincipal(Authentication.class);
if (authenticationOptional.isEmpty()) {
return chain.proceed(request);
}
var authentication = authenticationOptional.get();
var authenticationAttributes = authentication.getAttributes();
// add mdc
var mdc = new HashMap<String, String>();
mdc.put(name, authentication.getName());
for (var attibuteName : attributes) {
var attibuteValue = authenticationAttributes.get(attibuteName);
if (attibuteValue != null) {
mdc.put(attibuteName, String.valueOf(attibuteValue));
}
}
return doFilter(request, chain, mdc);
}
}

View file

@ -1,53 +0,0 @@
package io.kokuwa.micronaut.logging.http.mdc;
import java.util.HashMap;
import java.util.List;
import java.util.Optional;
import org.reactivestreams.Publisher;
import io.kokuwa.micronaut.logging.http.AbstractMdcFilter;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.annotation.Value;
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.annotation.Filter;
import io.micronaut.http.filter.ServerFilterChain;
import io.micronaut.http.filter.ServerFilterPhase;
import io.micronaut.runtime.context.scope.Refreshable;
/**
* Filter to add http headers to MDC.
*
* @author Stephan Schnabel
*/
@Refreshable
@Requires(property = HeaderMdcFilter.PREFIX + ".enabled", notEquals = StringUtils.FALSE)
@Requires(property = HeaderMdcFilter.PREFIX + ".names")
@Filter("${" + HeaderMdcFilter.PREFIX + ".path:/**}")
public class HeaderMdcFilter extends AbstractMdcFilter {
public static final String PREFIX = "logger.http.header";
public static final int DEFAULT_ORDER = ServerFilterPhase.FIRST.before();
private final List<String> headers;
public HeaderMdcFilter(
@Value("${" + PREFIX + ".names}") List<String> headers,
@Value("${" + PREFIX + ".prefix}") Optional<String> prefix,
@Value("${" + PREFIX + ".order}") Optional<Integer> order) {
super(order.orElse(DEFAULT_ORDER), prefix.orElse(null));
this.headers = headers.stream().map(String::toLowerCase).toList();
log.info("Configured with header names {}", headers);
}
@Override
public Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request, ServerFilterChain chain) {
var mdc = new HashMap<String, String>();
for (var header : headers) {
request.getHeaders().getFirst(header).ifPresent(value -> mdc.put(header, String.valueOf(value)));
}
return doFilter(request, chain, mdc);
}
}

View file

@ -1,86 +0,0 @@
package io.kokuwa.micronaut.logging.http.mdc;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.reactivestreams.Publisher;
import io.kokuwa.micronaut.logging.http.AbstractMdcFilter;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.annotation.Value;
import io.micronaut.core.util.StringUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.annotation.Filter;
import io.micronaut.http.filter.ServerFilterChain;
import io.micronaut.http.filter.ServerFilterPhase;
import io.micronaut.runtime.context.scope.Refreshable;
/**
* Filter to add request path parts to MDC.
*
* @author Stephan Schnabel
*/
@Refreshable
@Requires(property = PathMdcFilter.PREFIX + ".enabled", notEquals = StringUtils.FALSE)
@Requires(property = PathMdcFilter.PREFIX + ".patterns")
@Filter("${" + PathMdcFilter.PREFIX + ".path:/**}")
public class PathMdcFilter extends AbstractMdcFilter {
public static final String PREFIX = "logger.http.path";
public static final int DEFAULT_ORDER = ServerFilterPhase.FIRST.before();
public static final Pattern PATTERN_GROUPS = Pattern.compile("\\(\\?<([a-zA-Z][a-zA-Z0-9]+)>");
private final Map<Pattern, Set<String>> patternsWithGroups;
public PathMdcFilter(
@Value("${" + PREFIX + ".patterns}") List<String> patterns,
@Value("${" + PREFIX + ".prefix}") Optional<String> prefix,
@Value("${" + PREFIX + ".order}") Optional<Integer> order) {
super(order.orElse(DEFAULT_ORDER), prefix.orElse(null));
this.patternsWithGroups = new HashMap<>();
for (var patternString : patterns) {
try {
var pattern = Pattern.compile(patternString);
var groupMatcher = PATTERN_GROUPS.matcher(pattern.toString());
var groups = new HashSet<String>();
while (groupMatcher.find()) {
groups.add(groupMatcher.group(1));
}
if (groups.isEmpty()) {
log.warn("Path {} is missing groups.", patternString);
} else {
log.info("Added path {} with groups {}.", patternString, groups);
patternsWithGroups.put(pattern, groups);
}
} catch (PatternSyntaxException e) {
log.warn("Path {} is invalid.", patternString);
}
}
}
@Override
public Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request, ServerFilterChain chain) {
var mdc = new HashMap<String, String>();
var path = request.getPath();
for (var patternWithGroup : patternsWithGroups.entrySet()) {
var matcher = patternWithGroup.getKey().matcher(path);
if (matcher.matches()) {
for (var group : patternWithGroup.getValue()) {
mdc.put(group, matcher.group(group));
}
}
}
return doFilter(request, chain, mdc);
}
}

View file

@ -1,197 +0,0 @@
package io.kokuwa.micronaut.logging.layout;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.TimeZone;
import ch.qos.logback.classic.pattern.ThrowableHandlingConverter;
import ch.qos.logback.classic.pattern.ThrowableProxyConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.CoreConstants;
import ch.qos.logback.core.LayoutBase;
import ch.qos.logback.core.status.OnConsoleStatusListener;
import ch.qos.logback.core.status.StatusUtil;
import ch.qos.logback.core.util.StatusListenerConfigHelper;
import io.micronaut.http.MediaType;
import io.micronaut.json.JsonMapper;
public class JsonLayout extends LayoutBase<ILoggingEvent> {
public static final String TIMESTAMP_ATTR_NAME = "timestamp";
public static final String LEVEL_ATTR_NAME = "level";
public static final String THREAD_ATTR_NAME = "thread";
public static final String MDC_ATTR_NAME = "mdc";
public static final String LOGGER_ATTR_NAME = "logger";
public static final String FORMATTED_MESSAGE_ATTR_NAME = "message";
public static final String MESSAGE_ATTR_NAME = "raw-message";
public static final String EXCEPTION_ATTR_NAME = "exception";
public static final String CONTEXT_ATTR_NAME = "context";
protected boolean includeLevel = true;
protected boolean includeThreadName = true;
protected boolean includeMDC = true;
protected boolean includeLoggerName = true;
protected boolean includeFormattedMessage = true;
protected boolean includeMessage = true;
protected boolean includeException = true;
protected boolean includeContextName = false;
protected boolean includeTimestamp = true;
private String timestampFormat;
private String timestampFormatTimezoneId;
private ThrowableHandlingConverter throwableHandlingConverter = new ThrowableProxyConverter();
private JsonMapper mapper;
@Override
public String getContentType() {
return MediaType.APPLICATION_JSON;
}
@Override
public void start() {
this.throwableHandlingConverter.start();
super.start();
}
@Override
public void stop() {
super.stop();
this.throwableHandlingConverter.stop();
}
@Override
public String doLayout(ILoggingEvent event) {
var map = toJsonMap(event);
if (mapper == null) {
try {
mapper = JsonMapper.createDefault();
} catch (IllegalStateException e) {
if (!StatusUtil.contextHasStatusListener(context)) {
addError("Failed to get object mapper from micronaut, please check your classpath");
StatusListenerConfigHelper.addOnConsoleListenerInstance(context, new OnConsoleStatusListener());
}
return map.toString() + CoreConstants.LINE_SEPARATOR;
}
}
try {
return new String(mapper.writeValueAsBytes(map), StandardCharsets.UTF_8) + CoreConstants.LINE_SEPARATOR;
} catch (IOException e) {
addError("Failed to write json from event " + event + " and map " + map, e);
return null;
}
}
protected Map<String, Object> toJsonMap(ILoggingEvent event) {
var map = new LinkedHashMap<String, Object>();
addTimestamp(TIMESTAMP_ATTR_NAME, includeTimestamp, event.getTimeStamp(), map);
add(LEVEL_ATTR_NAME, includeLevel, String.valueOf(event.getLevel()), map);
add(THREAD_ATTR_NAME, includeThreadName, event.getThreadName(), map);
addMap(MDC_ATTR_NAME, includeMDC, event.getMDCPropertyMap(), map);
add(LOGGER_ATTR_NAME, includeLoggerName, event.getLoggerName(), map);
add(FORMATTED_MESSAGE_ATTR_NAME, includeFormattedMessage, event.getFormattedMessage(), map);
add(MESSAGE_ATTR_NAME, includeMessage, event.getMessage(), map);
add(CONTEXT_ATTR_NAME, includeContextName, event.getLoggerContextVO().getName(), map);
addThrowableInfo(EXCEPTION_ATTR_NAME, includeException, event, map);
return map;
}
protected void addThrowableInfo(String fieldName, boolean field, ILoggingEvent value, Map<String, Object> map) {
if (field && value != null) {
var throwableProxy = value.getThrowableProxy();
if (throwableProxy != null) {
var ex = throwableHandlingConverter.convert(value);
if (ex != null && !ex.isEmpty()) {
map.put(fieldName, ex);
}
}
}
}
protected void addMap(String key, boolean field, Map<String, ?> mapValue, Map<String, Object> map) {
if (field && mapValue != null && !mapValue.isEmpty()) {
map.put(key, mapValue);
}
}
protected void addTimestamp(String key, boolean field, long timeStamp, Map<String, Object> map) {
if (field) {
var formatted = formatTimestamp(timeStamp);
if (formatted != null) {
map.put(key, formatted);
}
}
}
protected void add(String fieldName, boolean field, String value, Map<String, Object> map) {
if (field && value != null) {
map.put(fieldName, value);
}
}
protected String formatTimestamp(long timestamp) {
if (timestampFormat == null || timestamp < 0) {
return String.valueOf(timestamp);
}
var date = new Date(timestamp);
var format = new SimpleDateFormat(timestampFormat);
if (timestampFormatTimezoneId != null) {
format.setTimeZone(TimeZone.getTimeZone(timestampFormatTimezoneId));
}
return format.format(date);
}
// setter
public void setIncludeLevel(boolean includeLevel) {
this.includeLevel = includeLevel;
}
public void setIncludeThreadName(boolean includeThreadName) {
this.includeThreadName = includeThreadName;
}
public void setIncludeMDC(boolean includeMDC) {
this.includeMDC = includeMDC;
}
public void setIncludeLoggerName(boolean includeLoggerName) {
this.includeLoggerName = includeLoggerName;
}
public void setIncludeFormattedMessage(boolean includeFormattedMessage) {
this.includeFormattedMessage = includeFormattedMessage;
}
public void setIncludeMessage(boolean includeMessage) {
this.includeMessage = includeMessage;
}
public void setIncludeException(boolean includeException) {
this.includeException = includeException;
}
public void setIncludeContextName(boolean includeContextName) {
this.includeContextName = includeContextName;
}
public void setIncludeTimestamp(boolean includeTimestamp) {
this.includeTimestamp = includeTimestamp;
}
public void setTimestampFormat(String timestampFormat) {
this.timestampFormat = timestampFormat;
}
public void setTimestampFormatTimezoneId(String timestampFormatTimezoneId) {
this.timestampFormatTimezoneId = timestampFormatTimezoneId;
}
public void setThrowableHandlingConverter(ThrowableHandlingConverter throwableHandlingConverter) {
this.throwableHandlingConverter = throwableHandlingConverter;
}
}

View file

@ -50,13 +50,7 @@ public class MDCTurboFilter extends TurboFilter {
}
@Override
public FilterReply decide(
Marker marker,
Logger logger,
Level eventLevel,
String format,
Object[] params,
Throwable t) {
public FilterReply decide(Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t) {
if (logger == null || !isStarted()) {
return FilterReply.NEUTRAL;
@ -73,6 +67,6 @@ public class MDCTurboFilter extends TurboFilter {
return FilterReply.NEUTRAL;
}
return eventLevel.isGreaterOrEqual(this.level) ? FilterReply.ACCEPT : FilterReply.NEUTRAL;
return level.isGreaterOrEqual(this.level) ? FilterReply.ACCEPT : FilterReply.NEUTRAL;
}
}

View file

@ -1,71 +1,45 @@
package io.kokuwa.micronaut.logging.mdc;
import java.util.Collection;
import java.util.Set;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ch.qos.logback.classic.Level;
import io.kokuwa.micronaut.logging.LogbackUtil;
import io.micronaut.context.annotation.BootstrapContextCompatible;
import io.micronaut.context.annotation.Context;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.env.Environment;
import io.micronaut.core.annotation.Internal;
import io.micronaut.core.type.Argument;
import io.micronaut.core.util.StringUtils;
import io.micronaut.logging.LogLevel;
import io.micronaut.logging.LoggingSystem;
import lombok.extern.slf4j.Slf4j;
/**
* Configure MDC filter.
*
* @author Stephan Schnabel
*/
@BootstrapContextCompatible
@Requires(beans = LogbackUtil.class)
@Requires(property = MDCTurboFilterConfigurer.PREFIX)
@Requires(property = MDCTurboFilterConfigurer.PREFIX + ".enabled", notEquals = StringUtils.FALSE)
@Requires(property = MDCTurboFilterConfigurer.ENABLED, notEquals = "false")
@BootstrapContextCompatible
@Context
public class MDCTurboFilterConfigurer implements LoggingSystem {
@Internal
@Slf4j
public class MDCTurboFilterConfigurer {
public static final String PREFIX = "logger.mdc";
private static final Logger log = LoggerFactory.getLogger(MDCTurboFilterConfigurer.class);
public static final String ENABLED = PREFIX + ".enabled";
private final LogbackUtil logback;
private final Environment environment;
private Collection<String> mdcs = Set.of();
private boolean initialized;
public MDCTurboFilterConfigurer(LogbackUtil logback, Environment environment) {
this.logback = logback;
this.environment = environment;
this.refresh();
}
@Override
public final void refresh() {
mdcs = environment.getPropertyEntries(PREFIX);
initialized = false;
if (environment.getProperties("logger.levels").isEmpty()) {
log.warn("MDCs are configured, but no levels are set. MDC may not work.");
}
}
@Override
public void setLogLevel(String name, LogLevel level) {
if (!initialized) {
configure();
initialized = true;
}
}
private void configure() {
for (var name : mdcs) {
public void configure() {
for (var name : environment.getPropertyEntries(PREFIX)) {
var prefix = PREFIX + "." + name + ".";
var key = environment.getProperty(prefix + "key", String.class, name);

View file

@ -0,0 +1,75 @@
package io.kokuwa.micronaut.logging.request;
import java.util.Optional;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import org.reactivestreams.Publisher;
import org.slf4j.MDC;
import ch.qos.logback.classic.turbo.TurboFilter;
import io.kokuwa.micronaut.logging.LogbackUtil;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.annotation.Value;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.annotation.Filter;
import io.micronaut.http.filter.HttpServerFilter;
import io.micronaut.http.filter.ServerFilterChain;
import io.micronaut.http.filter.ServerFilterPhase;
import io.micronaut.runtime.server.EmbeddedServer;
/**
* Http request logging filter.
*
* @author Stephan Schnabel
*/
@Requires(beans = EmbeddedServer.class)
@Requires(property = HeaderLoggingHttpFilter.ENABLED, notEquals = "false")
@Filter("${" + HeaderLoggingHttpFilter.PREFIX + ".pattern:" + HeaderLoggingHttpFilter.DEFAULT_PATTERN + ":/**}")
public class HeaderLoggingHttpFilter implements HttpServerFilter {
public static final String PREFIX = "logger.request.header";
public static final String ENABLED = PREFIX + ".enabled";
public static final String MDC_FILTER = PREFIX + ".filter";
public static final String MDC_KEY = "level";
public static final String DEFAULT_HEADER = "x-log-level";
public static final String DEFAULT_PATTERN = "/**";
public static final int DEFAULT_ORDER = ServerFilterPhase.FIRST.before();
private final LogbackUtil logback;
private final String header;
private final int order;
public HeaderLoggingHttpFilter(
LogbackUtil logback,
@Value("${" + PREFIX + ".header:" + DEFAULT_HEADER + "}") String header,
@Value("${" + PREFIX + ".order}") Optional<Integer> order) {
this.logback = logback;
this.header = header;
this.order = order.orElse(DEFAULT_ORDER);
}
@PostConstruct
void startTurbofilter() {
logback.getTurboFilter(HeaderLoggingTurboFilter.class, MDC_FILTER, HeaderLoggingTurboFilter::new).start();
}
@PreDestroy
void stopTurbofilter() {
logback.getTurboFilter(HeaderLoggingTurboFilter.class, MDC_FILTER).ifPresent(TurboFilter::stop);
}
@Override
public int getOrder() {
return order;
}
@Override
public Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request, ServerFilterChain chain) {
request.getHeaders().getFirst(header).ifPresent(level -> MDC.put(MDC_KEY, level));
return chain.proceed(request);
}
}

View file

@ -1,4 +1,4 @@
package io.kokuwa.micronaut.logging.http.level;
package io.kokuwa.micronaut.logging.request;
import org.slf4j.MDC;
import org.slf4j.Marker;
@ -13,7 +13,7 @@ import ch.qos.logback.core.spi.FilterReply;
*
* @author Stephan Schnabel
*/
public class LogLevelTurboFilter extends TurboFilter {
public class HeaderLoggingTurboFilter extends TurboFilter {
@Override
public FilterReply decide(Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t) {
@ -22,7 +22,7 @@ public class LogLevelTurboFilter extends TurboFilter {
return FilterReply.NEUTRAL;
}
var value = MDC.get(LogLevelServerFilter.MDC_KEY);
var value = MDC.get(HeaderLoggingHttpFilter.MDC_KEY);
if (value == null) {
return FilterReply.NEUTRAL;
}

View file

@ -0,0 +1,55 @@
package io.kokuwa.micronaut.logging.request;
import java.util.Optional;
import org.reactivestreams.Publisher;
import org.slf4j.MDC;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.annotation.Value;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpResponse;
import io.micronaut.http.annotation.Filter;
import io.micronaut.http.filter.HttpServerFilter;
import io.micronaut.http.filter.ServerFilterChain;
import io.micronaut.http.filter.ServerFilterPhase;
import io.micronaut.runtime.server.EmbeddedServer;
/**
* Http request principal filter.
*
* @author Stephan Schnabel
*/
@Requires(beans = EmbeddedServer.class)
@Requires(property = PrincipalHttpFilter.ENABLED, notEquals = "false")
@Filter("${" + PrincipalHttpFilter.PREFIX + ".pattern:" + PrincipalHttpFilter.DEFAULT_PATTERN + ":/**}")
public class PrincipalHttpFilter implements HttpServerFilter {
public static final String PREFIX = "logger.request.principal";
public static final String ENABLED = PREFIX + ".enabled";
public static final String DEFAULT_KEY = "principal";
public static final String DEFAULT_PATTERN = "/**";
public static final int DEFAULT_ORDER = ServerFilterPhase.SECURITY.after();
private final String key;
private final int order;
public PrincipalHttpFilter(
@Value("${" + PREFIX + ".key:" + DEFAULT_KEY + "}") String key,
@Value("${" + PREFIX + ".order}") Optional<Integer> order) {
this.key = key;
this.order = order.orElse(DEFAULT_ORDER);
}
@Override
public int getOrder() {
return order;
}
@Override
public Publisher<MutableHttpResponse<?>> doFilter(HttpRequest<?> request, ServerFilterChain chain) {
request.getUserPrincipal().ifPresent(princial -> MDC.put(key, princial.getName()));
return chain.proceed(request);
}
}

View file

@ -1,2 +0,0 @@
Args = --initialize-at-build-time=io.kokuwa.micronaut.logging.configurator.RootAutoSelectAppenderAction

View file

@ -1,12 +0,0 @@
{
"resources": {
"includes": [
{
"pattern": "\\Qio/kokuwa/logback/logback-default.xml\\E"
},
{
"pattern": "\\QMETA-INF/services/ch.qos.logback.classic.spi.Configurator\\E"
}
]
}
}

View file

@ -1 +0,0 @@
io.kokuwa.micronaut.logging.configurator.DefaultConfigurator

View file

@ -1,10 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="false">
<logger name="io.micronaut.logging.PropertiesLoggingLevelsConfigurer" levels="WARN" />
<root level="INFO">
<autoAppender />
</root>
</configuration>

View file

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<property resource="META-INF/build-info.properties" />
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<withJansi>true</withJansi>
<encoder>
<pattern>%cyan(%d{HH:mm:ss.SSS}) %gray(%-6.6thread) %highlight(%-5level) %magenta(%32logger{32}) %mdc %msg%n</pattern>
</encoder>
</appender>
<appender name="STACKDRIVER" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<layout class="io.kokuwa.micronaut.logging.StackdriverJsonLayout">
<serviceName>${serviceName}</serviceName>
<serviceVersion>${serviceVersion}</serviceVersion>
</layout>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="${LOGBACK_APPENDER:-CONSOLE}" />
</root>
</configuration>

View file

@ -2,11 +2,11 @@ package io.kokuwa.micronaut.logging;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.MethodOrderer.Alphanumeric;
import org.junit.jupiter.api.TestMethodOrder;
import org.slf4j.MDC;
import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
import io.micronaut.test.annotation.MicronautTest;
/**
* Base for tests regarding logging.
@ -14,7 +14,7 @@ import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
* @author Stephan Schnabel
*/
@MicronautTest
@TestMethodOrder(MethodOrderer.DisplayName.class)
@TestMethodOrder(Alphanumeric.class)
public abstract class AbstractTest {
@BeforeEach

View file

@ -1,152 +0,0 @@
package io.kokuwa.micronaut.logging.http;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import java.util.Map;
import java.util.function.Consumer;
import jakarta.inject.Inject;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import ch.qos.logback.classic.Level;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.nimbusds.jose.JOSEException;
import com.nimbusds.jwt.JWTClaimsSet;
import io.kokuwa.micronaut.logging.AbstractTest;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.util.CollectionUtils;
import io.micronaut.http.HttpHeaderValues;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpStatus;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
import io.micronaut.http.annotation.PathVariable;
import io.micronaut.http.client.DefaultHttpClientConfiguration;
import io.micronaut.http.client.HttpClient;
import io.micronaut.http.filter.HttpServerFilter;
import io.micronaut.runtime.server.EmbeddedServer;
import io.micronaut.security.annotation.Secured;
import io.micronaut.security.rules.SecurityRule;
import io.micronaut.security.token.jwt.signature.SignatureGeneratorConfiguration;
import io.micronaut.serde.annotation.Serdeable;
import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
/**
* Test for {@link HttpServerFilter}.
*
* @author Stephan Schnabel
*/
@MicronautTest(rebuildContext = true)
public abstract class AbstractFilterTest extends AbstractTest {
@Inject
SignatureGeneratorConfiguration signature;
@Inject
EmbeddedServer embeddedServer;
@DisplayName("0 - trigger rebuild of context")
@Test
void rebuild() {}
// security
public String token(String subject) {
return token(subject, claims -> {});
}
public String token(String subject, Consumer<JWTClaimsSet.Builder> manipulator) {
var claims = new JWTClaimsSet.Builder().subject(subject);
manipulator.accept(claims);
try {
return HttpHeaderValues.AUTHORIZATION_PREFIX_BEARER + " " + signature.sign(claims.build()).serialize();
} catch (JOSEException e) {
fail(e);
return null;
}
}
// request
public TestResponse get(String path, Map<String, String> headers) {
var request = HttpRequest.GET(path);
headers.forEach((name, value) -> request.header(name, value));
var configuration = new DefaultHttpClientConfiguration();
configuration.setLoggerName("io.kokuwa.TestClient");
var response = HttpClient
.create(embeddedServer.getURL(), configuration)
.toBlocking().exchange(request, TestResponse.class);
assertEquals(HttpStatus.OK, response.getStatus(), "status");
assertTrue(response.getBody().isPresent(), "body");
assertTrue(CollectionUtils.isEmpty(MDC.getCopyOfContextMap()), "mdc leaked: " + MDC.getCopyOfContextMap());
return response.body();
}
@Secured({ SecurityRule.IS_ANONYMOUS, SecurityRule.IS_AUTHENTICATED })
@Controller
public static class TestController {
private static final Logger log = LoggerFactory.getLogger(TestController.class);
@Get("/{+path}")
TestResponse run(@PathVariable String path) {
var level = Level.OFF;
if (log.isTraceEnabled()) {
level = Level.TRACE;
} else if (log.isDebugEnabled()) {
level = Level.DEBUG;
} else if (log.isInfoEnabled()) {
level = Level.INFO;
} else if (log.isWarnEnabled()) {
level = Level.WARN;
} else if (log.isErrorEnabled()) {
level = Level.ERROR;
}
var mdc = MDC.getCopyOfContextMap();
log.info("Found MDC: {}", mdc);
return new TestResponse(path, level.toString(), mdc);
}
}
@Serdeable
public static class TestResponse {
private final String path;
private final String level;
private final Map<String, String> context;
@JsonCreator
public TestResponse(
@JsonProperty("path") String path,
@JsonProperty("level") String level,
@Nullable @JsonProperty("context") Map<String, String> context) {
this.path = path;
this.level = level;
this.context = context == null ? Map.of() : context;
}
public String getPath() {
return path;
}
public String getLevel() {
return level;
}
public Map<String, String> getContext() {
return context;
}
}
}

View file

@ -1,80 +0,0 @@
package io.kokuwa.micronaut.logging.http.level;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.Map;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import ch.qos.logback.classic.Level;
import io.kokuwa.micronaut.logging.http.AbstractFilterTest;
import io.micronaut.context.annotation.Property;
/**
* Test for {@link LogLevelServerFilter}.
*
* @author Stephan Schnabel
*/
@DisplayName("http: set log level via http request")
public class LogLevelServerFilterTest extends AbstractFilterTest {
@DisplayName("noop: disabled")
@Test
@Property(name = "logger.http.level.enabled", value = "false")
void noopDisabled() {
assertLevel(Level.INFO, "TRACE");
}
@DisplayName("noop: header missing")
@Test
void noopHeaderMissing() {
assertLevel(Level.INFO, null);
}
@DisplayName("noop: header invalid, use DEBUG as default from logback")
@Test
void noopHeaderInvalid() {
assertLevel(Level.DEBUG, "TRCE");
}
@DisplayName("level: trace (below default)")
@Test
void levelTrace() {
assertLevel(Level.TRACE, "TRACE");
}
@DisplayName("level: debug (below default)")
@Test
void levelDebug() {
assertLevel(Level.DEBUG, "DEBUG");
}
@DisplayName("level: info (is default)")
@Test
void levelInfo() {
assertLevel(Level.INFO, "INFO");
}
@DisplayName("level: warn (above default)")
@Test
void levelWarn() {
assertLevel(Level.INFO, "WARN");
}
@DisplayName("config: custom header name")
@Test
@Property(name = "logger.http.level.header", value = "FOO")
void configHeaderWarn() {
assertLevel(Level.TRACE, "FOO", "TRACE");
}
private void assertLevel(Level expectedLevel, String value) {
assertLevel(expectedLevel, LogLevelServerFilter.DEFAULT_HEADER, value);
}
private void assertLevel(Level expectedLevel, String name, String value) {
var headers = value == null ? Map.<String, String>of() : Map.of(name, value);
assertEquals(expectedLevel.toString(), get("/level", headers).getLevel());
}
}

View file

@ -1,73 +0,0 @@
package io.kokuwa.micronaut.logging.http.mdc;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.List;
import java.util.Map;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import io.kokuwa.micronaut.logging.http.AbstractFilterTest;
import io.micronaut.context.annotation.Property;
import io.micronaut.http.HttpHeaders;
/**
* Test for {@link AuthenticationMdcFilter}.
*
* @author Stephan Schnabel
*/
@DisplayName("http: mdc from authentication")
public class AuthenticationMdcFilterTest extends AbstractFilterTest {
@DisplayName("noop: disabled")
@Test
@Property(name = "logger.http.authentication.enabled", value = "false")
void noopDisabled() {
assertEquals(Map.of(), getContext(true));
}
@DisplayName("noop: token missing")
@Test
void noopTokenMissing() {
assertEquals(Map.of(), getContext(false));
}
@DisplayName("mdc: default config")
@Test
void mdcWithDefault() {
assertEquals(Map.of("principal", "mySubject"), getContext(true));
}
@DisplayName("mdc: with name")
@Test
@Property(name = "logger.http.authentication.name", value = "sub")
void mdcWithName() {
assertEquals(Map.of("sub", "mySubject"), getContext(true));
}
@DisplayName("mdc: with attribute keys")
@Test
@Property(name = "logger.http.authentication.attributes", value = "azp,aud")
void mdcWithAttributes() {
assertEquals(Map.of("principal", "mySubject", "aud", "[a, b]", "azp", "myAzp"), getContext(true));
}
@DisplayName("mdc: with prefix")
@Test
@Property(name = "logger.http.authentication.name", value = "sub")
@Property(name = "logger.http.authentication.attributes", value = "azp")
@Property(name = "logger.http.authentication.prefix", value = "auth.")
void mdcWithPrefix() {
assertEquals(Map.of("auth.sub", "mySubject", "auth.azp", "myAzp"), getContext(true));
}
private Map<String, String> getContext(boolean token) {
return get("/security", token
? Map.of(HttpHeaders.AUTHORIZATION, token("mySubject", claims -> claims
.issuer("nope")
.claim("azp", "myAzp")
.audience(List.of("a", "b"))))
: Map.of()).getContext();
}
}

View file

@ -1,60 +0,0 @@
package io.kokuwa.micronaut.logging.http.mdc;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.Map;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import io.kokuwa.micronaut.logging.http.AbstractFilterTest;
import io.micronaut.context.annotation.Property;
/**
* Test for {@link HeaderMdcFilter}.
*
* @author Stephan Schnabel
*/
@DisplayName("http: mdc from headers")
public class HeaderMdcFilterTest extends AbstractFilterTest {
@DisplayName("noop: empty configuration")
@Test
void noopEmptyConfiguration() {
assertContext(Map.of(), Map.of("foo", "bar"));
}
@DisplayName("noop: disabled")
@Test
@Property(name = "logger.http.header.enabled", value = "false")
@Property(name = "logger.http.header.names", value = "foo")
void noopDisabled() {
assertContext(Map.of(), Map.of("foo", "bar"));
}
@DisplayName("mdc: mismatch")
@Test
@Property(name = "logger.http.header.names", value = "foo")
void mdcMismatch() {
assertContext(Map.of(), Map.of("nope", "bar"));
}
@DisplayName("mdc: match without prefix")
@Test
@Property(name = "logger.http.header.names", value = "foo")
void mdcMatchWithoutPrefix() {
assertContext(Map.of("foo", "bar"), Map.of("foo", "bar", "nope", "bar"));
}
@DisplayName("mdc: match with prefix")
@Test
@Property(name = "logger.http.header.names", value = "foo")
@Property(name = "logger.http.header.prefix", value = "header.")
void mdcMatchWithPrefix() {
assertContext(Map.of("header.foo", "bar"), Map.of("foo", "bar", "nope", "bar"));
}
private void assertContext(Map<String, String> expectedMdcs, Map<String, String> headers) {
assertEquals(expectedMdcs, get("/header", headers).getContext());
}
}

View file

@ -1,104 +0,0 @@
package io.kokuwa.micronaut.logging.http.mdc;
import static org.junit.jupiter.api.Assertions.assertEquals;
import java.util.Map;
import java.util.UUID;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import io.kokuwa.micronaut.logging.http.AbstractFilterTest;
import io.micronaut.context.annotation.Property;
/**
* Test for {@link PathMdcFilter}.
*
* @author Stephan Schnabel
*/
@DisplayName("http: mdc from path")
public class PathMdcFilterTest extends AbstractFilterTest {
@DisplayName("noop: empty configuration")
@Test
void noopEmptyConfiguration() {
assertContext(Map.of(), "/foo/bar");
}
@DisplayName("noop: disabled")
@Test
@Property(name = "logger.http.path.enabled", value = "false")
@Property(name = "logger.http.path.patterns", value = "\\/foo\\/(?<foo>[0-9]+)")
void noopDisabled() {
assertContext(Map.of(), "/foo/123");
}
@DisplayName("noop: misconfigured")
@Test
@Property(name = "logger.http.path.patterns", value = "\\A{")
void noopMisconfigured() {
assertContext(Map.of(), "/foo/123");
}
@DisplayName("noop: no group")
@Test
@Property(name = "logger.http.path.patterns", value = "\\/foo/[0-9]+")
void noopGroups() {
assertContext(Map.of(), "/foo/123");
}
@DisplayName("mdc: mismatch")
@Test
@Property(name = "logger.http.path.patterns", value = "\\/foo\\/(?<foo>[0-9]+)")
void mdcMismatch() {
assertContext(Map.of(), "/nope");
assertContext(Map.of(), "/foo/abc");
}
@DisplayName("mdc: match with single group")
@Test
@Property(name = "logger.http.path.patterns", value = "\\/foo\\/(?<foo>[0-9]+)")
void mdcMatchWithSingleGroup() {
assertContext(Map.of("foo", "123"), "/foo/123");
}
@DisplayName("mdc: match with single group and prefix")
@Test
@Property(name = "logger.http.path.names", value = "foo")
@Property(name = "logger.http.path.patterns", value = "\\/foo\\/(?<foo>[0-9]+)")
@Property(name = "logger.http.path.prefix", value = "path.")
void mdcMatchWithSingleGroupAndPrefix() {
assertContext(Map.of("path.foo", "123"), "/foo/123");
}
@DisplayName("mdc: match with single group and misconfigured")
@Test
@Property(name = "logger.http.path.names", value = "foo")
@Property(name = "logger.http.path.patterns", value = "\\/foo\\/(?<foo>[0-9]+),\\A{")
@Property(name = "logger.http.path.prefix", value = "path.")
void mdcMatchWithSingleGroupAndMisconfigured() {
assertContext(Map.of("path.foo", "123"), "/foo/123");
}
@DisplayName("mdc: match with multiple group")
@Test
@Property(name = "logger.http.path.patterns", value = "/foo/(?<foo>[0-9]+)/bar/(?<bar>[0-9]+)")
void mdcMatchWithmultipleGroup() {
assertContext(Map.of("foo", "123", "bar", "456"), "/foo/123/bar/456");
}
@DisplayName("mdc: test for documentation example")
@Test
@Property(name = "logger.http.path.patterns", value = """
\\/gateway\\/(?<gatewayId>[a-f0-9\\-]{36}),\
\\/gateway\\/(?<gatewayId>[a-f0-9\\-]{36})\\/configuration\\/(?<config>[a-z]+)""")
void mdcMatchExample() {
var uuid = UUID.randomUUID().toString();
assertContext(Map.of("gatewayId", uuid), "/gateway/" + uuid);
assertContext(Map.of("gatewayId", uuid, "config", "abc"), "/gateway/" + uuid + "/configuration/abc");
}
private void assertContext(Map<String, String> expectedMdcs, String path) {
assertEquals(expectedMdcs, get(path, Map.of()).getContext());
}
}

View file

@ -10,14 +10,14 @@ import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import io.kokuwa.micronaut.logging.AbstractTest;
import io.micronaut.test.extensions.junit5.annotation.MicronautTest;
import io.micronaut.test.annotation.MicronautTest;
/**
* Test for {@link MDCTurboFilterConfigurer}.
*
* @author Stephan Schnabel
*/
@DisplayName("mdc based log levels")
@DisplayName("mdc")
@MicronautTest(environments = "test-mdc")
public class MDCTurboFilterTest extends AbstractTest {

View file

@ -0,0 +1,41 @@
package io.kokuwa.micronaut.logging.request;
import javax.inject.Inject;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import ch.qos.logback.classic.Level;
import io.kokuwa.micronaut.logging.AbstractTest;
import io.micronaut.test.annotation.MicronautTest;
/**
* Test for MDC and request filter combined.
*
* @author Stephan Schnabel
*/
@DisplayName("request-composite")
@MicronautTest(environments = "test-composite")
public class CompositeTest extends AbstractTest {
@Inject
TestClient client;
@DisplayName("default level")
@Test
void defaultLogging() {
client.assertLevel(Level.INFO, client.token("somebody"), null);
}
@DisplayName("level set by mdc")
@Test
void headerFromMdc() {
client.assertLevel(Level.DEBUG, client.token("horst"), null);
}
@DisplayName("level set by header (overriding mdc)")
@Test
void headerFromHeader() {
client.assertLevel(Level.TRACE, client.token("horst"), "TRACE");
}
}

View file

@ -0,0 +1,57 @@
package io.kokuwa.micronaut.logging.request;
import javax.inject.Inject;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import ch.qos.logback.classic.Level;
import io.kokuwa.micronaut.logging.AbstractTest;
/**
* Test for {@link HeaderLoggingHttpFilter}.
*
* @author Stephan Schnabel
*/
@DisplayName("request-header")
public class RequestHeaderTest extends AbstractTest {
@Inject
TestClient client;
@DisplayName("header missing")
@Test
void headerMissing() {
client.assertLevel(Level.INFO, null, null);
}
@DisplayName("header invalid, use DEBUG as default from logback")
@Test
void headerInvalid() {
client.assertLevel(Level.DEBUG, null, "TRCE");
}
@DisplayName("level trace (below default)")
@Test
void headerLevelTrace() {
client.assertLevel(Level.TRACE, null, "TRACE");
}
@DisplayName("level debug (below default)")
@Test
void headerLevelDebug() {
client.assertLevel(Level.DEBUG, null, "DEBUG");
}
@DisplayName("level info (is default)")
@Test
void headerLevelInfo() {
client.assertLevel(Level.INFO, null, "INFO");
}
@DisplayName("level warn (above default)")
@Test
void headerLevelWarn() {
client.assertLevel(Level.INFO, null, "WARN");
}
}

View file

@ -0,0 +1,44 @@
package io.kokuwa.micronaut.logging.request;
import static org.junit.jupiter.api.Assertions.assertEquals;
import javax.inject.Inject;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import io.kokuwa.micronaut.logging.AbstractTest;
/**
* Test for {@link PrincipalHttpFilter}.
*
* @author Stephan Schnabel
*/
@DisplayName("request-principal")
public class RequestPrincipalTest extends AbstractTest {
@Inject
TestClient client;
@DisplayName("token missing")
@Test
void tokenMissing() {
assertPrincipal(null, null);
}
@DisplayName("token invalid")
@Test
void tokenInvalid() {
assertPrincipal(null, "meh");
}
@DisplayName("token valid")
@Test
void tokenValid() {
assertPrincipal("meh", client.token("meh"));
}
private void assertPrincipal(String expectedPrincipal, String actualTokenValue) {
assertEquals(expectedPrincipal, client.get(actualTokenValue, null).getPrincipal());
}
}

View file

@ -0,0 +1,64 @@
package io.kokuwa.micronaut.logging.request;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import javax.inject.Inject;
import javax.inject.Singleton;
import com.nimbusds.jose.JOSEException;
import com.nimbusds.jwt.JWTClaimsSet;
import ch.qos.logback.classic.Level;
import io.kokuwa.micronaut.logging.request.TestController.TestResponse;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpStatus;
import io.micronaut.http.client.HttpClient;
import io.micronaut.http.client.annotation.Client;
import io.micronaut.security.token.jwt.signature.SignatureGeneratorConfiguration;
/**
* Contoller for testing {@link HeaderLoggingHttpFilter} and {@link PrincipalHttpFilter}.
*
* @author Stephan Schnabel
*/
@Singleton
public class TestClient {
@Inject
@Client("/")
HttpClient client;
@Inject
SignatureGeneratorConfiguration signature;
String token(String subject) {
try {
return signature.sign(new JWTClaimsSet.Builder().subject(subject).build()).serialize();
} catch (JOSEException e) {
fail("failed to create token");
return null;
}
}
TestResponse get(String token, String header) {
var request = HttpRequest.GET("/");
if (token != null) {
request.bearerAuth(token);
}
if (header != null) {
request.getHeaders().add(HeaderLoggingHttpFilter.DEFAULT_HEADER, header);
}
var response = client.toBlocking().exchange(request, TestResponse.class);
assertEquals(HttpStatus.OK, response.getStatus(), "status");
assertTrue(response.getBody().isPresent(), "body");
return response.body();
}
void assertLevel(Level expectedLevel, String actualTokenValue, String actualHeaderValue) {
assertEquals(expectedLevel.toString(), get(actualTokenValue, actualHeaderValue).getLevel());
}
}

View file

@ -0,0 +1,52 @@
package io.kokuwa.micronaut.logging.request;
import org.slf4j.MDC;
import ch.qos.logback.classic.Level;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
import io.micronaut.security.annotation.Secured;
import io.micronaut.security.rules.SecurityRule;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
/**
* Controller for testing {@link HeaderLoggingHttpFilter} and {@link PrincipalHttpFilter}.
*
* @author Stephan Schnabel
*/
@Secured({ SecurityRule.IS_ANONYMOUS, SecurityRule.IS_AUTHENTICATED })
@Controller
@Slf4j
public class TestController {
@Get("/")
TestResponse run() {
var principal = MDC.get(PrincipalHttpFilter.DEFAULT_KEY);
var level = Level.OFF;
if (log.isTraceEnabled()) {
level = Level.TRACE;
} else if (log.isDebugEnabled()) {
level = Level.DEBUG;
} else if (log.isInfoEnabled()) {
level = Level.INFO;
} else if (log.isWarnEnabled()) {
level = Level.WARN;
} else if (log.isErrorEnabled()) {
level = Level.ERROR;
}
return new TestResponse(level.toString(), principal);
}
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class TestResponse {
private String level;
private String principal;
}
}

View file

@ -0,0 +1,2 @@
serviceName: ${project.artifactId}
serviceVersion: ${project.version}

View file

@ -0,0 +1,8 @@
logger:
mdc:
principal:
level: DEBUG
loggers:
- io.kokuwa
values:
- horst

View file

@ -1,6 +1,4 @@
logger:
levels:
io.micronaut.logging.PropertiesLoggingLevelsConfigurer: "OFF"
mdc:
key1:
key: key

View file

@ -7,3 +7,10 @@ micronaut:
generator:
secret: pleaseChangeThisSecretForANewOne
jws-algorithm: HS256
http:
client:
logger-name: io.kokuwa.Test
logger:
levels:
io.kokuwa.Test: TRACE