Compare commits

...

93 commits
0.2.1 ... main

Author SHA1 Message Date
beb356e75f
chore: remove github actions
All checks were successful
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/deploy Pipeline was successful
2025-06-27 21:31:22 +02:00
cafd964700
chore: fix renovate preset location
All checks were successful
ci/woodpecker/pr/lint Pipeline was successful
ci/woodpecker/push/lint Pipeline was successful
2025-06-27 11:39:46 +02:00
9277ad3afc
chore: fix repo urls in pom.xml
All checks were successful
ci/woodpecker/pr/verify Pipeline was successful
ci/woodpecker/pr/versions/4 Pipeline was successful
ci/woodpecker/pr/versions/1 Pipeline was successful
ci/woodpecker/pr/versions/2 Pipeline was successful
ci/woodpecker/pr/versions/5 Pipeline was successful
ci/woodpecker/pr/versions/3 Pipeline was successful
ci/woodpecker/push/deploy Pipeline was successful
2025-06-26 21:52:37 +02:00
ad4604e5a8
chore(deps): update dependency net.revelc.code.formatter:formatter-maven-plugin from 2.26.0 to 2.27.0
All checks were successful
ci/woodpecker/push/deploy Pipeline was successful
ci/woodpecker/pr/verify Pipeline was successful
ci/woodpecker/pr/versions/4 Pipeline was successful
ci/woodpecker/pr/versions/1 Pipeline was successful
ci/woodpecker/pr/versions/5 Pipeline was successful
ci/woodpecker/pr/versions/3 Pipeline was successful
ci/woodpecker/pr/versions/2 Pipeline was successful
2025-06-26 03:03:26 +00:00
4c5e97e0de
Add Github README.
All checks were successful
ci/woodpecker/pr/lint Pipeline was successful
ci/woodpecker/push/lint Pipeline was successful
2025-06-25 20:40:15 +02:00
efb009aaef
Rename to kokuwaio/keycloak-event-metrics
All checks were successful
ci/woodpecker/push/dockerhub Pipeline was successful
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/deploy Pipeline was successful
2025-06-25 19:50:16 +02:00
964bc98518
[maven-release-plugin] prepare for next development iteration
All checks were successful
ci/woodpecker/push/deploy Pipeline was successful
2025-06-25 14:15:39 +00:00
10b4312fc5
[maven-release-plugin] prepare release 2.0.0 [CI SKIP] 2025-06-25 14:15:36 +00:00
a523f7ba6e
Moved repository to git.kokuwa.io
All checks were successful
ci/woodpecker/push/dockerhub Pipeline was successful
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/deploy Pipeline was successful
ci/woodpecker/deployment/release Pipeline was successful
2025-06-25 16:03:43 +02:00
9552221cc4
Replace docker invocation with maven plugin 2025-05-30 22:32:33 +02:00
83db672827
Migrate from parent to local config only 2025-05-30 21:02:27 +02:00
dependabot[bot]
f421be47af
Bump org.keycloak:keycloak-quarkus-server from 26.2.4 to 26.2.5 (#123)
Bumps org.keycloak:keycloak-quarkus-server from 26.2.4 to 26.2.5.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-version: 26.2.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-28 19:21:27 +02:00
dependabot[bot]
75d4e33c2f
Bump org.keycloak:keycloak-quarkus-server from 26.2.3 to 26.2.4 (#122)
Bumps org.keycloak:keycloak-quarkus-server from 26.2.3 to 26.2.4.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-version: 26.2.4
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-14 06:48:34 +02:00
dependabot[bot]
c9f13d961d
Bump org.keycloak:keycloak-quarkus-server from 26.2.2 to 26.2.3 (#121)
Bumps org.keycloak:keycloak-quarkus-server from 26.2.2 to 26.2.3.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-version: 26.2.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-05 19:38:06 +02:00
dependabot[bot]
1a1a9d3ae0
Bump org.keycloak:keycloak-quarkus-server from 26.2.1 to 26.2.2 (#120)
Bumps org.keycloak:keycloak-quarkus-server from 26.2.1 to 26.2.2.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-version: 26.2.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-05-02 20:31:32 +02:00
48e4939a5d
[maven-release-plugin] prepare for next development iteration 2025-04-28 12:25:45 +00:00
0e4181e3b1
[maven-release-plugin] prepare release 1.1.1 [no ci] 2025-04-28 12:25:43 +00:00
dependabot[bot]
3362a18708
Bump org.keycloak:keycloak-quarkus-server from 26.1.4 to 26.2.1 (#119)
Co-authored-by: Stephan Schnabel <ssc@nebula.sschnabe.eu>
2025-04-28 09:53:27 +00:00
dependabot[bot]
47c78e5b87
Bump docker/login-action from 3.3.0 to 3.4.0 (#117)
Bumps [docker/login-action](https://github.com/docker/login-action) from 3.3.0 to 3.4.0.
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](https://github.com/docker/login-action/compare/v3.3.0...v3.4.0)

---
updated-dependencies:
- dependency-name: docker/login-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-04-07 13:11:43 +02:00
dependabot[bot]
1a028e766c
Bump org.keycloak:keycloak-quarkus-server from 26.1.2 to 26.1.4 (#115)
Bumps org.keycloak:keycloak-quarkus-server from 26.1.2 to 26.1.4.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-03-21 13:40:18 +01:00
dependabot[bot]
fbf1da4b82
Bump org.keycloak:keycloak-quarkus-server from 26.1.1 to 26.1.2 (#113)
Bumps org.keycloak:keycloak-quarkus-server from 26.1.1 to 26.1.2.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-02-11 15:44:44 +01:00
dependabot[bot]
ba55b8fc8e
Bump org.keycloak:keycloak-quarkus-server from 26.1.0 to 26.1.1 (#112)
Bumps org.keycloak:keycloak-quarkus-server from 26.1.0 to 26.1.1.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-02-07 08:03:08 +01:00
dependabot[bot]
90f00379ea
Bump org.keycloak:keycloak-quarkus-server from 26.0.8 to 26.1.0 (#110)
Bumps org.keycloak:keycloak-quarkus-server from 26.0.8 to 26.1.0.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-01-15 15:32:52 +01:00
dependabot[bot]
eb1dc0ce34
Bump org.keycloak:keycloak-quarkus-server from 26.0.7 to 26.0.8 (#109)
Bumps org.keycloak:keycloak-quarkus-server from 26.0.7 to 26.0.8.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-01-14 09:18:22 +01:00
dependabot[bot]
c190433f33
Bump io.kokuwa.maven:maven-parent from 0.6.17 to 0.6.18 (#107)
Bumps [io.kokuwa.maven:maven-parent](https://github.com/kokuwaio/maven-parent) from 0.6.17 to 0.6.18.
- [Commits](https://github.com/kokuwaio/maven-parent/compare/0.6.17...0.6.18)

---
updated-dependencies:
- dependency-name: io.kokuwa.maven:maven-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-19 08:53:46 +00:00
c735477d6f
Fix build, align keycloak dependencies to avoid mockito classpath issues (#108) 2024-12-19 09:39:21 +01:00
bb996faa6f
[maven-release-plugin] prepare for next development iteration 2024-12-03 13:05:32 +00:00
29edb09cff
[maven-release-plugin] prepare release 1.1.0 [no ci] 2024-12-03 13:05:29 +00:00
b4fad32161
Collect all unknown client ids as UNKNOWN. Fix #100 2024-12-03 13:30:56 +01:00
dependabot[bot]
7aeb1b9e25
Bump org.keycloak:keycloak-quarkus-server from 26.0.2 to 26.0.7
Bumps org.keycloak:keycloak-quarkus-server from 26.0.2 to 26.0.7.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-12-03 08:30:06 +00:00
dependabot[bot]
8c44012e94
Bump org.keycloak:keycloak-quarkus-server from 25.0.6 to 26.0.2 (#99)
* Bump org.keycloak:keycloak-quarkus-server from 25.0.6 to 26.0.2

Bumps org.keycloak:keycloak-quarkus-server from 25.0.6 to 26.0.2.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* adjust

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Stephan Schnabel <stephan@sschnabe.eu>
2024-10-25 15:22:37 +02:00
dependabot[bot]
62a47a7419
Bump org.keycloak:keycloak-quarkus-server from 25.0.5 to 25.0.6 (#96)
Bumps org.keycloak:keycloak-quarkus-server from 25.0.5 to 25.0.6.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-09-20 16:26:26 +02:00
dependabot[bot]
57e651f57e
Bump org.keycloak:keycloak-quarkus-server from 25.0.4 to 25.0.5 (#95)
Bumps org.keycloak:keycloak-quarkus-server from 25.0.4 to 25.0.5.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-09-10 20:49:50 +02:00
dependabot[bot]
c885dc70b6
Bump io.kokuwa.maven:maven-parent from 0.6.16 to 0.6.17 (#94)
Bumps [io.kokuwa.maven:maven-parent](https://github.com/kokuwaio/maven-parent) from 0.6.16 to 0.6.17.
- [Commits](https://github.com/kokuwaio/maven-parent/compare/0.6.16...0.6.17)

---
updated-dependencies:
- dependency-name: io.kokuwa.maven:maven-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-09-10 20:49:41 +02:00
dependabot[bot]
a2773d6742
Bump org.keycloak:keycloak-quarkus-server from 25.0.2 to 25.0.4 (#93)
Bumps org.keycloak:keycloak-quarkus-server from 25.0.2 to 25.0.4.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-09-10 09:23:14 +02:00
dependabot[bot]
5bd2d9477e
Bump docker/login-action from 3.2.0 to 3.3.0 (#92)
Bumps [docker/login-action](https://github.com/docker/login-action) from 3.2.0 to 3.3.0.
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](https://github.com/docker/login-action/compare/v3.2.0...v3.3.0)

---
updated-dependencies:
- dependency-name: docker/login-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-08-02 23:47:13 +02:00
dependabot[bot]
8b1834d373
Bump org.keycloak:keycloak-quarkus-server from 25.0.1 to 25.0.2 (#91)
Bumps org.keycloak:keycloak-quarkus-server from 25.0.1 to 25.0.2.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-07-18 23:38:00 +02:00
957713286a
Add container image (#89) 2024-06-24 15:20:37 +02:00
c7bae85e40
Reviewed build 2024-06-24 10:54:56 +02:00
dependabot[bot]
da73c9d2f1
Bump org.keycloak:keycloak-quarkus-server from 24.0.5 to 25.0.1 (#87)
* Bump org.keycloak:keycloak-quarkus-server from 24.0.5 to 25.0.1

Bumps org.keycloak:keycloak-quarkus-server from 24.0.5 to 25.0.1.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* fix build

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Stephan Schnabel <stephan.schnabel@posteo.de>
2024-06-24 09:17:28 +02:00
dependabot[bot]
bdf9159f8e
Bump org.keycloak:keycloak-quarkus-server from 24.0.4 to 24.0.5 (#85)
Bumps org.keycloak:keycloak-quarkus-server from 24.0.4 to 24.0.5.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-06-07 14:08:26 +02:00
dependabot[bot]
ef92f6df24
Bump org.keycloak:keycloak-quarkus-server from 24.0.3 to 24.0.4 (#84)
Bumps org.keycloak:keycloak-quarkus-server from 24.0.3 to 24.0.4.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-05-13 10:27:39 +02:00
aea3fd1cd8
Use kokuwa bot token 2024-04-18 13:38:16 +02:00
dependabot[bot]
22c462c507
Bump org.keycloak:keycloak-quarkus-server from 24.0.2 to 24.0.3 (#83) 2024-04-17 08:47:01 +00:00
dependabot[bot]
aaa87db10f
Bump org.keycloak:keycloak-quarkus-server from 24.0.1 to 24.0.2 (#80)
Bumps org.keycloak:keycloak-quarkus-server from 24.0.1 to 24.0.2.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-25 17:11:41 +01:00
dependabot[bot]
6753255024
Bump actions/checkout from 2 to 4 (#82)
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-25 17:02:25 +01:00
André Bauer
e59271dfa1
fix yaml lint 2024-03-25 16:57:58 +01:00
André Bauer
3d5cdae223
add dependabot automerge for minor changes (#81)
Signed-off-by: André Bauer <andre.bauer@staffbase.com>
2024-03-25 16:55:03 +01:00
dependabot[bot]
6026d4ed18
Bump org.keycloak:keycloak-quarkus-server from 24.0.0 to 24.0.1 (#79)
Bumps org.keycloak:keycloak-quarkus-server from 24.0.0 to 24.0.1.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-03-05 09:37:26 +01:00
c6a1cfd065
Add more sophisticated docker example, rel #76 (#77)
* Add more sophisticated docker example, rel #76

* Update README.md
2024-03-05 09:05:46 +01:00
dependabot[bot]
f8d1acbc8f
Bump org.keycloak:keycloak-quarkus-server from 23.0.7 to 24.0.0 (#78)
* Bump org.keycloak:keycloak-quarkus-server from 23.0.7 to 24.0.0

Bumps org.keycloak:keycloak-quarkus-server from 23.0.7 to 24.0.0.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* Adjust docs and ci

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Stephan Schnabel <stephan.schnabel@posteo.de>
2024-03-04 11:24:13 +01:00
dependabot[bot]
fb20a34094
Bump org.keycloak:keycloak-quarkus-server from 23.0.6 to 23.0.7 (#75)
Bumps org.keycloak:keycloak-quarkus-server from 23.0.6 to 23.0.7.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-22 16:03:10 +01:00
dependabot[bot]
6d995a51c9
Bump io.kokuwa.maven:maven-parent from 0.6.14 to 0.6.15 (#74)
Bumps [io.kokuwa.maven:maven-parent](https://github.com/kokuwaio/maven-parent) from 0.6.14 to 0.6.15.
- [Commits](https://github.com/kokuwaio/maven-parent/compare/0.6.14...0.6.15)

---
updated-dependencies:
- dependency-name: io.kokuwa.maven:maven-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-22 16:02:57 +01:00
dependabot[bot]
cc69640095
Bump org.keycloak:keycloak-quarkus-server from 23.0.5 to 23.0.6 (#73)
Bumps org.keycloak:keycloak-quarkus-server from 23.0.5 to 23.0.6.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-02-02 17:01:02 +01:00
dependabot[bot]
267747f24e
Bump org.keycloak:keycloak-quarkus-server from 23.0.4 to 23.0.5 (#72)
Bumps org.keycloak:keycloak-quarkus-server from 23.0.4 to 23.0.5.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-29 17:34:05 +01:00
dependabot[bot]
f9729181ba
Bump org.keycloak:keycloak-quarkus-server from 23.0.3 to 23.0.4 (#71)
Bumps org.keycloak:keycloak-quarkus-server from 23.0.3 to 23.0.4.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-08 17:09:06 +01:00
dependabot[bot]
30f4685751
Bump actions/upload-artifact from 3 to 4 (#70)
Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-01 17:42:54 +01:00
dependabot[bot]
a76e28edaa
Bump io.kokuwa.maven:maven-parent from 0.6.13 to 0.6.14 (#69)
Bumps [io.kokuwa.maven:maven-parent](https://github.com/kokuwaio/maven-parent) from 0.6.13 to 0.6.14.
- [Commits](https://github.com/kokuwaio/maven-parent/compare/0.6.13...0.6.14)

---
updated-dependencies:
- dependency-name: io.kokuwa.maven:maven-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-12-29 21:55:50 +01:00
dependabot[bot]
d95e5997c6
Bump org.keycloak:keycloak-quarkus-server from 23.0.1 to 23.0.3 (#68)
Bumps org.keycloak:keycloak-quarkus-server from 23.0.1 to 23.0.3.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-12-17 12:46:03 +01:00
2099257d12
Add docu for dashboard, fix #2 (#67) 2023-12-13 20:56:35 +01:00
dependabot[bot]
f8edc06eb2
Bump actions/setup-java from 3 to 4 (#66)
Bumps [actions/setup-java](https://github.com/actions/setup-java) from 3 to 4.
- [Release notes](https://github.com/actions/setup-java/releases)
- [Commits](https://github.com/actions/setup-java/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/setup-java
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-12-01 16:40:37 +01:00
dependabot[bot]
30aaccc056
Bump org.keycloak:keycloak-quarkus-server from 23.0.0 to 23.0.1 (#65)
Bumps org.keycloak:keycloak-quarkus-server from 23.0.0 to 23.0.1.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-11-29 15:07:46 +01:00
dependabot[bot]
19930672f0
Bump org.keycloak:keycloak-quarkus-server from 22.0.5 to 23.0.0 (#64)
Bumps org.keycloak:keycloak-quarkus-server from 22.0.5 to 23.0.0.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-11-29 13:31:22 +00:00
dependabot[bot]
e3cfb12b99
Bump org.keycloak:keycloak-quarkus-server from 22.0.4 to 22.0.5 (#62)
Bumps org.keycloak:keycloak-quarkus-server from 22.0.4 to 22.0.5.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-24 22:22:50 +02:00
dependabot[bot]
110c27774f
Bump io.kokuwa.maven:maven-parent from 0.6.12 to 0.6.13 (#61)
Bumps [io.kokuwa.maven:maven-parent](https://github.com/kokuwaio/maven-parent) from 0.6.12 to 0.6.13.
- [Commits](https://github.com/kokuwaio/maven-parent/compare/0.6.12...0.6.13)

---
updated-dependencies:
- dependency-name: io.kokuwa.maven:maven-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-18 20:10:07 +02:00
dependabot[bot]
40edc83dc7
Bump org.keycloak:keycloak-quarkus-server from 22.0.3 to 22.0.4 (#60)
Bumps org.keycloak:keycloak-quarkus-server from 22.0.3 to 22.0.4.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-04 20:06:36 +02:00
dependabot[bot]
a42447fc28
Bump crazy-max/ghaction-import-gpg from 5 to 6 (#58)
Bumps [crazy-max/ghaction-import-gpg](https://github.com/crazy-max/ghaction-import-gpg) from 5 to 6.
- [Release notes](https://github.com/crazy-max/ghaction-import-gpg/releases)
- [Commits](https://github.com/crazy-max/ghaction-import-gpg/compare/v5...v6)

---
updated-dependencies:
- dependency-name: crazy-max/ghaction-import-gpg
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-02 21:29:01 +02:00
dependabot[bot]
1a9a3b3714
Bump actions/checkout from 3 to 4 (#59)
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-02 21:28:42 +02:00
dependabot[bot]
fab113d912
Bump org.keycloak:keycloak-quarkus-server from 22.0.2 to 22.0.3 (#57)
* Bump org.keycloak:keycloak-quarkus-server from 22.0.2 to 22.0.3

Bumps org.keycloak:keycloak-quarkus-server from 22.0.2 to 22.0.3.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Use java http client because keycloak api in incompatible

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Stephan Schnabel <stephan.schnabel@posteo.de>
2023-09-15 11:47:38 +02:00
dependabot[bot]
79fada6ce8
Bump org.keycloak:keycloak-quarkus-server from 22.0.1 to 22.0.2 (#56)
* Bump org.keycloak:keycloak-quarkus-server from 22.0.1 to 22.0.2

Bumps org.keycloak:keycloak-quarkus-server from 22.0.1 to 22.0.2.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Add 22.0.2 to ci

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Stephan Schnabel <stephan.schnabel@posteo.de>
2023-09-11 18:33:54 +00:00
dependabot[bot]
355ca8cc61
Bump io.kokuwa.maven:maven-parent from 0.6.10 to 0.6.12 (#55)
Bumps [io.kokuwa.maven:maven-parent](https://github.com/kokuwaio/maven-parent) from 0.6.10 to 0.6.12.
- [Commits](https://github.com/kokuwaio/maven-parent/compare/0.6.10...0.6.12)

---
updated-dependencies:
- dependency-name: io.kokuwa.maven:maven-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-08-31 17:25:13 +02:00
dependabot[bot]
3b895500a5
Bump keycloak-quarkus-server from 22.0.0 to 22.0.1 (#54)
Bumps keycloak-quarkus-server from 22.0.0 to 22.0.1.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-07-18 19:47:14 +02:00
8314d8fab0 Add testing for multiple version from one base version 2023-07-12 11:25:56 +02:00
ed7b7ef82a Migrate from org.hibernate to org.hibernate.orm 2023-07-12 11:25:56 +02:00
398239d79c Migrate from javaxto jakarta 2023-07-12 11:25:56 +02:00
dependabot[bot]
ee01b2562b Bump keycloak-quarkus-server from 21.1.2 to 22.0.0
Bumps keycloak-quarkus-server from 21.1.2 to 22.0.0.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-12 11:25:56 +02:00
dependabot[bot]
1800ef9abf
Bump keycloak-quarkus-server from 21.1.1 to 21.1.2 (#52)
* Bump keycloak-quarkus-server from 21.1.1 to 21.1.2

Bumps keycloak-quarkus-server from 21.1.1 to 21.1.2.

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-quarkus-server
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* Bump build too

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Stephan Schnabel <stephan.schnabel@posteo.de>
2023-07-03 07:59:27 +00:00
a3784fe1f5
Migrate to kokuwa parent 2023-07-03 09:55:44 +02:00
29b573f2f7
[maven-release-plugin] prepare for next development iteration 2023-05-02 08:32:45 +00:00
f005be46cc
[maven-release-plugin] prepare release 1.0.0 [no ci] 2023-05-02 08:32:42 +00:00
131b33f31e
Do not add metrics for clients which never had a session (#39) 2023-05-02 10:09:59 +02:00
99a01e5c02
Add unit tests with mockito for metric stats (#38) 2023-05-02 09:30:58 +02:00
cfce0dee45
Refactor test: remove micrometer mocking, micrometer is testable (#32) 2023-05-02 09:02:27 +02:00
b4e8c3be4e
Include 21.1.1 in ci 2023-05-01 12:45:09 +02:00
dependabot[bot]
f836554143
Bump keycloak-parent from 21.1.0 to 21.1.1 (#36)
Bumps [keycloak-parent](https://github.com/keycloak/keycloak) from 21.1.0 to 21.1.1.
- [Release notes](https://github.com/keycloak/keycloak/releases)
- [Commits](https://github.com/keycloak/keycloak/compare/21.1.0...21.1.1)

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-01 08:23:30 +00:00
dependabot[bot]
f17c6e5e90
Bump checkstyle from 10.9.3 to 10.10.0 (#37)
Bumps [checkstyle](https://github.com/checkstyle/checkstyle) from 10.9.3 to 10.10.0.
- [Release notes](https://github.com/checkstyle/checkstyle/releases)
- [Commits](https://github.com/checkstyle/checkstyle/compare/checkstyle-10.9.3...checkstyle-10.10.0)

---
updated-dependencies:
- dependency-name: com.puppycrawl.tools:checkstyle
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-01 08:13:27 +00:00
dependabot[bot]
52d33f1d78
Bump mockito-junit-jupiter from 5.2.0 to 5.3.1 (#35)
Bumps [mockito-junit-jupiter](https://github.com/mockito/mockito) from 5.2.0 to 5.3.1.
- [Release notes](https://github.com/mockito/mockito/releases)
- [Commits](https://github.com/mockito/mockito/compare/v5.2.0...v5.3.1)

---
updated-dependencies:
- dependency-name: org.mockito:mockito-junit-jupiter
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-01 08:10:34 +00:00
dependabot[bot]
c0b7ab6b58
Bump maven-checkstyle-plugin from 3.2.1 to 3.2.2 (#34)
Bumps [maven-checkstyle-plugin](https://github.com/apache/maven-checkstyle-plugin) from 3.2.1 to 3.2.2.
- [Release notes](https://github.com/apache/maven-checkstyle-plugin/releases)
- [Commits](https://github.com/apache/maven-checkstyle-plugin/compare/maven-checkstyle-plugin-3.2.1...maven-checkstyle-plugin-3.2.2)

---
updated-dependencies:
- dependency-name: org.apache.maven.plugins:maven-checkstyle-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-01 08:09:25 +00:00
37dcc07309
Add additional metrics for user/client/session count (#31) 2023-04-25 10:28:30 +02:00
566f31ddc2
Replace CDI with Micrometer global (#30) 2023-04-25 08:51:48 +02:00
32fc7a1d5d
Move event-listener to sub package (#29) 2023-04-24 12:58:23 +00:00
a392076722
Change default value for replaceIds (#28) 2023-04-24 14:55:22 +02:00
5fbeb49a61
[maven-release-plugin] prepare for next development iteration 2023-04-24 12:34:39 +00:00
44 changed files with 2268 additions and 738 deletions

4
.github/CODEOWNERS vendored
View file

@ -1,4 +0,0 @@
# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
* @sschnabe @rpahli @fabian-schlegel @jschwarze @wistefan @monotek
.github/workflows/* @kokuwaio-bot
pom.xml @kokuwaio-bot

14
.github/README.md vendored Normal file
View file

@ -0,0 +1,14 @@
# Keycloak Metrics
Provides metrics for Keycloak user/admin events and user/client/session count. Tested on Keycloak [22-26](.woodpecker/verify.yaml#L7-L11).
[![maven](https://img.shields.io/maven-central/v/io.kokuwa.keycloak/keycloak-event-metrics.svg?label=maven)](https://central.sonatype.com/artifact/io.kokuwa.keycloak/keycloak-event-metrics)
[![pulls](https://img.shields.io/docker/pulls/kokuwaio/keycloak-event-metrics)](https://hub.docker.com/r/kokuwaio/keycloak-event-metrics)
[![size](https://img.shields.io/docker/image-size/kokuwaio/keycloak-event-metrics)](https://hub.docker.com/r/kokuwaio/keycloak-event-metrics)
[![dockerfile](https://img.shields.io/badge/source-Dockerfile%20-blue)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/src/branch/main/Dockerfile)
[![license](https://img.shields.io/badge/license-EUPL%201.2-blue)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/src/branch/main/LICENSE)
[![issues](https://img.shields.io/gitea/issues/open/kokuwaio/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/issues)
[![prs](https://img.shields.io/gitea/pull-requests/open/kokuwaio/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/pulls)
[![build](https://ci.kokuwa.io/api/badges/kokuwaio/keycloak-event-metrics/status.svg)](https://ci.kokuwa.io/repos/kokuwaio/keycloak-event-metrics/)
For more documention see: [git.kokuwa.io/kokuwaio/keycloak-event-metrics](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics)

View file

@ -1,22 +0,0 @@
version: 2
updates:
- package-ecosystem: maven
directory: /
open-pull-requests-limit: 20
schedule:
interval: monthly
day: monday
# github parses time without quotes to int
# yamllint disable-line rule:quoted-strings
time: "09:00"
timezone: Europe/Berlin
- package-ecosystem: github-actions
directory: /
open-pull-requests-limit: 10
schedule:
interval: monthly
day: monday
# github parses time without quotes to int
# yamllint disable-line rule:quoted-strings
time: "09:00"
timezone: Europe/Berlin

View file

@ -1,86 +0,0 @@
name: CI
on:
push:
branches: [main]
pull_request: {}
jobs:
yaml:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ibiqlik/action-yamllint@v3
with:
format: colored
strict: true
markdown:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: avto-dev/markdown-lint@v1
with:
args: /github/workspace
javadoc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: temurin
java-version: 17
cache: maven
- run: mvn -B -ntp javadoc:javadoc-no-fork -Ddoclint=all
checkstyle:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: temurin
java-version: 17
cache: maven
- run: mvn -B -ntp checkstyle:check
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: temurin
java-version: 17
cache: maven
server-id: sonatype-nexus
server-username: SERVER_USERNAME
server-password: SERVER_PASSWORD
- run: mvn -B -ntp verify -Dcheckstyle.skip -Dmaven.test.redirectTestOutputToFile=false
if: ${{ github.ref != 'refs/heads/main' }}
- run: mvn -B -ntp deploy -Dcheckstyle.skip -Dmaven.test.redirectTestOutputToFile=false
if: ${{ github.ref == 'refs/heads/main' }}
env:
SERVER_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
SERVER_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
versions:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
version:
- 21.0.0
- 21.0.1
- 21.0.2
- 21.1.0
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v3
with:
distribution: temurin
java-version: 17
cache: maven
- run: mvn -B -ntp verify -Dcheckstyle.skip -Dmaven.test.redirectTestOutputToFile=false -Dversion.org.keycloak=${{ matrix.version }}

View file

@ -1,17 +0,0 @@
name: Dependabot
on: pull_request_target
jobs:
auto-merge:
runs-on: ubuntu-latest
if: ${{ github.actor == 'dependabot[bot]' }}
steps:
- run: gh pr review --approve "$PR_URL"
env:
PR_URL: ${{ github.event.pull_request.html_url }}
GITHUB_TOKEN: ${{ secrets.GIT_ACTION_TOKEN }}
- run: gh pr merge --auto --squash "$PR_URL"
env:
PR_URL: ${{ github.event.pull_request.html_url }}
GITHUB_TOKEN: ${{ secrets.GIT_ACTION_TOKEN }}

View file

@ -1,33 +0,0 @@
name: Release
on: workflow_dispatch
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
token: ${{ secrets.GIT_ACTION_TOKEN }}
- uses: crazy-max/ghaction-import-gpg@v5
with:
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.GPG_PASSPHRASE }}
git_user_signingkey: true
git_commit_gpgsign: true
- uses: actions/setup-java@v3
with:
distribution: temurin
java-version: 17
cache: maven
server-id: sonatype-nexus
server-username: SERVER_USERNAME
server-password: SERVER_PASSWORD
gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
gpg-passphrase: GPG_PASSPHRASE
- run: mvn -B -ntp release:prepare
- run: mvn -B -ntp release:perform
env:
SERVER_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
SERVER_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

5
.gitignore vendored Normal file
View file

@ -0,0 +1,5 @@
# do not include developer stuff here, use `git config --global core.excludesFile ~/.gitignore` for your setup
target
pom.xml.releaseBackup
release.properties

21
.justfile Normal file
View file

@ -0,0 +1,21 @@
# 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/hadolint
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
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) woodpeckerci/woodpecker-cli lint
# Build image with local docker daemon.
@build:
docker build . --tag=kokuwaio/keycloak-event-metrics:dev
# Inspect image layers with `dive`.
@dive: build
dive build .

61
.woodpecker/deploy.yaml Normal file
View file

@ -0,0 +1,61 @@
when:
instance: ci.kokuwa.io
repo: kokuwaio/keycloak-event-metrics
event: [manual, push]
branch: main
path: [.woodpecker/deploy.yaml, README.md, Dockerfile, pom.xml, src/main/**]
services:
- name: dockerd
image: kokuwaio/dockerd
privileged: true
ports: [2375, 8080]
steps:
maven:
image: maven:3.9.10-eclipse-temurin-17
commands: mvn deploy
environment:
MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.woodpecker/maven/settings.xml
MAVEN_GPG_KEY: {from_secret: woodpecker_gpg_key}
SONATYPE_ORG_USERNAME: {from_secret: sonatype_org_username}
SONATYPE_ORG_PASSWORD: {from_secret: sonatype_org_password}
image:
image: kokuwaio/buildctl
settings:
name:
- docker.io/kokuwaio/keycloak-event-metrics:snapshot
- ghcr.io/kokuwaio/keycloak-event-metrics:snapshot
build-args: {MAVEN_MIRROR_CENTRAL: "${MAVEN_MIRROR_CENTRAL}"}
platform: [linux/amd64, linux/arm64]
auth:
"https://index.docker.io/v1/":
username: {from_secret: docker_io_username}
password: {from_secret: docker_io_password}
ghcr.io:
username: {from_secret: ghcr_io_username}
password: {from_secret: ghcr_io_password}
annotation:
org.opencontainers.image.title: Keycloak Metrics
org.opencontainers.image.description: Provides metrics for Keycloak user/admin events and user/client/session count.
org.opencontainers.image.url: $CI_REPO_URL
org.opencontainers.image.documentation: $CI_REPO_URL/README.md
org.opencontainers.image.source: $CI_REPO_CLONE_URL
org.opencontainers.image.revision: $CI_COMMIT_SHA
org.opencontainers.image.vendor: kokuwa.io
org.opencontainers.image.licenses: EUPL-1.2
org.opencontainers.image.ref.name: kokuwaio/keycloak-event-metrics
org.opencontainers.image.version: snapshot
dockerhub:
image: kokuwaio/dockerhub-metadata
settings:
repository: kokuwaio/keycloak-event-metrics
description-short: Provides metrics for Keycloak user/admin events and user/client/session count.
categories: monitoring-and-observability
username: {from_secret: dockerhub_username}
password: {from_secret: dockerhub_password}
when:
path: [README.md]

26
.woodpecker/lint.yaml Normal file
View file

@ -0,0 +1,26 @@
when:
event: [manual, pull_request, push]
branch: main
path: [.woodpecker/lint.yaml, renovate.json, Dockerfile, "**/*.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"]]
dockerfile:
image: kokuwaio/hadolint
depends_on: []
when: [path: [.woodpecker/lint.yaml, Dockerfile]]

View file

@ -0,0 +1,33 @@
<?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>
<server>
<id>docker.io</id>
<username>${env.DOCKER_IO_USERNAME}</username>
<password>${env.DOCKER_IO_PASSWORD}</password>
</server>
<server>
<id>ghcr.io</id>
<username>${env.GHCR_IO_USERNAME}</username>
<password>${env.GHCR_IO_PASSWORD}</password>
</server>
</servers>
<mirrors>
<mirror>
<url>http://mirror.woodpecker.svc.cluster.local/maven2</url>
<mirrorOf>central</mirrorOf>
</mirror>
</mirrors>
</settings>

61
.woodpecker/release.yaml Normal file
View file

@ -0,0 +1,61 @@
when:
instance: ci.kokuwa.io
repo: kokuwaio/keycloak-event-metrics
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 & write version to env file for image
- mvn release:prepare release:perform
- echo "VERSION=$(mvn help:evaluate --quiet --file=target/checkout/pom.xml -Dexpression=project.version -DforceStdout)" > maven.env
environment:
MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.woodpecker/maven/settings.xml
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}
image:
image: kokuwaio/buildctl
settings:
env-file: maven.env
name:
- docker.io/kokuwaio/keycloak-event-metrics:latest
- docker.io/kokuwaio/keycloak-event-metrics:$VERSION
- ghcr.io/kokuwaio/keycloak-event-metrics:latest
- ghcr.io/kokuwaio/keycloak-event-metrics:$VERSION
build-args: {MAVEN_MIRROR_CENTRAL: "${MAVEN_MIRROR_CENTRAL}"}
platform: [linux/amd64, linux/arm64]
auth:
"https://index.docker.io/v1/":
username: {from_secret: docker_io_username}
password: {from_secret: docker_io_password}
ghcr.io:
username: {from_secret: ghcr_io_username}
password: {from_secret: ghcr_io_password}
annotation:
org.opencontainers.image.title: Keycloak Metrics
org.opencontainers.image.description: Provides metrics for Keycloak user/admin events and user/client/session count.
org.opencontainers.image.url: $CI_REPO_URL
org.opencontainers.image.documentation: $CI_REPO_URL/README.md
org.opencontainers.image.source: $CI_REPO_CLONE_URL
org.opencontainers.image.revision: $CI_COMMIT_SHA
org.opencontainers.image.vendor: kokuwa.io
org.opencontainers.image.licenses: EUPL-1.2
org.opencontainers.image.ref.name: kokuwaio/keycloak-event-metrics
org.opencontainers.image.version: $VERSION

24
.woodpecker/verify.yaml Normal file
View file

@ -0,0 +1,24 @@
when:
event: [manual, pull_request]
path: [.woodpecker/verify.yaml, pom.xml, src/**]
services:
- name: dockerd
image: kokuwaio/dockerd
privileged: true
ports: [2375, 8080]
steps:
test:
image: maven:3.9.10-eclipse-temurin-17
commands: mvn verify -P-deploy
environment:
MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.woodpecker/maven/settings.xml
image:
image: kokuwaio/buildctl
settings:
platform: [linux/amd64, linux/arm64]
when:
instance: ci.kokuwa.io

26
.woodpecker/versions.yaml Normal file
View file

@ -0,0 +1,26 @@
when:
event: [manual, pull_request]
path: [.woodpecker/versions.yaml, pom.xml, src/**]
depends_on: [verify]
matrix:
KEYCLOAK_VERSION:
- 22.0.5
- 23.0.7
- 24.0.5
- 25.0.6
- 26.2.5
services:
- name: dockerd
image: kokuwaio/dockerd
privileged: true
ports: [2375, 8080]
steps:
test:
image: maven:3.9.10-eclipse-temurin-17
commands: mvn verify -Dversion.org.keycloak.test="$KEYCLOAK_VERSION" -P-deploy,-check
environment:
MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.woodpecker/maven/settings.xml

View file

@ -13,7 +13,3 @@ rules:
quoted-strings:
quote-type: double
required: only-when-needed
# allow everything on keys
truthy:
check-keys: false

15
Dockerfile Normal file
View file

@ -0,0 +1,15 @@
FROM maven:3.9.10-eclipse-temurin-17 AS build
SHELL ["/usr/bin/bash", "-e", "-u", "-c"]
WORKDIR /build
ARG MAVEN_ARGS="--batch-mode --color=always --no-transfer-progress"
ARG MAVEN_MIRROR_CENTRAL
RUN mkdir "$HOME/.m2" && printf "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\
<settings>\n\
<localRepository>/tmp/mvn-repo</localRepository>\n\
<mirrors><mirror><url>%s</url><mirrorOf>central</mirrorOf></mirror></mirrors>\n\
</settings>" "${MAVEN_MIRROR_CENTRAL:-https://repo.maven.apache.org/maven2}" > "$HOME/.m2/settings.xml"
COPY . .
RUN --mount=type=cache,target=/tmp/mvn-repo mvn package -DskipTests -P=-dev
FROM busybox:1.37.0-uclibc
COPY --from=build --chmod=444 /build/target/keycloak-event-metrics.jar /opt/keycloak/providers/keycloak-event-metrics.jar

5
Dockerfile.dockerignore Normal file
View file

@ -0,0 +1,5 @@
*
.*
!pom.xml
!src/main/**

425
LICENSE
View file

@ -1,201 +1,288 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
EUROPEAN UNION PUBLIC LICENCE v. 1.2
EUPL © the European Union 2007, 2016
1. Definitions.
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).
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
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:
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
Licensed under the EUPL
"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.
or has expressed by any other means his willingness to license under the EUPL.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
1. Definitions
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
In this Licence, the following terms have the following meaning:
"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.
- The Licence: this Licence.
"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).
- 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" 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.
- 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.
"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."
- The Work: the Original Work or its Derivative Works.
"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.
- The Source Code: the human-readable form of the Work which is the most
convenient for people to study and modify.
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.
- The Executable Code: any code which has generally been compiled and which is
meant to be interpreted by a computer as a program.
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.
- The Licensor: the natural or legal person that distributes or communicates
the Work under the Licence.
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:
- Contributor(s): any natural or legal person who modifies the Work under the
Licence, or otherwise contributes to the creation of a Derivative Work.
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
- The Licensee or You: any natural or legal person who makes any usage of
the Work under the terms of the Licence.
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
- 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.
(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
2. Scope of the rights granted by the Licence
(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.
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:
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.
- 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.
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.
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.
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.
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.
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.
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.
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.
3. Communication of the Source Code
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.
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.
END OF TERMS AND CONDITIONS
4. Limitations on copyright
APPENDIX: How to apply the Apache License to your work.
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.
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.
5. Obligations of the Licensee
Copyright [yyyy] [name of copyright owner]
The grant of the rights mentioned above is subject to some restrictions and
obligations imposed on the Licensee. Those obligations are the following:
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
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.
http://www.apache.org/licenses/LICENSE-2.0
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.
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.
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.

105
README.md
View file

@ -1,10 +1,15 @@
# Keycloak Event Metrics
# Keycloak Metrics
Provides metrics for Keycloak user/admin events. Tested on Keycloak [20-21](.github/workflows/ci.yaml#L74-L77).
Provides metrics for Keycloak user/admin events and user/client/session count. Tested on Keycloak [22-26](.woodpecker/verify.yaml#L7-L11).
[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/kokuwaio/keycloak-event-metrics.svg?label=License)](http://www.apache.org/licenses/)
[![Maven Central](https://img.shields.io/maven-central/v/io.kokuwa.keycloak/keycloak-event-metrics.svg?label=Maven%20Central)](https://central.sonatype.com/search?namespace=io.kokuwa.keycloak&q=keycloak-event-metrics)
[![CI](https://img.shields.io/github/actions/workflow/status/kokuwaio/keycloak-event-metrics/ci.yaml?branch=main&label=CI)](https://github.com/kokuwaio/keycloak-event-metrics/actions/workflows/ci.yaml?query=branch%3Amain)
[![maven](https://img.shields.io/maven-central/v/io.kokuwa.keycloak/keycloak-event-metrics.svg?label=maven)](https://central.sonatype.com/artifact/io.kokuwa.keycloak/keycloak-event-metrics)
[![pulls](https://img.shields.io/docker/pulls/kokuwaio/keycloak-event-metrics)](https://hub.docker.com/r/kokuwaio/keycloak-event-metrics)
[![size](https://img.shields.io/docker/image-size/kokuwaio/keycloak-event-metrics)](https://hub.docker.com/r/kokuwaio/keycloak-event-metrics)
[![dockerfile](https://img.shields.io/badge/source-Dockerfile%20-blue)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/src/branch/main/Dockerfile)
[![license](https://img.shields.io/badge/license-EUPL%201.2-blue)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/src/branch/main/LICENSE)
[![issues](https://img.shields.io/gitea/issues/open/kokuwaio/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/issues)
[![prs](https://img.shields.io/gitea/pull-requests/open/kokuwaio/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/pulls)
[![build](https://ci.kokuwa.io/api/badges/kokuwaio/keycloak-event-metrics/status.svg)](https://ci.kokuwa.io/repos/kokuwaio/keycloak-event-metrics/)
## Why?
@ -14,7 +19,8 @@ Provides metrics for Keycloak user/admin events. Tested on Keycloak [20-21](.git
* no realm specific Prometheus endpoint, only `/metrics` (from Quarkus)
* no jvm/http metrics, this is [already](https://www.keycloak.org/server/configuration-metrics#_available_metrics) included in Keycloak
* different metric names, can relace model ids with name (see [configuration](#kc_metrics_event_replace_ids))
* deployed to maven central and very small (10 kb vs. 229 KB [aerogear/keycloak-metrics-spi](https://github.com/aerogear/keycloak-metrics-spi))
* deployed to maven central and very small (15 kb vs. 151 KB [aerogear/keycloak-metrics-spi](https://github.com/aerogear/keycloak-metrics-spi))
* gauge for active/offline sessions and user/client count
## What?
@ -26,7 +32,7 @@ User events are added with key `keycloak_event_user_total` and tags:
* `type`: [EventType](https://github.com/keycloak/keycloak/blob/main/server-spi-private/src/main/java/org/keycloak/events/EventType.java#L27) from [Event#type](https://github.com/keycloak/keycloak/blob/main/server-spi-private/src/main/java/org/keycloak/events/Event.java#L44)
* `realm`: realm id from [Event#realmId](https://github.com/keycloak/keycloak/blob/main/server-spi-private/src/main/java/org/keycloak/events/Event.java#L46)
* `client`: client id from [Event#clientId](https://github.com/keycloak/keycloak/blob/main/server-spi-private/src/main/java/org/keycloak/events/Event.java#L48)
* `client`: client id from [Event#clientId](https://github.com/keycloak/keycloak/blob/main/server-spi-private/src/main/java/org/keycloak/events/Event.java#L48), unknown client_ids are grouped into UNKOWN
* `error`: error from [Event#error](https://github.com/keycloak/keycloak/blob/main/server-spi-private/src/main/java/org/keycloak/events/Event.java#L56), only present for error types
Examples:
@ -35,6 +41,7 @@ Examples:
keycloak_event_user_total{client="test",realm="9039a0b5-e8c9-437a-a02e-9d91b04548a4",type="LOGIN",error="",} 2.0
keycloak_event_user_total{client="test",realm="1fdb3465-1675-49e8-88ad-292e2f42ee72",type="LOGIN",error="",} 1.0
keycloak_event_user_total{client="test",realm="1fdb3465-1675-49e8-88ad-292e2f42ee72",type="LOGIN_ERROR",error="invalid_user_credentials",} 1.0
keycloak_event_user_total{client="UNKNOWN",realm="1fdb3465-1675-49e8-88ad-292e2f42ee72",type="LOGIN_ERROR",error="invalid_user_credentials",} 1.0
```
### Admin Events
@ -57,7 +64,7 @@ keycloak_event_admin_total{error="",operation="CREATE",realm="9039a0b5-e8c9-437a
### `KC_METRICS_EVENT_REPLACE_IDS`
If set to `true` than replace model ids with names:
Set to `true` (the default value) than replace model ids from events with names:
* [RealmModel#getId()](https://github.com/keycloak/keycloak/blob/main/server-spi/src/main/java/org/keycloak/models/RealmModel.java#L82) with [RealmModel#getName()](https://github.com/keycloak/keycloak/blob/main/server-spi/src/main/java/org/keycloak/models/RealmModel.java#L84)
@ -69,28 +76,102 @@ keycloak_event_user_total{client="other-client",error="",realm="other-realm",typ
keycloak_event_user_total{client="other-client",error="invalid_user_credentials",realm="other-realm",type="LOGIN_ERROR",} 1.0
```
### `KC_METRICS_STATS_ENABLED`
Set to `true` (default is `false`) to provide metrics for user/client count per realm and session count per client. Metrics:
```txt
# HELP keycloak_users
# TYPE keycloak_users gauge
keycloak_users{realm="master",} 1.0
keycloak_users{realm="my-realm",} 2.0
keycloak_users{realm="other-realm",} 1.0# HELP keycloak_active_user_sessions
# TYPE keycloak_active_user_sessions gauge
keycloak_active_user_sessions{client="admin-cli",realm="userCount_1",} 0.0
keycloak_active_user_sessions{client="admin-cli",realm="userCount_2",} 0.0
keycloak_active_user_sessions{client="admin-cli",realm="master",} 1.0
# TYPE keycloak_active_client_sessions gauge
keycloak_active_client_sessions{client="admin-cli",realm="userCount_1",} 0.0
keycloak_active_client_sessions{client="admin-cli",realm="userCount_2",} 0.0
keycloak_active_client_sessions{client="admin-cli",realm="master",} 0.0
# TYPE keycloak_offline_sessions gauge
keycloak_offline_sessions{client="admin-cli",realm="userCount_1",} 0.0
keycloak_offline_sessions{client="admin-cli",realm="userCount_2",} 0.0
keycloak_offline_sessions{client="admin-cli",realm="master",} 0.0
```
### `KC_METRICS_STATS_INTERVAL`
If `KC_METRICS_STATS_ENABLED` is `true` this will define the interval for scraping. If not configured `PT60s` will be used.
### `KC_METRICS_STATS_INFO_THRESHOLD` and `KC_METRICS_STATS_WARN_THRESHOLD`
If `KC_METRICS_STATS_ENABLED` is `true` this envs will define logging if scraping takes to long. Both envs are parsed as `java.lang.Duration`.
Default values:
* `KC_METRICS_STATS_INFO_THRESHOLD`: 50% of `KC_METRICS_STATS_INTERVAL` = 30s
* `KC_METRICS_STATS_WARN_THRESHOLD`: 75% of `KC_METRICS_STATS_INTERVAL` = 45s
If scrapping takes less than `KC_METRICS_STATS_INFO_THRESHOLD` duration will be logged on debug level.
## Installation
### Grafana Dashboard
Can be found here: [keycloak-metrics.json](https://git.kokuwa.io/keycloak/keycloak/blob/main/src/test/k3s/dev/grafana/files/dashboards/keycloak-metrics.json)
### Testcontainers
For usage in [Testcontainers](https://www.testcontainers.org/) see [KeycloakExtension.java](src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java#L57-L68)
### Container Image
Registries:
* [ghcr.io/kokuwaio/keycloak-event-metrics](https://github.com/kokuwaio/keycloak-event-metrics/pkgs/container/keycloak-event-metrics)
* [docker.io/kokuwaio/keycloak-event-metrics](https://hub.docker.com/r/kokuwaio/keycloak-event-metrics)
This images are based on busybox, so you can use cp to copy the jar into your keycloak.
### Docker
Check: [kokuwaio/keycloak](https://github.com/kokuwaio/keycloak)
Check: [kowaio/keycloak](https://git.kokuwa.io/keycloak/keycloak)
Dockerfile:
```Dockerfile
FROM quay.io/keycloak/keycloak:21.0.1
###
### download keycloak event metrics
###
FROM debian:stable-slim AS metrics
RUN apt-get -qq update
RUN apt-get -qq install --yes --no-install-recommends ca-certificates wget
ARG METRICS_VERSION=2.0.0
ARG METRICS_FILE=keycloak-event-metrics-${METRICS_VERSION}.jar
ARG METRICS_URL=https://repo1.maven.org/maven2/io/kokuwa/keycloak/keycloak-event-metrics/${METRICS_VERSION}
RUN wget --quiet --no-hsts ${METRICS_URL}/${METRICS_FILE}
RUN wget --quiet --no-hsts ${METRICS_URL}/${METRICS_FILE}.sha1
RUN echo "$(cat ${METRICS_FILE}.sha1) ${METRICS_FILE}" sha1sum --quiet --check --strict -
RUN mkdir -p /opt/keycloak/providers
RUN mv ${METRICS_FILE} /opt/keycloak/providers
###
### build keycloak with metrics
###
FROM quay.io/keycloak/keycloak:25.2.5
ENV KEYCLOAK_ADMIN=admin
ENV KEYCLOAK_ADMIN_PASSWORD=password
ENV KC_HEALTH_ENABLED=true
ENV KC_METRICS_ENABLED=true
ENV KC_LOG_CONSOLE_COLOR=true
ADD target/keycloak-event-metrics-0.0.1-SNAPSHOT.jar /opt/keycloak/providers
COPY --from=metrics /opt/keycloak/providers /opt/keycloak/providers
RUN /opt/keycloak/bin/kc.sh build
```

498
pom.xml
View file

@ -4,11 +4,11 @@
<groupId>io.kokuwa.keycloak</groupId>
<artifactId>keycloak-event-metrics</artifactId>
<version>0.2.1</version>
<version>2.0.1-SNAPSHOT</version>
<name>Keycloak Metrics</name>
<description>Provides metrics for Keycloak user/admin events</description>
<url>https://github.com/kokuwaio/keycloak-event-metrics</url>
<url>https://git.kokuwa.io/kokuwaio/keycloak-event-metrics</url>
<inceptionYear>2023</inceptionYear>
<organization>
<name>Kokuwa.io</name>
@ -16,45 +16,41 @@
</organization>
<licenses>
<license>
<name>Apache License 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0</url>
<name>EUPL-1.2</name>
<url>https://eupl.eu/1.2/en</url>
<distribution>repo</distribution>
</license>
</licenses>
<developers>
<developer>
<id>stephanschnabel</id>
<id>stephan.schnabel</id>
<name>Stephan Schnabel</name>
<url>https://github.com/sschnabe</url>
<email>stephan@grayc.de</email>
<organization>GrayC GmbH</organization>
<organizationUrl>https://grayc.de</organizationUrl>
<url>https://schnabel.org</url>
<email>stephan@schnabel.org</email>
<timezone>Europe/Berlin</timezone>
</developer>
</developers>
<scm>
<url>https://github.com/kokuwaio/keycloak-event-metrics</url>
<connection>scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git</connection>
<developerConnection>scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git</developerConnection>
<tag>0.2.1</tag>
<url>https://git.kokuwa.io/kokuwaio/keycloak-event-metrics</url>
<connection>scm:git:https://git.kokuwa.io/kokuwaio/keycloak-event-metrics.git</connection>
<developerConnection>scm:git:https://git.kokuwa.io/kokuwaio/keycloak-event-metrics.git</developerConnection>
<tag>HEAD</tag>
</scm>
<issueManagement>
<system>github</system>
<url>https://github.com/kokuwaio/keycloak-event-metrics/issues</url>
<system>forgejo</system>
<url>https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/issues</url>
</issueManagement>
<ciManagement>
<system>github</system>
<url>https://github.com/kokuwaio/keycloak-event-metrics/actions</url>
<system>woodpecker</system>
<url>https://ci.kokuwa.io/repos/kokuwaio/keycloak-event-metrics</url>
</ciManagement>
<distributionManagement>
<snapshotRepository>
<id>sonatype-nexus</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<id>sonatype.org</id>
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
</snapshotRepository>
<repository>
<id>sonatype-nexus</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
</repository>
</distributionManagement>
<properties>
@ -63,73 +59,40 @@
<!-- =============================== Build =============================== -->
<!-- ===================================================================== -->
<project.build.outputTimestamp>2025-06-25T14:15:39Z</project.build.outputTimestamp>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.build.propertiesEncoding>ISO-8859-1</project.build.propertiesEncoding>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>
<maven.compiler.showWarnings>true</maven.compiler.showWarnings>
<maven.compiler.release>17</maven.compiler.release>
<maven.compiler.source>${maven.compiler.release}</maven.compiler.source>
<maven.compiler.target>${maven.compiler.release}</maven.compiler.target>
<maven.compiler.compilerArgument>-Xlint:all</maven.compiler.compilerArgument>
<maven.compiler.failOnWarning>true</maven.compiler.failOnWarning>
<maven.test.redirectTestOutputToFile>true</maven.test.redirectTestOutputToFile>
<maven.compiler.showWarnings>true</maven.compiler.showWarnings>
<maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>
<impsort.removeUnused>true</impsort.removeUnused>
<impsort.groups>java.,javax.,jakarta.,org.</impsort.groups>
<formatter.configFile>${project.basedir}/src/eclipse/formatter.xml</formatter.configFile>
<!-- ===================================================================== -->
<!-- ============================== Libaries ============================= -->
<!-- ============================= Versions ============================== -->
<!-- ===================================================================== -->
<!-- plugins -->
<version.org.apache.maven.plugins.checkstyle>3.2.1</version.org.apache.maven.plugins.checkstyle>
<version.org.apache.maven.plugins.clean>3.2.0</version.org.apache.maven.plugins.clean>
<version.org.apache.maven.plugins.compiler>3.11.0</version.org.apache.maven.plugins.compiler>
<version.org.apache.maven.plugins.dependency>3.5.0</version.org.apache.maven.plugins.dependency>
<version.org.apache.maven.plugins.deploy>3.1.1</version.org.apache.maven.plugins.deploy>
<version.org.apache.maven.plugins.gpg>3.0.1</version.org.apache.maven.plugins.gpg>
<version.org.apache.maven.plugins.install>3.1.1</version.org.apache.maven.plugins.install>
<version.org.apache.maven.plugins.jar>3.3.0</version.org.apache.maven.plugins.jar>
<version.org.apache.maven.plugins.javadoc>1.0.0</version.org.apache.maven.plugins.javadoc>
<version.org.apache.maven.plugins.release>3.0.0</version.org.apache.maven.plugins.release>
<version.org.apache.maven.plugins.resources>3.3.1</version.org.apache.maven.plugins.resources>
<version.org.apache.maven.plugins.source>3.2.1</version.org.apache.maven.plugins.source>
<version.org.apache.maven.plugins.surefire>3.0.0</version.org.apache.maven.plugins.surefire>
<version.org.codehaus.mojo.tidy>1.2.0</version.org.codehaus.mojo.tidy>
<version.org.sonatype.plugins.nexus-staging>1.6.13</version.org.sonatype.plugins.nexus-staging>
<version.com.puppycrawl.tools.checkstyle>10.9.3</version.com.puppycrawl.tools.checkstyle>
<version.io.kokuwa.checkstyle>0.5.6</version.io.kokuwa.checkstyle>
<!-- dependencies -->
<version.org.keycloak>21.1.0</version.org.keycloak>
<version.org.mockito>5.2.0</version.org.mockito>
<version.org.testcontainers>1.18.0</version.org.testcontainers>
<version.org.keycloak>26.2.5</version.org.keycloak>
<version.org.keycloak.test>${version.org.keycloak}</version.org.keycloak.test>
</properties>
<dependencyManagement>
<dependencies>
<!-- keycloak -->
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-parent</artifactId>
<artifactId>keycloak-quarkus-server</artifactId>
<version>${version.org.keycloak}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- test -->
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
<version>${version.org.mockito}</version>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>testcontainers-bom</artifactId>
<version>${version.org.testcontainers}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
@ -138,41 +101,92 @@
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-core</artifactId>
<version>${version.org.keycloak.test}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-server-spi</artifactId>
<version>${version.org.keycloak.test}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-server-spi-private</artifactId>
<version>${version.org.keycloak.test}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-quarkus-server</artifactId>
<scope>provided</scope>
<exclusions>
<exclusion><!-- references ancient `commons-io` -->
<groupId>com.openshift</groupId>
<artifactId>openshift-restclient-java</artifactId>
</exclusion>
<exclusion>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-admin-ui</artifactId>
</exclusion>
<exclusion>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-account-ui</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-admin-client</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.glassfish.jaxb</groupId>
<artifactId>jaxb-runtime</artifactId>
</exclusion>
<exclusion>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-multipart-provider</artifactId>
</exclusion>
<!-- The POM for ... is invalid -->
<exclusion>
<groupId>com.sun.istack</groupId>
<artifactId>istack-commons-tools</artifactId>
</exclusion>
<exclusion>
<groupId>com.sun.istack</groupId>
<artifactId>istack-commons-runtime</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- libraries -->
<dependency>
<groupId>org.jboss.logging</groupId>
<artifactId>jboss-logging</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.jboss.logging</groupId>
<artifactId>commons-logging-jboss-logging</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.hibernate.orm</groupId>
<artifactId>hibernate-core</artifactId>
<scope>provided</scope>
<exclusions>
<exclusion>
<groupId>javax.xml.bind</groupId>
<artifactId>jaxb-api</artifactId>
</exclusion>
<exclusion>
<groupId>org.glassfish.jaxb</groupId>
<artifactId>jaxb-runtime</artifactId>
</exclusion>
<exclusion>
<groupId>org.hibernate.common</groupId>
<artifactId>hibernate-commons-annotations</artifactId>
</exclusion>
<exclusion>
<groupId>org.jboss</groupId>
<artifactId>jandex</artifactId>
</exclusion>
<exclusion>
<groupId>antlr</groupId>
<artifactId>antlr</artifactId>
</exclusion>
<exclusion>
<groupId>com.fasterxml</groupId>
<artifactId>classmate</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.micrometer</groupId>
<artifactId>micrometer-core</artifactId>
<scope>provided</scope>
</dependency>
<!-- test -->
@ -183,19 +197,14 @@
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency><!-- is missing and necessary for `keycloak-admin-client` -->
<groupId>org.wildfly.client</groupId>
<artifactId>wildfly-client-config</artifactId>
<version>1.0.1.Final</version>
<artifactId>testcontainers</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<finalName>${project.artifactId}</finalName>
<testResources>
<testResource>
<directory>${project.basedir}/src/test/resources</directory>
@ -204,149 +213,108 @@
</testResources>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${version.org.apache.maven.plugins.checkstyle}</version>
<configuration>
<configLocation>checkstyle.xml</configLocation>
<suppressionsLocation>checkstyle-suppression.xml</suppressionsLocation>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
</configuration>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>${version.com.puppycrawl.tools.checkstyle}</version>
</dependency>
<dependency>
<groupId>io.kokuwa</groupId>
<artifactId>maven-parent</artifactId>
<version>${version.io.kokuwa.checkstyle}</version>
<type>zip</type>
<classifier>checkstyle</classifier>
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>${version.org.apache.maven.plugins.clean}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${version.org.apache.maven.plugins.compiler}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<version>${version.org.apache.maven.plugins.dependency}</version>
<version>3.14.0</version>
<configuration>
<compilerArgument>${maven.compiler.compilerArgument}</compilerArgument>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>${version.org.apache.maven.plugins.deploy}</version>
<version>3.1.4</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-failsafe-plugin</artifactId>
<version>${version.org.apache.maven.plugins.surefire}</version>
<configuration>
<failIfNoTests>true</failIfNoTests>
<redirectTestOutputToFile>${maven.test.redirectTestOutputToFile}</redirectTestOutputToFile>
</configuration>
<version>3.5.3</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>${version.org.apache.maven.plugins.gpg}</version>
<version>3.2.7</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<version>${version.org.apache.maven.plugins.install}</version>
<version>3.1.4</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>${version.org.apache.maven.plugins.jar}</version>
<version>3.4.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${version.org.apache.maven.plugins.jar}</version>
<version>3.11.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>${version.org.apache.maven.plugins.release}</version>
<version>3.1.1</version>
<configuration>
<tagNameFormat>@{project.version}</tagNameFormat>
<releaseProfiles>release</releaseProfiles>
<localCheckout>true</localCheckout>
<preparationGoals>test</preparationGoals>
<preparationProfiles>check</preparationProfiles>
<goals>deploy -DskipITs</goals>
<releaseProfiles>deploy,release</releaseProfiles>
<signTag>true</signTag>
<scmReleaseCommitComment>@{prefix} prepare release @{releaseLabel} [no ci]</scmReleaseCommitComment>
<scmReleaseCommitComment>@{prefix} prepare release @{releaseLabel} [CI SKIP]</scmReleaseCommitComment>
<tagNameFormat>@{project.version}</tagNameFormat>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>${version.org.apache.maven.plugins.source}</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>${version.org.apache.maven.plugins.resources}</version>
<version>3.3.1</version>
<configuration>
<propertiesEncoding>UTF-8</propertiesEncoding>
<propertiesEncoding>${project.build.propertiesEncoding}</propertiesEncoding>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.21.0</version>
</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>${version.org.apache.maven.plugins.surefire}</version>
<version>3.5.3</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
<version>${version.org.codehaus.mojo.tidy}</version>
<version>1.4.0</version>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>${version.org.sonatype.plugins.nexus-staging}</version>
<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>${formatter.configFile}</configFile>
</configuration>
</plugin>
<plugin>
<groupId>net.revelc.code</groupId>
<artifactId>impsort-maven-plugin</artifactId>
<version>1.12.0</version>
</plugin>
</plugins>
</pluginManagement>
<plugins>
<!-- fail if any pom is dirty -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>tidy-maven-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- fail if checkstyle reports problems -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- run tests -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@ -361,29 +329,143 @@
</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>release</id>
<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 for downstream projects -->
<!-- add source/javadoc -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>jar-no-fork</goal>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- add javadoc for downstream projects -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
@ -396,7 +478,7 @@
</executions>
</plugin>
<!-- sign documents before upload -->
<!-- sign before upload -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
@ -405,22 +487,30 @@
<goals>
<goal>sign</goal>
</goals>
<configuration>
<signer>bc</signer>
</configuration>
</execution>
</executions>
</plugin>
<!-- autoclose sonatype nexus repo -->
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<serverId>sonatype-nexus</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</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>

5
renovate.json Normal file
View file

@ -0,0 +1,5 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["local>kokuwaio/renovate-config", ":reviewer(stephan.schnabel)"],
"pinDigests": false
}

404
src/eclipse/formatter.xml Normal file
View file

@ -0,0 +1,404 @@
<?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,48 +0,0 @@
package io.kokuwa.keycloak.metrics;
import javax.enterprise.inject.spi.CDI;
import org.jboss.logging.Logger;
import org.keycloak.Config.Scope;
import org.keycloak.events.EventListenerProvider;
import org.keycloak.events.EventListenerProviderFactory;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
import io.micrometer.core.instrument.MeterRegistry;
/**
* Factory for {@link MicrometerEventListener}, uses {@link MeterRegistry} from CDI.
*
* @author Stephan Schnabel
*/
public class MicrometerEventListenerFactory implements EventListenerProviderFactory {
private static final Logger log = Logger.getLogger(MicrometerEventListener.class);
private MeterRegistry registry;
private boolean replace;
@Override
public String getId() {
return "metrics-listener";
}
@Override
public void init(Scope config) {
replace = "true".equals(System.getenv("KC_METRICS_EVENT_REPLACE_IDS"));
log.info(replace ? "Configured with model names." : "Configured with model ids.");
}
@Override
public void postInit(KeycloakSessionFactory factory) {
registry = CDI.current().select(MeterRegistry.class).get();
}
@Override
public EventListenerProvider create(KeycloakSession session) {
return new MicrometerEventListener(registry, session, replace);
}
@Override
public void close() {}
}

View file

@ -1,49 +1,49 @@
package io.kokuwa.keycloak.metrics;
package io.kokuwa.keycloak.metrics.event;
import java.util.Objects;
import java.util.Optional;
import org.jboss.logging.Logger;
import org.keycloak.events.Event;
import org.keycloak.events.EventListenerProvider;
import org.keycloak.events.admin.AdminEvent;
import org.keycloak.models.ClientModel;
import org.keycloak.models.KeycloakContext;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Metrics;
/**
* Listener for {@link Event} and {@link AdminEvent}.
*
* @author Stephan Schnabel
*/
public class MicrometerEventListener implements EventListenerProvider, AutoCloseable {
public class MetricsEventListener implements EventListenerProvider, AutoCloseable {
private static final Logger log = Logger.getLogger(MicrometerEventListener.class);
private final MeterRegistry registry;
private static final Logger log = Logger.getLogger(MetricsEventListener.class);
private final boolean replaceIds;
private final KeycloakSession session;
private final boolean replace;
MicrometerEventListener(MeterRegistry registry, KeycloakSession session, boolean replaceId) {
this.registry = registry;
MetricsEventListener(boolean replaceIds, KeycloakSession session) {
this.replaceIds = replaceIds;
this.session = session;
this.replace = replaceId;
}
@Override
public void onEvent(Event event) {
registry.counter("keycloak_event_user",
"realm", toBlank(replace ? getRealmName(event.getRealmId()) : event.getRealmId()),
Metrics.counter("keycloak_event_user",
"realm", toBlank(replaceIds ? getRealmName(event.getRealmId()) : event.getRealmId()),
"type", toBlank(event.getType()),
"client", toBlank(event.getClientId()),
"client", getClientId(event.getClientId()),
"error", toBlank(event.getError()))
.increment();
}
@Override
public void onEvent(AdminEvent event, boolean includeRepresentation) {
registry.counter("keycloak_event_admin",
"realm", toBlank(replace ? getRealmName(event.getRealmId()) : event.getRealmId()),
Metrics.counter("keycloak_event_admin",
"realm", toBlank(replaceIds ? getRealmName(event.getRealmId()) : event.getRealmId()),
"resource", toBlank(event.getResourceType()),
"operation", toBlank(event.getOperationType()),
"error", toBlank(event.getError()))
@ -67,6 +67,17 @@ public class MicrometerEventListener implements EventListenerProvider, AutoClose
});
}
private String getClientId(String clientId) {
return Optional.ofNullable(session.getContext())
.map(KeycloakContext::getClient)
.filter(model -> Objects.equals(model.getClientId(), clientId))
.map(ClientModel::getClientId)
.orElseGet(() -> {
log.tracev("Client for id {0} is unknown", clientId);
return "UNKNOWN";
});
}
private String toBlank(Object value) {
return value == null ? "" : value.toString();
}

View file

@ -0,0 +1,41 @@
package io.kokuwa.keycloak.metrics.event;
import org.jboss.logging.Logger;
import org.keycloak.Config.Scope;
import org.keycloak.events.EventListenerProvider;
import org.keycloak.events.EventListenerProviderFactory;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
/**
* Factory for {@link MetricsEventListener}.
*
* @author Stephan Schnabel
*/
public class MetricsEventListenerFactory implements EventListenerProviderFactory {
private static final Logger log = Logger.getLogger(MetricsEventListenerFactory.class);
private boolean replaceIds;
@Override
public String getId() {
return "metrics-listener";
}
@Override
public void init(Scope config) {
replaceIds = "true".equals(System.getenv().getOrDefault("KC_METRICS_EVENT_REPLACE_IDS", "true"));
log.info(replaceIds ? "Configured with model names." : "Configured with model ids.");
}
@Override
public void postInit(KeycloakSessionFactory factory) {}
@Override
public EventListenerProvider create(KeycloakSession session) {
return new MetricsEventListener(replaceIds, session);
}
@Override
public void close() {}
}

View file

@ -0,0 +1,10 @@
package io.kokuwa.keycloak.metrics.stats;
import org.keycloak.provider.ProviderFactory;
/**
* Factory for Keycloak metrics.
*
* @author Stephan Schnabel
*/
public interface MetricsStatsFactory extends ProviderFactory<MetricsStatsTask> {}

View file

@ -0,0 +1,71 @@
package io.kokuwa.keycloak.metrics.stats;
import java.time.Duration;
import java.util.Optional;
import org.jboss.logging.Logger;
import org.keycloak.Config.Scope;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
import org.keycloak.models.utils.KeycloakModelUtils;
import org.keycloak.timer.TimerProvider;
/**
* Implementation of {@link MetricsStatsFactory}.
*
* @author Stephan Schnabel
*/
public class MetricsStatsFactoryImpl implements MetricsStatsFactory {
private static final Logger log = Logger.getLogger(MetricsStatsFactory.class);
@Override
public String getId() {
return "default";
}
@Override
public void init(Scope config) {}
@Override
public void postInit(KeycloakSessionFactory factory) {
if (!"true".equals(getenv("KC_METRICS_STATS_ENABLED"))) {
log.infov("Keycloak stats not enabled.");
return;
}
var intervalDuration = Optional
.ofNullable(getenv("KC_METRICS_STATS_INTERVAL"))
.map(Duration::parse)
.orElse(Duration.ofSeconds(60));
var infoThreshold = Optional
.ofNullable(getenv("KC_METRICS_STATS_INFO_THRESHOLD"))
.map(Duration::parse)
.orElse(Duration.ofMillis(Double.valueOf(intervalDuration.toMillis() * 0.5).longValue()));
var warnThreshold = Optional
.ofNullable(getenv("KC_METRICS_STATS_WARN_THRESHOLD"))
.map(Duration::parse)
.orElse(Duration.ofMillis(Double.valueOf(intervalDuration.toMillis() * 0.75).longValue()));
log.infov("Keycloak stats enabled with interval of {0} and info/warn after {1}/{2}.",
intervalDuration, infoThreshold, warnThreshold);
var interval = intervalDuration.toMillis();
var task = new MetricsStatsTask(intervalDuration, infoThreshold, warnThreshold);
KeycloakModelUtils.runJobInTransaction(factory, session -> session
.getProvider(TimerProvider.class)
.scheduleTask(task, interval, "metrics"));
}
@Override
public MetricsStatsTask create(KeycloakSession session) {
return null;
}
@Override
public void close() {}
String getenv(String key) {
return System.getenv().get(key);
}
}

View file

@ -0,0 +1,34 @@
package io.kokuwa.keycloak.metrics.stats;
import org.keycloak.provider.Provider;
import org.keycloak.provider.ProviderFactory;
import org.keycloak.provider.Spi;
/**
* SPI for Keycloak metrics.
*
* @author Stephan Schnabel
*/
public class MetricsStatsSpi implements Spi {
@Override
public boolean isInternal() {
return false;
}
@Override
public String getName() {
return "metrics";
}
@Override
public Class<? extends Provider> getProviderClass() {
return MetricsStatsTask.class;
}
@Override
public Class<? extends ProviderFactory<? extends Provider>> getProviderFactoryClass() {
// this must be an interface, otherwise spi will be silenty ignored
return MetricsStatsFactory.class;
}
}

View file

@ -0,0 +1,92 @@
package io.kokuwa.keycloak.metrics.stats;
import java.time.Duration;
import java.time.Instant;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicLong;
import org.jboss.logging.Logger;
import org.keycloak.models.KeycloakSession;
import org.keycloak.provider.Provider;
import org.keycloak.timer.ScheduledTask;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.Tag;
/**
* Keycloak metrics.
*
* @author Stephan Schnabel
*/
public class MetricsStatsTask implements Provider, ScheduledTask {
private static final Logger log = Logger.getLogger(MetricsStatsTask.class);
private static final Map<String, AtomicLong> values = new HashMap<>();
private final Duration interval;
private final Duration infoThreshold;
private final Duration warnThreshold;
MetricsStatsTask(Duration interval, Duration infoThreshold, Duration warnThreshold) {
this.interval = interval;
this.infoThreshold = infoThreshold;
this.warnThreshold = warnThreshold;
}
@Override
public void run(KeycloakSession session) {
log.tracev("Triggered metrics stats task.");
var start = Instant.now();
try {
scrape(session);
} catch (org.hibernate.exception.SQLGrammarException e) {
log.infov("Metrics status task skipped, database not ready.");
return;
} catch (Exception e) {
log.errorv(e, "Failed to scrape stats.");
return;
}
var duration = Duration.between(start, Instant.now());
if (duration.compareTo(interval) > 0) {
log.errorv("Finished scrapping keycloak stats in {0}, consider to increase interval.", duration);
} else if (duration.compareTo(warnThreshold) > 0) {
log.warnv("Finished scrapping keycloak stats in {0}, consider to increase interval.", duration);
} else if (duration.compareTo(infoThreshold) > 0) {
log.infov("Finished scrapping keycloak stats in {0}.", duration);
} else {
log.debugv("Finished scrapping keycloak stats in {0}.", duration);
}
}
@Override
public void close() {}
private void scrape(KeycloakSession session) {
session.realms().getRealmsStream().forEach(realm -> {
session.getContext().setRealm(realm);
log.tracev("Scrape for realm {0}.", realm.getName());
var tagRealm = Tag.of("realm", realm.getName());
gauge("keycloak_users", Set.of(tagRealm), session.users().getUsersCount(realm), true);
gauge("keycloak_clients", Set.of(tagRealm), session.clients().getClientsCount(realm), true);
var sessions = session.sessions();
var activeSessions = sessions.getActiveClientSessionStats(realm, false);
realm.getClientsStream().forEach(client -> {
var tags = Set.of(tagRealm, Tag.of("client", client.getClientId()));
gauge("keycloak_offline_sessions", tags, sessions.getOfflineSessionsCount(realm, client), false);
gauge("keycloak_active_user_sessions", tags, sessions.getActiveUserSessions(realm, client), false);
gauge("keycloak_active_client_sessions", tags, activeSessions.getOrDefault(client.getId(), 0L), false);
});
});
}
private void gauge(String name, Set<Tag> tags, long value, boolean force) {
var key = name + tags;
if (!force && value == 0 && !values.containsKey(key)) {
return;
}
values.computeIfAbsent(key, s -> Metrics.gauge(name, tags, new AtomicLong())).set(value);
}
}

View file

@ -0,0 +1 @@
io.kokuwa.keycloak.metrics.stats.MetricsStatsFactoryImpl

View file

@ -1 +1 @@
io.kokuwa.keycloak.metrics.MicrometerEventListenerFactory
io.kokuwa.keycloak.metrics.event.MetricsEventListenerFactory

View file

@ -0,0 +1 @@
io.kokuwa.keycloak.metrics.stats.MetricsStatsSpi

View file

@ -1,11 +1,16 @@
package io.kokuwa.keycloak.metrics;
import static org.junit.jupiter.api.Assertions.assertAll;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.time.Instant;
import java.util.UUID;
import java.util.function.Supplier;
import jakarta.ws.rs.NotAuthorizedException;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
@ -14,7 +19,7 @@ import org.keycloak.events.EventType;
import io.kokuwa.keycloak.metrics.junit.KeycloakClient;
import io.kokuwa.keycloak.metrics.junit.KeycloakExtension;
import io.kokuwa.keycloak.metrics.prometheus.Prometheus;
import io.kokuwa.keycloak.metrics.junit.Prometheus;
/**
* Integration tests with Keycloak.
@ -28,22 +33,25 @@ public class KeycloakIT {
@Test
void loginAndAttempts(KeycloakClient keycloak, Prometheus prometheus) {
var clientId1 = UUID.randomUUID().toString();
var realmName1 = UUID.randomUUID().toString();
var realmName1 = "loginAndAttempts_1";
var clientId1 = realmName1 + "_client_1";
var username1 = UUID.randomUUID().toString();
var password1 = UUID.randomUUID().toString();
keycloak.createRealm(realmName1);
keycloak.createClient(realmName1, clientId1);
keycloak.createUser(realmName1, username1, password1);
var clientId2 = UUID.randomUUID().toString();
var realmName2 = UUID.randomUUID().toString();
var realmName2 = "loginAndAttempts_2";
var clientId2 = realmName2 + "_client_2";
var username2 = UUID.randomUUID().toString();
var password2 = UUID.randomUUID().toString();
keycloak.createRealm(realmName2);
keycloak.createClient(realmName2, clientId2);
keycloak.createUser(realmName2, username2, password2);
var clientId3 = realmName2 + "_" + UUID.randomUUID();
var clientId4 = realmName2 + "_" + UUID.randomUUID();
prometheus.scrap();
var loginBefore = prometheus.userEvent(EventType.LOGIN);
var loginBefore1 = prometheus.userEvent(EventType.LOGIN, realmName1, clientId1);
@ -51,11 +59,14 @@ public class KeycloakIT {
var loginErrorBefore = prometheus.userEvent(EventType.LOGIN_ERROR);
var loginErrorBefore1 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName1, clientId1);
var loginErrorBefore2 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId2);
var loginErrorBeforeUNKNOWN = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, "UNKNOWN");
assertTrue(keycloak.login(clientId1, realmName1, username1, password1));
assertTrue(keycloak.login(clientId1, realmName1, username1, password1));
assertTrue(keycloak.login(clientId2, realmName2, username2, password2));
assertFalse(keycloak.login(clientId2, realmName2, username2, "nope"));
assertDoesNotThrow(() -> keycloak.login(clientId1, realmName1, username1, password1));
assertDoesNotThrow(() -> keycloak.login(clientId1, realmName1, username1, password1));
assertDoesNotThrow(() -> keycloak.login(clientId2, realmName2, username2, password2));
assertThrows(NotAuthorizedException.class, () -> keycloak.login(clientId3, realmName2, "nope", ""));
assertThrows(NotAuthorizedException.class, () -> keycloak.login(clientId4, realmName2, "foo", "bar"));
assertThrows(NotAuthorizedException.class, () -> keycloak.login(clientId2, realmName2, username2, "nope"));
prometheus.scrap();
var loginAfter = prometheus.userEvent(EventType.LOGIN);
@ -64,13 +75,56 @@ public class KeycloakIT {
var loginErrorAfter = prometheus.userEvent(EventType.LOGIN_ERROR);
var loginErrorAfter1 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName1, clientId1);
var loginErrorAfter2 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId2);
var loginErrorAfter3 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId3);
var loginErrorAfter4 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId4);
var loginErrorAfterUNKNOWN = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, "UNKNOWN");
assertAll("prometheus",
() -> assertEquals(loginBefore + 3, loginAfter, "login success total"),
() -> assertEquals(loginBefore1 + 2, loginAfter1, "login success #1"),
() -> assertEquals(loginBefore2 + 1, loginAfter2, "login success #2"),
() -> assertEquals(loginErrorBefore + 1, loginErrorAfter, "login failure total"),
() -> assertEquals(loginErrorBefore + 3, loginErrorAfter, "login failure total"),
() -> assertEquals(loginErrorBefore1 + 0, loginErrorAfter1, "login failure #1"),
() -> assertEquals(loginErrorBefore2 + 1, loginErrorAfter2, "login failure #2"));
() -> assertEquals(loginErrorBefore2 + 1, loginErrorAfter2, "login failure #2"),
() -> assertEquals(0, loginErrorAfter3, "login failure #3"),
() -> assertEquals(0, loginErrorAfter4, "login failure #4"),
() -> assertEquals(loginErrorBeforeUNKNOWN + 2, loginErrorAfterUNKNOWN, "login failure UNKNOWN"));
}
@DisplayName("user count")
@Test
void userCount(KeycloakClient keycloak, Prometheus prometheus) {
var realmName1 = "userCount_1";
var realmName2 = "userCount_2";
var username = UUID.randomUUID().toString();
keycloak.createRealm(realmName1);
keycloak.createRealm(realmName2);
await(() -> prometheus.userCount(realmName1) == 0, prometheus, "realm 1 not found");
await(() -> prometheus.userCount(realmName2) == 0, prometheus, "realm 2 not found");
keycloak.createUser(realmName1, username, UUID.randomUUID().toString());
keycloak.createUser(realmName1, UUID.randomUUID().toString(), UUID.randomUUID().toString());
keycloak.createUser(realmName1, UUID.randomUUID().toString(), UUID.randomUUID().toString());
keycloak.createUser(realmName2, UUID.randomUUID().toString(), UUID.randomUUID().toString());
await(() -> prometheus.userCount(realmName1) == 3, prometheus, "realm 1 shoud have 3 users");
await(() -> prometheus.userCount(realmName2) == 1, prometheus, "realm 2 shoud have 1 users");
keycloak.deleteUser(realmName1, username);
await(() -> prometheus.userCount(realmName1) == 2, prometheus, "realm 1 shoud have 2 users after deletion");
await(() -> prometheus.userCount(realmName2) == 1, prometheus, "realm 2 shoud have 1 users");
}
void await(Supplier<Boolean> check, Prometheus prometheus, String message) {
var end = Instant.now().plusSeconds(10);
while (Instant.now().isBefore(end) && !check.get()) {
assertDoesNotThrow(() -> Thread.sleep(1000));
prometheus.scrap();
}
assertTrue(check.get(), message);
}
}

View file

@ -1,46 +1,35 @@
package io.kokuwa.keycloak.metrics;
package io.kokuwa.keycloak.metrics.event;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.util.Map;
import java.util.TreeMap;
import java.util.UUID;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.keycloak.events.Event;
import org.keycloak.events.EventType;
import org.keycloak.events.admin.AdminEvent;
import org.keycloak.events.admin.OperationType;
import org.keycloak.events.admin.ResourceType;
import org.keycloak.models.ClientModel;
import org.keycloak.models.KeycloakContext;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;
import org.keycloak.models.RealmProvider;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import io.kokuwa.keycloak.metrics.junit.AbstractMockitoTest;
import io.micrometer.core.instrument.Metrics;
/**
* Test for {@link MicrometerEventListener} with Mockito.
* Test for {@link MetricsEventListener} with Mockito.
*
* @author Stephan Schnabel
*/
@ExtendWith(MockitoExtension.class)
public class MicrometerEventListenerTest {
@DisplayName("events: listener")
public class MetricsEventListenerTest extends AbstractMockitoTest {
@Mock
KeycloakSession session;
@ -49,20 +38,9 @@ public class MicrometerEventListenerTest {
@Mock
RealmProvider realmProvider;
@Mock
ClientModel clientModel;
@Mock
KeycloakContext context;
@Mock
MeterRegistry registry;
@Mock
Counter counter;
@Captor
ArgumentCaptor<String> metricCaptor;
@Captor
ArgumentCaptor<String[]> tagsCaptor;
@BeforeEach
void setup() {
when(registry.counter(metricCaptor.capture(), tagsCaptor.capture())).thenReturn(counter);
}
@DisplayName("onEvent(true)")
@Nested
@ -79,8 +57,10 @@ public class MicrometerEventListenerTest {
when(session.getContext()).thenReturn(context);
when(context.getRealm()).thenReturn(realmModel);
when(context.getClient()).thenReturn(clientModel);
when(realmModel.getId()).thenReturn(realmId);
when(realmModel.getName()).thenReturn(realmName);
when(clientModel.getClientId()).thenReturn(clientId);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmName, clientId, type.toString(), "");
@ -98,8 +78,10 @@ public class MicrometerEventListenerTest {
when(session.getContext()).thenReturn(context);
when(context.getRealm()).thenReturn(realmModel);
when(context.getClient()).thenReturn(clientModel);
when(realmModel.getId()).thenReturn(realmId);
when(realmModel.getName()).thenReturn(realmName);
when(clientModel.getClientId()).thenReturn(clientId);
listener(true).onEvent(toEvent(realmId, clientId, type, error));
assertEvent(realmName, clientId, type.toString(), error);
@ -116,7 +98,7 @@ public class MicrometerEventListenerTest {
when(realmModel.getName()).thenReturn(realmName);
listener(true).onEvent(toEvent(null, null, null, null));
assertEvent(realmName, "", "", "");
assertEvent(realmName, "UNKNOWN", "", "");
}
@DisplayName("replace(true) - context is null")
@ -133,7 +115,7 @@ public class MicrometerEventListenerTest {
when(realmModel.getName()).thenReturn(realmName);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmName, clientId, type.toString(), "");
assertEvent(realmName, "UNKNOWN", type.toString(), "");
}
@DisplayName("replace(true) - context is empty")
@ -151,7 +133,7 @@ public class MicrometerEventListenerTest {
when(realmModel.getName()).thenReturn(realmName);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmName, clientId, type.toString(), "");
assertEvent(realmName, "UNKNOWN", type.toString(), "");
}
@DisplayName("replace(true) - realmId is unknown")
@ -165,7 +147,9 @@ public class MicrometerEventListenerTest {
when(session.getContext()).thenReturn(context);
when(session.realms()).thenReturn(realmProvider);
when(context.getRealm()).thenReturn(realmModel);
when(context.getClient()).thenReturn(clientModel);
when(realmModel.getId()).thenReturn(UUID.randomUUID().toString());
when(clientModel.getClientId()).thenReturn(clientId);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmId, clientId, type.toString(), "");
@ -180,7 +164,7 @@ public class MicrometerEventListenerTest {
var type = EventType.LOGIN;
listener(false).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmId, clientId, type.toString(), "");
assertEvent(realmId, "UNKNOWN", type.toString(), "");
}
@DisplayName("replace(false) - with error")
@ -193,14 +177,14 @@ public class MicrometerEventListenerTest {
var error = UUID.randomUUID().toString();
listener(false).onEvent(toEvent(realmId, clientId, type, error));
assertEvent(realmId, clientId, type.toString(), error);
assertEvent(realmId, "UNKNOWN", type.toString(), error);
}
@DisplayName("replace(false) - all fields empty")
@Test
void notReplaceFieldsEmpty() {
listener(false).onEvent(toEvent(null, null, null, null));
assertEvent("", "", "", "");
assertEvent("", "UNKNOWN", "", "");
}
private Event toEvent(String realmId, String clientId, EventType type, String error) {
@ -213,11 +197,11 @@ public class MicrometerEventListenerTest {
}
private void assertEvent(String realm, String client, String type, String error) {
assertCounter("keycloak_event_user", Map.of(
assertCounter("keycloak_event_user",
"realm", realm,
"client", client,
"type", type,
"error", error));
"error", error);
}
}
@ -370,29 +354,25 @@ public class MicrometerEventListenerTest {
}
private void assertAdminEvent(String realm, String resource, String operation, String error) {
assertCounter("keycloak_event_admin", Map.of(
assertCounter("keycloak_event_admin",
"realm", realm,
"resource", resource,
"operation", operation,
"error", error));
"error", error);
}
}
private MicrometerEventListener listener(boolean replace) {
return new MicrometerEventListener(registry, session, replace);
private MetricsEventListener listener(boolean replace) {
return new MetricsEventListener(replace, session);
}
private void assertCounter(String metric, Map<String, String> tags) {
verify(registry).counter(anyString(), any(String[].class));
verify(counter).increment();
assertEquals(metric, metricCaptor.getValue(), "metric");
var expectedTags = new TreeMap<>(tags);
var actualTags = IntStream
.range(0, tagsCaptor.getValue().length / 2).mapToObj(i -> i * 2)
.collect(Collectors.toMap(
i -> tagsCaptor.getValue()[i],
i -> tagsCaptor.getValue()[i + 1],
(i, j) -> i, TreeMap::new));
assertEquals(expectedTags, actualTags, "tags");
private static void assertCounter(String metric, String... tags) {
var counter = Metrics.globalRegistry.counter(metric, tags);
assertEquals(1D, counter.count(), "micrometer.counter.count");
assertEquals(0, Metrics.globalRegistry
.getMeters().stream()
.filter(meter -> meter != counter)
.count(),
"other meter found");
}
}

View file

@ -0,0 +1,71 @@
package io.kokuwa.keycloak.metrics.junit;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.ClassOrderer;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.TestClassOrder;
import org.junit.jupiter.api.TestMethodOrder;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.junit.jupiter.MockitoExtension;
import io.micrometer.core.instrument.Metrics;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
/**
* Mockito base class with configured logging.
*
* @author Stephan Schnabel
*/
@ExtendWith(MockitoExtension.class)
@TestClassOrder(ClassOrderer.DisplayName.class)
@TestMethodOrder(MethodOrderer.DisplayName.class)
public abstract class AbstractMockitoTest {
private static final List<LogRecord> LOGS = new ArrayList<>();
static {
System.setProperty("org.jboss.logging.provider", "jdk");
System.setProperty("java.util.logging.SimpleFormatter.format", "%1$tT %4$-5s %2$s %5$s%6$s%n");
Logger.getLogger("org.junit").setLevel(Level.INFO);
Logger.getLogger("").setLevel(Level.ALL);
Logger.getLogger("").addHandler(new Handler() {
@Override
public void publish(LogRecord log) {
LOGS.add(log);
}
@Override
public void flush() {}
@Override
public void close() {}
});
}
@BeforeEach
void reset() {
Metrics.globalRegistry.clear();
Metrics.addRegistry(new SimpleMeterRegistry());
LOGS.clear();
}
public static void assertLog(Level level, String message) {
assertTrue(LOGS.stream()
.filter(l -> l.getLevel().equals(level))
.filter(l -> l.getMessage().equals(message))
.findAny().isPresent(),
"log with level " + level + " and message " + message + " not found");
}
}

View file

@ -1,20 +1,33 @@
package io.kokuwa.keycloak.metrics.junit;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.fail;
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpRequest.BodyPublishers;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import javax.ws.rs.NotAuthorizedException;
import javax.ws.rs.core.MultivaluedHashMap;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedHashMap;
import org.keycloak.OAuth2Constants;
import org.keycloak.admin.client.Keycloak;
import org.keycloak.admin.client.token.TokenService;
import org.keycloak.representations.AccessTokenResponse;
import org.keycloak.representations.idm.ClientRepresentation;
import org.keycloak.representations.idm.CredentialRepresentation;
import org.keycloak.representations.idm.RealmRepresentation;
import org.keycloak.representations.idm.UserRepresentation;
import com.fasterxml.jackson.databind.ObjectMapper;
/**
* Client for keycloak.
*
@ -23,11 +36,18 @@ import org.keycloak.representations.idm.UserRepresentation;
public class KeycloakClient {
private final Keycloak keycloak;
private final TokenService token;
private final TokenService tokenService;
KeycloakClient(Keycloak keycloak, TokenService token) {
private final ObjectMapper mapper = new ObjectMapper();
private final HttpClient client = HttpClient.newHttpClient();
private final String url;
private final String adminToken;
KeycloakClient(String url, Keycloak keycloak, TokenService tokenService) {
this.keycloak = keycloak;
this.token = token;
this.tokenService = tokenService;
this.url = url;
this.adminToken = login("admin-cli", "master", "admin", "password").getToken();
}
public void createRealm(String realmName) {
@ -45,33 +65,46 @@ public class KeycloakClient {
client.setClientId(clientId);
client.setPublicClient(true);
client.setDirectAccessGrantsEnabled(true);
keycloak.realms().realm(realmName).clients().create(client);
var response = keycloak.realms().realm(realmName).clients().create(client);
assertEquals(201, response.getStatus());
}
public void createUser(String realmName, String username, String password) {
var credential = new CredentialRepresentation();
credential.setType(CredentialRepresentation.PASSWORD);
credential.setValue(password);
credential.setTemporary(false);
var user = new UserRepresentation();
user.setEnabled(true);
user.setEmail(username + "@example.org");
user.setEmailVerified(true);
user.setUsername(username);
user.setCredentials(List.of(credential));
keycloak.realms().realm(realmName).users().create(user);
}
public boolean login(String clientId, String realmName, String username, String password) {
try {
token.grantToken(realmName, new MultivaluedHashMap<>(Map.of(
OAuth2Constants.CLIENT_ID, clientId,
OAuth2Constants.GRANT_TYPE, OAuth2Constants.PASSWORD,
OAuth2Constants.USERNAME, username,
OAuth2Constants.PASSWORD, password)));
return true;
} catch (NotAuthorizedException e) {
return false;
var response = client.send(HttpRequest.newBuilder()
.uri(URI.create(url + "/admin/realms/" + realmName + "/users"))
.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON)
.header(HttpHeaders.AUTHORIZATION, "Bearer " + adminToken)
.POST(BodyPublishers.ofString(mapper.writeValueAsString(Map.of(
"enabled", true,
"emailVerified", true,
"email", username + "@example.org",
"username", username,
"firstName", username,
"lastName", username,
"credentials", List.of(Map.of(
"type", CredentialRepresentation.PASSWORD,
"value", password,
"temporary", false))))))
.build(), BodyHandlers.ofString());
assertEquals(201, response.statusCode(), "Body: " + response.body());
} catch (IOException | InterruptedException e) {
fail("Failed to create user", e);
}
}
public void deleteUser(String realmName, String username) {
keycloak.realms().realm(realmName).users()
.searchByUsername(username, true).stream()
.map(UserRepresentation::getId)
.forEach(keycloak.realms().realm(realmName).users()::delete);
}
public AccessTokenResponse login(String clientId, String realmName, String username, String password) {
return tokenService.grantToken(realmName, new MultivaluedHashMap<>(Map.of(
OAuth2Constants.CLIENT_ID, clientId,
OAuth2Constants.GRANT_TYPE, OAuth2Constants.PASSWORD,
OAuth2Constants.USERNAME, username,
OAuth2Constants.PASSWORD, password)));
}
}

View file

@ -7,7 +7,7 @@ import java.time.Duration;
import java.util.Properties;
import java.util.Set;
import javax.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.ClientBuilder;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
@ -15,13 +15,11 @@ import org.junit.jupiter.api.extension.ParameterContext;
import org.junit.jupiter.api.extension.ParameterResolver;
import org.keycloak.admin.client.Keycloak;
import org.keycloak.admin.client.token.TokenService;
import org.testcontainers.containers.FixedHostPortGenericContainer;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.MountableFile;
import io.kokuwa.keycloak.metrics.prometheus.Prometheus;
import io.kokuwa.keycloak.metrics.prometheus.PrometheusClient;
/**
* JUnit extension to start keycloak.
*
@ -48,27 +46,33 @@ public class KeycloakExtension implements BeforeAllCallback, ParameterResolver {
throw new Exception("Failed to read properties", e);
}
var version = properties.getProperty("version");
var image = "quay.io/keycloak/keycloak:" + version;
var jar = properties.getProperty("jar");
var timeout = properties.getProperty("timeout");
// create and start container
// create and start container - use fixed port in ci
@SuppressWarnings("resource")
var container = new GenericContainer<>("quay.io/keycloak/keycloak:" + version)
.withEnv("KEYCLOAK_ADMIN", "admin")
.withEnv("KEYCLOAK_ADMIN_PASSWORD", "password")
.withEnv("KC_LOG_CONSOLE_COLOR", "true")
.withEnv("KC_HEALTH_ENABLED", "true")
.withEnv("KC_METRICS_ENABLED", "true")
.withEnv("KC_METRICS_EVENT_REPLACE_IDS", "true")
.withCopyFileToContainer(MountableFile.forHostPath(jar), "/opt/keycloak/providers/metrics.jar")
.withLogConsumer(out -> System.out.print(out.getUtf8String()))
.withExposedPorts(8080)
.withStartupTimeout(Duration.parse(timeout))
.waitingFor(Wait.forHttp("/health").forPort(8080))
.withCommand("start-dev");
@SuppressWarnings({ "resource", "deprecation" })
var container = (System.getenv("CI") == null
? new GenericContainer<>(image).withExposedPorts(8080)
: new FixedHostPortGenericContainer<>(image).withFixedExposedPort(8080, 8080));
try {
container.start();
container
.withEnv("KEYCLOAK_ADMIN", "admin")
.withEnv("KEYCLOAK_ADMIN_PASSWORD", "password")
.withEnv("KC_LOG_LEVEL", "io.kokuwa:trace")
// otherwise port 9000 will be used, with this config we can test different keycloak versions
.withEnv("KC_LEGACY_OBSERVABILITY_INTERFACE", "true")
.withEnv("KC_HEALTH_ENABLED", "true")
.withEnv("KC_METRICS_ENABLED", "true")
.withEnv("KC_METRICS_STATS_ENABLED", "true")
.withEnv("KC_METRICS_STATS_INTERVAL", "PT1s")
.withCopyFileToContainer(MountableFile.forHostPath(jar), "/opt/keycloak/providers/metrics.jar")
.withLogConsumer(out -> System.out.print(out.getUtf8String()))
.withStartupTimeout(Duration.parse(timeout))
.waitingFor(Wait.forHttp("/health").forPort(8080).withStartupTimeout(Duration.ofMinutes(10)))
.withCommand("start-dev")
.start();
} catch (RuntimeException e) {
throw new Exception("Failed to start keycloak", e);
}
@ -81,7 +85,7 @@ public class KeycloakExtension implements BeforeAllCallback, ParameterResolver {
var target = ClientBuilder.newClient().target(url);
var token = Keycloak.getClientProvider().targetProxy(target, TokenService.class);
prometheus = new Prometheus(Keycloak.getClientProvider().targetProxy(target, PrometheusClient.class));
client = new KeycloakClient(keycloak, token);
client = new KeycloakClient(url, keycloak, token);
}
@Override

View file

@ -1,4 +1,4 @@
package io.kokuwa.keycloak.metrics.prometheus;
package io.kokuwa.keycloak.metrics.junit;
import java.util.HashSet;
import java.util.Map;
@ -41,6 +41,14 @@ public class Prometheus {
.sum();
}
public int userCount(String realm) {
return state.stream()
.filter(metric -> Objects.equals(metric.name(), "keycloak_users"))
.filter(metric -> Objects.equals(metric.tags().get("realm"), realm))
.mapToInt(metric -> metric.value().intValue())
.sum();
}
public void scrap() {
state.clear();
Stream.of(client.scrap().split("[\\r\\n]+"))

View file

@ -1,9 +1,9 @@
package io.kokuwa.keycloak.metrics.prometheus;
package io.kokuwa.keycloak.metrics.junit;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.core.MediaType;
/**
* JAX-RS client for prometheus endpoint.

View file

@ -1,4 +1,4 @@
package io.kokuwa.keycloak.metrics.prometheus;
package io.kokuwa.keycloak.metrics.junit;
import java.util.Map;

View file

@ -0,0 +1,107 @@
package io.kokuwa.keycloak.metrics.stats;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.time.Duration;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.platform.commons.util.ReflectionUtils;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
import org.keycloak.models.KeycloakTransactionManager;
import org.keycloak.timer.TimerProvider;
import org.mockito.ArgumentCaptor;
import org.mockito.ArgumentMatchers;
import org.mockito.Mock;
import org.mockito.Spy;
import io.kokuwa.keycloak.metrics.junit.AbstractMockitoTest;
/**
* Test for {@link MetricsStatsFactory} with Mockito.
*
* @author Stephan Schnabel
*/
@DisplayName("metrics: factory")
public class MetricsStatsFactoryTest extends AbstractMockitoTest {
@Spy
MetricsStatsFactoryImpl factory;
@Mock
KeycloakSessionFactory sessionFactory;
@Mock
KeycloakSession session;
@DisplayName("disabled")
@Test
void disabled() {
factory.init(null);
factory.postInit(sessionFactory);
assertNull(factory.create(session));
factory.close();
}
@DisplayName("enabled - with default values")
@Test
void enabledDefault() {
when(factory.getenv("KC_METRICS_STATS_ENABLED")).thenReturn("true");
when(factory.getenv("KC_METRICS_STATS_INTERVAL")).thenReturn(null);
when(factory.getenv("KC_METRICS_STATS_INFO_THRESHOLD")).thenReturn(null);
when(factory.getenv("KC_METRICS_STATS_WARN_THRESHOLD")).thenReturn(null);
assertTask(Duration.ofSeconds(60), Duration.ofSeconds(30), Duration.ofSeconds(45));
}
@DisplayName("enabled - with custom interval")
@Test
void enabledCustomInterval() {
when(factory.getenv("KC_METRICS_STATS_ENABLED")).thenReturn("true");
when(factory.getenv("KC_METRICS_STATS_INTERVAL")).thenReturn("PT300s");
when(factory.getenv("KC_METRICS_STATS_INFO_THRESHOLD")).thenReturn(null);
when(factory.getenv("KC_METRICS_STATS_WARN_THRESHOLD")).thenReturn(null);
assertTask(Duration.ofSeconds(300), Duration.ofSeconds(150), Duration.ofSeconds(225));
}
@DisplayName("enabled - with custom thresholds")
@Test
void enabledCustomThresholds() {
when(factory.getenv("KC_METRICS_STATS_ENABLED")).thenReturn("true");
when(factory.getenv("KC_METRICS_STATS_INTERVAL")).thenReturn(null);
when(factory.getenv("KC_METRICS_STATS_INFO_THRESHOLD")).thenReturn("PT40s");
when(factory.getenv("KC_METRICS_STATS_WARN_THRESHOLD")).thenReturn("PT50s");
assertTask(Duration.ofSeconds(60), Duration.ofSeconds(40), Duration.ofSeconds(50));
}
private void assertTask(Duration interval, Duration infoThreshold, Duration warnThreshold) {
var timerProvider = mock(TimerProvider.class);
when(sessionFactory.create()).thenReturn(session);
when(session.getProvider(TimerProvider.class)).thenReturn(timerProvider);
when(session.getTransactionManager()).thenReturn(mock(KeycloakTransactionManager.class));
factory.postInit(sessionFactory);
var taskCaptor = ArgumentCaptor.forClass(MetricsStatsTask.class);
verify(timerProvider).scheduleTask(
taskCaptor.capture(),
ArgumentMatchers.eq(interval.toMillis()),
ArgumentMatchers.eq("metrics"));
assertNotNull(taskCaptor.getValue(), "task");
assertField(interval, taskCaptor.getValue(), "interval");
assertField(infoThreshold, taskCaptor.getValue(), "infoThreshold");
assertField(warnThreshold, taskCaptor.getValue(), "warnThreshold");
}
private void assertField(Duration expected, MetricsStatsTask task, String name) {
assertEquals(
expected,
assertDoesNotThrow(() -> ReflectionUtils.tryToReadFieldValue(MetricsStatsTask.class, name, task).get()),
"field " + name + " invalid");
}
}

View file

@ -0,0 +1,37 @@
package io.kokuwa.keycloak.metrics.stats;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.util.ServiceLoader;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import io.kokuwa.keycloak.metrics.junit.AbstractMockitoTest;
/**
* Test for {@link MetricsStatsSpi} with Mockito.
*
* @author Stephan Schnabel
*/
@DisplayName("metrics: spi")
public class MetricsStatsSpiTest extends AbstractMockitoTest {
@Test
void test() {
var spi = new MetricsStatsSpi();
assertEquals("metrics", spi.getName(), "getName()");
assertFalse(spi.isInternal(), "isInternal()");
assertNotNull(spi.getProviderClass(), "getProviderClass()");
assertTrue(spi.getProviderFactoryClass().isInterface(), "getProviderFactoryClass() - should be an interface");
var factory = ServiceLoader.load(spi.getProviderFactoryClass()).findFirst().orElse(null);
assertNotNull(factory, "failed to read factory with service loader");
assertEquals(MetricsStatsFactoryImpl.class, factory.getClass(), "factory.class");
assertEquals("default", factory.getId(), "factory.id");
}
}

View file

@ -0,0 +1,231 @@
package io.kokuwa.keycloak.metrics.stats;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.time.Duration;
import java.util.Map;
import java.util.UUID;
import java.util.logging.Level;
import java.util.stream.Stream;
import org.hibernate.exception.SQLGrammarException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.keycloak.models.ClientModel;
import org.keycloak.models.ClientProvider;
import org.keycloak.models.KeycloakContext;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;
import org.keycloak.models.RealmProvider;
import org.keycloak.models.UserProvider;
import org.keycloak.models.UserSessionProvider;
import org.mockito.Mock;
import io.kokuwa.keycloak.metrics.junit.AbstractMockitoTest;
import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.Metrics;
/**
* Test for {@link MetricsStatsTask} with Mockito.
*
* @author Stephan Schnabel
*/
@DisplayName("metrics: task")
public class MetricsStatsTaskTest extends AbstractMockitoTest {
@Mock
KeycloakSession session;
@Mock
RealmProvider realmProvider;
@Mock
UserProvider userProvider;
@Mock
UserSessionProvider sessionProvider;
@Mock
ClientProvider clientProvider;
@BeforeEach
void setup() {
when(session.realms()).thenReturn(realmProvider);
}
@DisplayName("catch - nullpointer")
@Test
void catchNPE() {
when(session.realms()).thenThrow(NullPointerException.class);
task().run(session);
assertLog(Level.SEVERE, "Failed to scrape stats.");
}
@DisplayName("catch - database")
@Test
void catchDatabase() {
when(session.realms()).thenThrow(SQLGrammarException.class);
task().run(session);
assertLog(Level.INFO, "Metrics status task skipped, database not ready.");
}
@DisplayName("log - debug")
@Test
void logDebug() {
when(realmProvider.getRealmsStream()).thenReturn(Stream.of());
task(Duration.ofMillis(300), Duration.ofMillis(100), Duration.ofMillis(200)).run(session);
assertLog(Level.FINE, "Finished scrapping keycloak stats in {0}.");
}
@DisplayName("log - info")
@Test
void logInfo() {
when(realmProvider.getRealmsStream()).thenReturn(Stream.of());
task(Duration.ofMillis(300), Duration.ZERO, Duration.ofMillis(200)).run(session);
assertLog(Level.INFO, "Finished scrapping keycloak stats in {0}.");
}
@DisplayName("log - warn")
@Test
void logWarn() {
when(realmProvider.getRealmsStream()).thenReturn(Stream.of());
task(Duration.ofMillis(300), Duration.ofMillis(100), Duration.ZERO).run(session);
assertLog(Level.WARNING, "Finished scrapping keycloak stats in {0}, consider to increase interval.");
}
@DisplayName("log - error")
@Test
void logError() {
when(realmProvider.getRealmsStream()).thenReturn(Stream.of());
task(Duration.ZERO, Duration.ofMillis(100), Duration.ofMillis(200)).run(session);
assertLog(Level.SEVERE, "Finished scrapping keycloak stats in {0}, consider to increase interval.");
}
@DisplayName("scrape")
@Test
void scrape() {
var realm = UUID.randomUUID().toString();
var realmModel = mock(RealmModel.class);
var client1 = UUID.randomUUID().toString();
var client1Id = UUID.randomUUID().toString();
var client1Model = mock(ClientModel.class);
var client2 = UUID.randomUUID().toString();
var client2Id = UUID.randomUUID().toString();
var client2Model = mock(ClientModel.class);
when(realmModel.getName()).thenReturn(realm);
when(realmModel.getClientsStream()).then(i -> Stream.of(client1Model, client2Model));
when(client1Model.getId()).thenReturn(client1Id);
when(client1Model.getClientId()).thenReturn(client1);
when(client2Model.getId()).thenReturn(client2Id);
when(client2Model.getClientId()).thenReturn(client2);
when(session.clients()).thenReturn(clientProvider);
when(session.users()).thenReturn(userProvider);
when(session.sessions()).thenReturn(sessionProvider);
when(session.getContext()).thenReturn(mock(KeycloakContext.class));
when(realmProvider.getRealmsStream()).then(i -> Stream.of(realmModel));
// empty realm
when(userProvider.getUsersCount(realmModel)).thenReturn(0);
when(clientProvider.getClientsCount(realmModel)).thenReturn(0L);
when(sessionProvider.getOfflineSessionsCount(realmModel, client1Model)).thenReturn(0L);
when(sessionProvider.getOfflineSessionsCount(realmModel, client2Model)).thenReturn(0L);
when(sessionProvider.getActiveUserSessions(realmModel, client1Model)).thenReturn(0L);
when(sessionProvider.getActiveUserSessions(realmModel, client2Model)).thenReturn(0L);
when(sessionProvider.getActiveClientSessionStats(realmModel, false)).thenReturn(Map.of());
task().run(session);
assertUsersCount(realmModel, 0);
assertClientsCount(realmModel, 0);
assertOfflineSessions(realmModel, client1Model, null);
assertOfflineSessions(realmModel, client2Model, null);
assertActiveUserSessions(realmModel, client1Model, null);
assertActiveUserSessions(realmModel, client2Model, null);
assertActiveClientSessions(realmModel, client1Model, null);
assertActiveClientSessions(realmModel, client2Model, null);
// initial values
when(userProvider.getUsersCount(realmModel)).thenReturn(10);
when(clientProvider.getClientsCount(realmModel)).thenReturn(20L);
when(sessionProvider.getOfflineSessionsCount(realmModel, client1Model)).thenReturn(0L);
when(sessionProvider.getOfflineSessionsCount(realmModel, client2Model)).thenReturn(1L);
when(sessionProvider.getActiveUserSessions(realmModel, client1Model)).thenReturn(2L);
when(sessionProvider.getActiveUserSessions(realmModel, client2Model)).thenReturn(3L);
when(sessionProvider.getActiveClientSessionStats(realmModel, false))
.thenReturn(Map.of(client1Id, 5L, client2Id, 0L));
task().run(session);
assertUsersCount(realmModel, 10);
assertClientsCount(realmModel, 20);
assertOfflineSessions(realmModel, client1Model, null);
assertOfflineSessions(realmModel, client2Model, 1);
assertActiveUserSessions(realmModel, client1Model, 2);
assertActiveUserSessions(realmModel, client2Model, 3);
assertActiveClientSessions(realmModel, client1Model, 5);
assertActiveClientSessions(realmModel, client2Model, null);
// updated values
when(userProvider.getUsersCount(realmModel)).thenReturn(11);
when(clientProvider.getClientsCount(realmModel)).thenReturn(19L);
when(sessionProvider.getOfflineSessionsCount(realmModel, client1Model)).thenReturn(3L);
when(sessionProvider.getOfflineSessionsCount(realmModel, client2Model)).thenReturn(2L);
when(sessionProvider.getActiveUserSessions(realmModel, client1Model)).thenReturn(1L);
when(sessionProvider.getActiveUserSessions(realmModel, client2Model)).thenReturn(0L);
when(sessionProvider.getActiveClientSessionStats(realmModel, false))
.thenReturn(Map.of(client1Id, 4L, client2Id, 3L));
task().run(session);
assertUsersCount(realmModel, 11);
assertClientsCount(realmModel, 19);
assertOfflineSessions(realmModel, client1Model, 3);
assertOfflineSessions(realmModel, client2Model, 2);
assertActiveUserSessions(realmModel, client1Model, 1);
assertActiveUserSessions(realmModel, client2Model, 0);
assertActiveClientSessions(realmModel, client1Model, 4);
assertActiveClientSessions(realmModel, client2Model, 3);
}
private MetricsStatsTask task() {
return task(Duration.ofMillis(300), Duration.ofMillis(100), Duration.ofMillis(200));
}
private MetricsStatsTask task(Duration interval, Duration infoThreshold, Duration warnThreshold) {
return new MetricsStatsTask(interval, infoThreshold, warnThreshold);
}
private static void assertUsersCount(RealmModel realm, int count) {
assertGauge("keycloak_users", realm, null, count);
}
private static void assertClientsCount(RealmModel realm, int count) {
assertGauge("keycloak_clients", realm, null, count);
}
private static void assertActiveClientSessions(RealmModel realm, ClientModel client, Integer count) {
assertGauge("keycloak_active_client_sessions", realm, client, count);
}
private static void assertActiveUserSessions(RealmModel realm, ClientModel client, Integer count) {
assertGauge("keycloak_active_user_sessions", realm, client, count);
}
private static void assertOfflineSessions(RealmModel realm, ClientModel client, Integer count) {
assertGauge("keycloak_offline_sessions", realm, client, count);
}
private static void assertGauge(String name, RealmModel realm, ClientModel client, Integer count) {
var gauges = Metrics.globalRegistry.getMeters().stream()
.filter(Gauge.class::isInstance)
.filter(gauge -> gauge.getId().getName().equals(name))
.filter(gauge -> gauge.getId().getTag("realm").equals(realm.getName()))
.filter(gauge -> client == null || gauge.getId().getTag("client").equals(client.getClientId()))
.map(Gauge.class::cast)
.toList();
if (count == null) {
assertEquals(0, gauges.size());
} else {
assertEquals(1, gauges.size());
assertEquals(count.doubleValue(), gauges.get(0).value());
}
}
}

View file

@ -1,3 +1,3 @@
version=${version.org.keycloak}
version=${version.org.keycloak.test}
timeout=PT5m
jar=${project.build.directory}/${project.build.finalName}.jar