From bb996faa6f472977347f6746093a191e5e4b7d48 Mon Sep 17 00:00:00 2001 From: "kokuwa.io Bot" Date: Tue, 3 Dec 2024 13:05:32 +0000 Subject: [PATCH 01/27] [maven-release-plugin] prepare for next development iteration --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index 007c4e9..9f03bc3 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ io.kokuwa.keycloak keycloak-event-metrics - 1.1.0 + 1.1.1-SNAPSHOT Keycloak Metrics Provides metrics for Keycloak user/admin events @@ -45,7 +45,7 @@ https://github.com/kokuwaio/keycloak-event-metrics scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git - 1.1.0 + HEAD github From c735477d6f20243b1fbcd274862026dbe6fe11e3 Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Thu, 19 Dec 2024 09:39:21 +0100 Subject: [PATCH 02/27] Fix build, align keycloak dependencies to avoid mockito classpath issues (#108) --- .github/workflows/dependabot-auto-merge.yaml | 13 ------------- .github/workflows/pr.yaml | 4 +--- README.md | 2 +- pom.xml | 2 ++ 4 files changed, 4 insertions(+), 17 deletions(-) delete mode 100644 .github/workflows/dependabot-auto-merge.yaml diff --git a/.github/workflows/dependabot-auto-merge.yaml b/.github/workflows/dependabot-auto-merge.yaml deleted file mode 100644 index 1509e34..0000000 --- a/.github/workflows/dependabot-auto-merge.yaml +++ /dev/null @@ -1,13 +0,0 @@ -name: dependabot-auto-merge - -on: pull_request - -jobs: - auto-merge: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: ahmadnassri/action-dependabot-auto-merge@v2 - with: - github-token: ${{ secrets.GIT_ACTION_TOKEN }} - target: minor diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml index 3ef129f..dd84d43 100644 --- a/.github/workflows/pr.yaml +++ b/.github/workflows/pr.yaml @@ -46,13 +46,11 @@ jobs: fail-fast: false matrix: version: - - 21.0.2 - - 21.1.2 - 22.0.5 - 23.0.7 - 24.0.5 - 25.0.6 - - 26.0.2 + - 26.0.7 steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v4 diff --git a/README.md b/README.md index 2eb12ed..d57d9b6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Keycloak Metrics -Provides metrics for Keycloak user/admin events and user/client/session count. Tested on Keycloak [21-25](.github/workflows/pr.yaml#L50-L55). +Provides metrics for Keycloak user/admin events and user/client/session count. Tested on Keycloak [22-26](.github/workflows/pr.yaml#L48-L53). [![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) diff --git a/pom.xml b/pom.xml index 9f03bc3..2bef6be 100644 --- a/pom.xml +++ b/pom.xml @@ -100,11 +100,13 @@ org.keycloak keycloak-server-spi + ${version.org.keycloak.test} provided org.keycloak keycloak-server-spi-private + ${version.org.keycloak.test} provided From c190433f33e5aa5a177859c18f1f24d1b5f01ac5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 19 Dec 2024 08:53:46 +0000 Subject: [PATCH 03/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 2bef6be..68f644e 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ io.kokuwa.maven maven-parent - 0.6.17 + 0.6.18 From eb1dc0ce349f2485966b06a4e128f48f6a259bd9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 14 Jan 2025 09:18:22 +0100 Subject: [PATCH 04/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 68f644e..81ecd02 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.0.7 + 26.0.8 ${version.org.keycloak} 1.18.3 From 90f00379ea48bdfc5960c397346ad323cf6ae962 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 15 Jan 2025 15:32:52 +0100 Subject: [PATCH 05/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 81ecd02..cbd2e82 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.0.8 + 26.1.0 ${version.org.keycloak} 1.18.3 From ba55b8fc8e1a003aa43855f644f1d40459ca5a15 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 7 Feb 2025 08:03:08 +0100 Subject: [PATCH 06/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index cbd2e82..04dccf1 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.1.0 + 26.1.1 ${version.org.keycloak} 1.18.3 From fbf1da4b8246e10d5b32c353aea81eed18532934 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 11 Feb 2025 15:44:44 +0100 Subject: [PATCH 07/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 04dccf1..86a63e1 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.1.1 + 26.1.2 ${version.org.keycloak} 1.18.3 From 1a028e766ca814ccc6468965b0bda2a1ae17a1a7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:40:18 +0100 Subject: [PATCH 08/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 86a63e1..0115bd3 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.1.2 + 26.1.4 ${version.org.keycloak} 1.18.3 From 47c78e5b87f214896c30e273f28a9a70a4e74524 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 7 Apr 2025 13:11:43 +0200 Subject: [PATCH 09/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/release.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index a203b52..e3240ed 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -9,13 +9,13 @@ jobs: MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.github/settings.xml steps: - name: docker/login-action docker.io - uses: docker/login-action@v3.3.0 + uses: docker/login-action@v3.4.0 with: registry: docker.io username: ${{ secrets.DOCKERIO_USERNAME }} password: ${{ secrets.DOCKERIO_TOKEN }} - name: docker/login-action ghcr.io - uses: docker/login-action@v3.3.0 + uses: docker/login-action@v3.4.0 with: registry: ghcr.io username: ${{ github.actor }} From 3362a18708660b7a0836c02925d5e0ba91db3813 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 28 Apr 2025 09:53:27 +0000 Subject: [PATCH 10/27] Bump org.keycloak:keycloak-quarkus-server from 26.1.4 to 26.2.1 (#119) Co-authored-by: Stephan Schnabel --- .github/workflows/pr.yaml | 4 +++- pom.xml | 2 +- .../io/kokuwa/keycloak/metrics/stats/MetricsStatsTask.java | 1 + .../kokuwa/keycloak/metrics/stats/MetricsStatsTaskTest.java | 2 ++ 4 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml index dd84d43..86a8eb1 100644 --- a/.github/workflows/pr.yaml +++ b/.github/workflows/pr.yaml @@ -50,7 +50,9 @@ jobs: - 23.0.7 - 24.0.5 - 25.0.6 - - 26.0.7 + - 26.0.8 + - 26.1.5 + - 26.2.1 steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v4 diff --git a/pom.xml b/pom.xml index 0115bd3..a5d8e5d 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.1.4 + 26.2.1 ${version.org.keycloak} 1.18.3 diff --git a/src/main/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTask.java b/src/main/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTask.java index db75da8..e16188d 100644 --- a/src/main/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTask.java +++ b/src/main/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTask.java @@ -66,6 +66,7 @@ public class MetricsStatsTask implements Provider, ScheduledTask { 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); diff --git a/src/test/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTaskTest.java b/src/test/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTaskTest.java index 63201ce..9d696e7 100644 --- a/src/test/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTaskTest.java +++ b/src/test/java/io/kokuwa/keycloak/metrics/stats/MetricsStatsTaskTest.java @@ -16,6 +16,7 @@ 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; @@ -121,6 +122,7 @@ public class MetricsStatsTaskTest extends AbstractMockitoTest { 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 From 0e4181e3b18e168d62d2fb2b37b12c3db7a788b1 Mon Sep 17 00:00:00 2001 From: "kokuwa.io Bot" Date: Mon, 28 Apr 2025 12:25:43 +0000 Subject: [PATCH 11/27] [maven-release-plugin] prepare release 1.1.1 [no ci] --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index a5d8e5d..d1f1cb2 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ io.kokuwa.keycloak keycloak-event-metrics - 1.1.1-SNAPSHOT + 1.1.1 Keycloak Metrics Provides metrics for Keycloak user/admin events @@ -45,7 +45,7 @@ https://github.com/kokuwaio/keycloak-event-metrics scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git - HEAD + 1.1.1 github From 48e4939a5dec13012386334d57f15ff29d550d87 Mon Sep 17 00:00:00 2001 From: "kokuwa.io Bot" Date: Mon, 28 Apr 2025 12:25:45 +0000 Subject: [PATCH 12/27] [maven-release-plugin] prepare for next development iteration --- pom.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pom.xml b/pom.xml index d1f1cb2..fea881a 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ io.kokuwa.keycloak keycloak-event-metrics - 1.1.1 + 1.1.2-SNAPSHOT Keycloak Metrics Provides metrics for Keycloak user/admin events @@ -45,7 +45,7 @@ https://github.com/kokuwaio/keycloak-event-metrics scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git - 1.1.1 + HEAD github From 1a1a9d3ae08d0a793ee93346f1f10bdb0ec309f1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 2 May 2025 20:31:32 +0200 Subject: [PATCH 13/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index fea881a..5688557 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.2.1 + 26.2.2 ${version.org.keycloak} 1.18.3 From c9f13d961d2e7ccd090ee91530d3d561cd0e3f49 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 5 May 2025 19:38:06 +0200 Subject: [PATCH 14/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 5688557..712f93a 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.2.2 + 26.2.3 ${version.org.keycloak} 1.18.3 From 75d4e33c2fdd7c90b9112f2f5538d7d593e419ac Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 14 May 2025 06:48:34 +0200 Subject: [PATCH 15/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 712f93a..bc0373e 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.2.3 + 26.2.4 ${version.org.keycloak} 1.18.3 From f421be47afc9ab252b196258533123bd0c0feeaa Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 28 May 2025 19:21:27 +0200 Subject: [PATCH 16/27] 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] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index bc0373e..2f4ae93 100644 --- a/pom.xml +++ b/pom.xml @@ -71,7 +71,7 @@ - 26.2.4 + 26.2.5 ${version.org.keycloak} 1.18.3 From 83db6728277373963c5b557e9dd6ee403e4c962a Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Fri, 30 May 2025 20:36:25 +0200 Subject: [PATCH 17/27] Migrate from parent to local config only --- .github/workflows/build.yaml | 26 +- .github/workflows/pr.yaml | 9 +- pom.xml | 360 +++++++++++++++- src/eclipse/formatter.xml | 404 ++++++++++++++++++ .../kokuwa/keycloak/metrics/KeycloakIT.java | 5 +- .../metrics/junit/KeycloakClient.java | 8 +- .../metrics/junit/KeycloakExtension.java | 4 +- 7 files changed, 777 insertions(+), 39 deletions(-) create mode 100644 src/eclipse/formatter.xml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 5ed003d..4da10a5 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -11,20 +11,40 @@ jobs: env: MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.github/settings.xml steps: + - name: docker/login-action docker.io + uses: docker/login-action@v3.4.0 + with: + registry: docker.io + username: ${{ secrets.DOCKERIO_USERNAME }} + password: ${{ secrets.DOCKERIO_TOKEN }} + - name: docker/login-action ghcr.io + uses: docker/login-action@v3.4.0 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GIT_ACTION_TOKEN }} - run: git config --global user.name "${{ vars.KOKUWA_IO_BOT_NAME }}" - run: git config --global user.email "${{ vars.KOKUWA_IO_BOT_EMAIL }}" - uses: actions/checkout@v4 with: token: ${{ secrets.GIT_ACTION_TOKEN }} + - uses: crazy-max/ghaction-import-gpg@v6 + with: + gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} + passphrase: ${{ secrets.GPG_PASSPHRASE }} + git_user_signingkey: true + git_commit_gpgsign: true - uses: actions/setup-java@v4 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 $MAVEN_ARGS deploy env: SERVER_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }} SERVER_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }} - - run: mvn $MAVEN_ARGS site-deploy - env: - GIT_ACTION_TOKEN: ${{ secrets.GIT_ACTION_TOKEN }} diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml index 86a8eb1..3548e88 100644 --- a/.github/workflows/pr.yaml +++ b/.github/workflows/pr.yaml @@ -3,7 +3,7 @@ name: PullRequest on: pull_request env: - MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress -Dmaven.test.redirectTestOutputToFile=false + MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress jobs: @@ -34,11 +34,6 @@ jobs: java-version: 17 cache: maven - run: mvn $MAVEN_ARGS verify - - run: mvn $MAVEN_ARGS site - - uses: actions/upload-artifact@v4 - if: always() - with: - path: target/site versions: runs-on: ubuntu-latest @@ -52,7 +47,7 @@ jobs: - 25.0.6 - 26.0.8 - 26.1.5 - - 26.2.1 + - 26.2.5 steps: - uses: actions/checkout@v4 - uses: actions/setup-java@v4 diff --git a/pom.xml b/pom.xml index 2f4ae93..3d2ef55 100644 --- a/pom.xml +++ b/pom.xml @@ -2,13 +2,6 @@ 4.0.0 - - io.kokuwa.maven - maven-parent - 0.6.18 - - - io.kokuwa.keycloak keycloak-event-metrics 1.1.2-SNAPSHOT @@ -31,12 +24,10 @@ - sschnabe + stephan.schnabel Stephan Schnabel - https://github.com/sschnabe - stephan@grayc.de - GrayC GmbH - https://grayc.de + https://schnabel.org + stephan@schnabel.org Europe/Berlin @@ -55,6 +46,16 @@ github https://github.com/kokuwaio/keycloak-event-metrics/actions + + + sonatype-nexus + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + sonatype-nexus + https://oss.sonatype.org/content/repositories/snapshots/ + + @@ -62,15 +63,45 @@ - 17 - 17 + 2025-04-28T12:25:49Z + UTF-8 + ISO-8859-1 - deploy,site,ossrh,release + 17 + ${maven.compiler.release} + ${maven.compiler.release} + -Xlint:all + true + true + true + + true + java.,javax.,jakarta.,org. + ${project.basedir}/src/eclipse/formatter.xml - + + 3.4.1 + 3.14.0 + 3.1.4 + 3.2.7 + 3.1.4 + 3.4.2 + 3.11.2 + 3.1.1 + 3.3.1 + 3.21.0 + 3.3.1 + 3.5.3 + 3.5.1 + 1.4.0 + 2.18.0 + 1.7.0 + 2.26.0 + 1.12.0 + 26.2.5 ${version.org.keycloak} 1.18.3 @@ -188,12 +219,136 @@ + ${project.artifactId} ${project.basedir}/src/test/resources true + + + + org.apache.maven.plugins + maven-clean-plugin + ${version.org.apache.maven.plugins.clean} + + + org.apache.maven.plugins + maven-compiler-plugin + ${version.org.apache.maven.plugins.compiler} + + ${maven.compiler.compilerArgument} + + + + org.apache.maven.plugins + maven-deploy-plugin + ${version.org.apache.maven.plugins.deploy} + + + org.apache.maven.plugins + maven-failsafe-plugin + ${version.org.apache.maven.plugins.surefire} + + + org.apache.maven.plugins + maven-gpg-plugin + ${version.org.apache.maven.plugins.gpg} + + + org.apache.maven.plugins + maven-install-plugin + ${version.org.apache.maven.plugins.install} + + + org.apache.maven.plugins + maven-jar-plugin + ${version.org.apache.maven.plugins.jar} + + + org.apache.maven.plugins + maven-javadoc-plugin + ${version.org.apache.maven.plugins.javadoc} + + + org.apache.maven.plugins + maven-release-plugin + ${version.org.apache.maven.plugins.release} + + clean verify + check + deploy + deploy,release + true + @{prefix} prepare release @{releaseLabel} [CI SKIP] + @{project.version} + + + + org.apache.maven.plugins + maven-resources-plugin + ${version.org.apache.maven.plugins.resources} + + ${project.build.propertiesEncoding} + + + + org.apache.maven.plugins + maven-site-plugin + ${version.org.apache.maven.plugins.site} + + + org.apache.maven.plugins + maven-source-plugin + ${version.org.apache.maven.plugins.source} + + + org.apache.maven.plugins + maven-surefire-plugin + ${version.org.apache.maven.plugins.surefire} + + + org.codehaus.mojo + exec-maven-plugin + ${version.org.codehaus.mojo.exec} + + + org.codehaus.mojo + tidy-maven-plugin + ${version.org.codehaus.mojo.tidy} + + + org.codehaus.mojo + versions-maven-plugin + ${version.org.codehaus.mojo.versions} + + false + + ^.*-(alpha|beta|M)-?[0-9]+$ + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + ${version.org.sonatype.plugins.nexus} + + + net.revelc.code.formatter + formatter-maven-plugin + ${version.net.revelc.code.formatter} + + ${formatter.configFile} + + + + net.revelc.code + impsort-maven-plugin + ${version.net.revelc.code.impsort} + + + @@ -210,13 +365,13 @@ - + - org.codehaus.mojo - flatten-maven-plugin + org.apache.maven.plugins + maven-install-plugin - default + default-install @@ -227,9 +382,139 @@ - release + dev + + + !env.CI + + + + true + + + org.codehaus.mojo + tidy-maven-plugin + + + validate + + pom + + + + + + net.revelc.code + impsort-maven-plugin + + + validate + + sort + + + + + + net.revelc.code.formatter + formatter-maven-plugin + + + validate + + format + + + + + + + + + check + + + env.CI + + + + + + org.codehaus.mojo + tidy-maven-plugin + + + validate + + check + + + + + + net.revelc.code + impsort-maven-plugin + + + validate + + check + + + + + + net.revelc.code.formatter + formatter-maven-plugin + + + validate + + validate + + + + + + + + + deploy + + + env.CI + + + + + + + + org.apache.maven.plugins + maven-source-plugin + + + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + + + + javadoc-no-fork + + + + + + org.apache.maven.plugins maven-resources-plugin @@ -279,5 +564,38 @@ + + release + + + + + + org.apache.maven.plugins + maven-gpg-plugin + + + + sign + + + + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + true + + sonatype-nexus + https://oss.sonatype.org/ + true + + + + + + diff --git a/src/eclipse/formatter.xml b/src/eclipse/formatter.xml new file mode 100644 index 0000000..61186a2 --- /dev/null +++ b/src/eclipse/formatter.xml @@ -0,0 +1,404 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/test/java/io/kokuwa/keycloak/metrics/KeycloakIT.java b/src/test/java/io/kokuwa/keycloak/metrics/KeycloakIT.java index cd4ebf4..a9ffeaa 100644 --- a/src/test/java/io/kokuwa/keycloak/metrics/KeycloakIT.java +++ b/src/test/java/io/kokuwa/keycloak/metrics/KeycloakIT.java @@ -10,6 +10,8 @@ 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; import org.junit.jupiter.api.extension.ExtendWith; @@ -18,7 +20,6 @@ import org.keycloak.events.EventType; import io.kokuwa.keycloak.metrics.junit.KeycloakClient; import io.kokuwa.keycloak.metrics.junit.KeycloakExtension; import io.kokuwa.keycloak.metrics.junit.Prometheus; -import jakarta.ws.rs.NotAuthorizedException; /** * Integration tests with Keycloak. @@ -87,7 +88,7 @@ public class KeycloakIT { () -> 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")); + () -> assertEquals(loginErrorBeforeUNKNOWN + 2, loginErrorAfterUNKNOWN, "login failure UNKNOWN")); } @DisplayName("user count") diff --git a/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakClient.java b/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakClient.java index 029ffde..b79ca14 100644 --- a/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakClient.java +++ b/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakClient.java @@ -13,6 +13,10 @@ import java.util.List; import java.util.Map; import java.util.UUID; +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; @@ -24,10 +28,6 @@ import org.keycloak.representations.idm.UserRepresentation; import com.fasterxml.jackson.databind.ObjectMapper; -import jakarta.ws.rs.core.HttpHeaders; -import jakarta.ws.rs.core.MediaType; -import jakarta.ws.rs.core.MultivaluedHashMap; - /** * Client for keycloak. * diff --git a/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java b/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java index e2b1175..91f013f 100644 --- a/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java +++ b/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java @@ -7,6 +7,8 @@ import java.time.Duration; import java.util.Properties; import java.util.Set; +import jakarta.ws.rs.client.ClientBuilder; + import org.junit.jupiter.api.extension.BeforeAllCallback; import org.junit.jupiter.api.extension.ExtensionContext; import org.junit.jupiter.api.extension.ParameterContext; @@ -17,8 +19,6 @@ import org.testcontainers.containers.GenericContainer; import org.testcontainers.containers.wait.strategy.Wait; import org.testcontainers.utility.MountableFile; -import jakarta.ws.rs.client.ClientBuilder; - /** * JUnit extension to start keycloak. * From 9552221cc4c7c1fabf49de066c442cd6b46a2247 Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Fri, 30 May 2025 22:18:34 +0200 Subject: [PATCH 18/27] Replace docker invocation with maven plugin --- pom.xml | 119 +++++++++++++++++++++++++------------ src/main/docker/Dockerfile | 14 ----- 2 files changed, 80 insertions(+), 53 deletions(-) delete mode 100644 src/main/docker/Dockerfile diff --git a/pom.xml b/pom.xml index 3d2ef55..8e26d7f 100644 --- a/pom.xml +++ b/pom.xml @@ -95,12 +95,12 @@ 3.21.0 3.3.1 3.5.3 - 3.5.1 1.4.0 2.18.0 1.7.0 2.26.0 1.12.0 + 0.46.0 26.2.5 ${version.org.keycloak} @@ -219,7 +219,6 @@ - ${project.artifactId} ${project.basedir}/src/test/resources @@ -308,11 +307,6 @@ maven-surefire-plugin ${version.org.apache.maven.plugins.surefire} - - org.codehaus.mojo - exec-maven-plugin - ${version.org.codehaus.mojo.exec} - org.codehaus.mojo tidy-maven-plugin @@ -347,6 +341,11 @@ impsort-maven-plugin ${version.net.revelc.code.impsort} + + io.fabric8 + docker-maven-plugin + ${version.io.fabric8.docker} + @@ -516,49 +515,91 @@ - org.apache.maven.plugins - maven-resources-plugin + io.fabric8 + docker-maven-plugin - prepare-package + build + install - copy-resources + build - - - - ${project.basedir}/src/main/docker - true - - - ${project.build.directory} - - - - - org.codehaus.mojo - exec-maven-plugin - + push deploy - exec + push - - docker - - build - ${project.build.directory} - --tag=ghcr.io/kokuwaio/keycloak-event-metrics:latest - --tag=ghcr.io/kokuwaio/keycloak-event-metrics:${project.version} - --tag=docker.io/kokuwaio/keycloak-event-metrics:latest - --tag=docker.io/kokuwaio/keycloak-event-metrics:${project.version} - --push - - + + build + + + docker.io/kokuwaio/keycloak-event-metrics:${project.version} + + docker.io/library/busybox:1.37.0-uclibc@sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d + + ${file.separator} + + + + ${project.build.directory}/${project.build.finalName}.jar + ${project.artifactId}.jar + 444 + + + + + + + ${project.name} + ${project.description} + ${project.url} + ${project.scm.url} + ${project.organization.name} + https://github.com/orgs/kokuwaio/people + ${project.licenses[0].name} + ${project.version} + docker.io/library/busybox:1.37.0-uclibc + sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d + + + + + ghcr.io/kokuwaio/keycloak-event-metrics:${project.version} + + docker.io/library/busybox:1.37.0-uclibc@sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d + + ${file.separator} + + + + ${project.build.directory}/${project.build.finalName}.jar + ${project.artifactId}.jar + 444 + + + + + + + ${project.name} + ${project.description} + ${project.url} + ${project.scm.url} + ${project.organization.name} + https://github.com/orgs/kokuwaio/people + ${project.licenses[0].name} + ${project.version} + docker.io/library/busybox:1.37.0-uclibc + sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d + + + + + diff --git a/src/main/docker/Dockerfile b/src/main/docker/Dockerfile deleted file mode 100644 index b1aeb9a..0000000 --- a/src/main/docker/Dockerfile +++ /dev/null @@ -1,14 +0,0 @@ -FROM busybox:latest - -# https://github.com/opencontainers/image-spec/blob/main/annotations.md -LABEL org.opencontainers.image.title ${project.name} -LABEL org.opencontainers.image.description ${project.description} -LABEL org.opencontainers.image.url ${project.url} -LABEL org.opencontainers.image.source ${project.url}/src/main/docker/Dockerfile -LABEL org.opencontainers.image.vendor ${project.organization.name} -LABEL org.opencontainers.image.authors https://github.com/orgs/kokuwaio/people -LABEL org.opencontainers.image.licenses Apache-2.0 -LABEL org.opencontainers.image.version ${project.version} -LABEL org.opencontainers.image.base.name busybox:latest - -COPY ${project.build.finalName}.jar /keycloak-event-metrics.jar From a523f7ba6eb7bfb643e22c789892d17726907a68 Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Mon, 23 Jun 2025 16:54:42 +0200 Subject: [PATCH 19/27] Moved repository to git.kokuwa.io --- .github/CODEOWNERS | 2 - .github/dependabot.yml | 14 - .github/settings.xml | 16 - .github/workflows/build.yaml | 68 ++- .github/workflows/lint.yaml | 23 + .github/workflows/pr.yaml | 58 --- .github/workflows/release.yaml | 50 --- .justfile | 21 + .woodpecker/deploy.yaml | 50 +++ .woodpecker/dockerhub.yaml | 17 + .woodpecker/lint.yaml | 26 ++ .woodpecker/maven/settings.xml | 33 ++ .woodpecker/release.yaml | 61 +++ .woodpecker/verify.yaml | 24 + .woodpecker/versions.yaml | 26 ++ Dockerfile | 15 + Dockerfile.dockerignore | 5 + LICENSE | 425 +++++++++++------- README.md | 19 +- pom.xml | 255 +++-------- renovate.json | 5 + .../metrics/junit/KeycloakExtension.java | 42 +- 22 files changed, 693 insertions(+), 562 deletions(-) delete mode 100644 .github/CODEOWNERS delete mode 100644 .github/dependabot.yml delete mode 100644 .github/settings.xml create mode 100644 .github/workflows/lint.yaml delete mode 100644 .github/workflows/pr.yaml delete mode 100644 .github/workflows/release.yaml create mode 100644 .justfile create mode 100644 .woodpecker/deploy.yaml create mode 100644 .woodpecker/dockerhub.yaml create mode 100644 .woodpecker/lint.yaml create mode 100644 .woodpecker/maven/settings.xml create mode 100644 .woodpecker/release.yaml create mode 100644 .woodpecker/verify.yaml create mode 100644 .woodpecker/versions.yaml create mode 100644 Dockerfile create mode 100644 Dockerfile.dockerignore create mode 100644 renovate.json diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS deleted file mode 100644 index 3f0ccf3..0000000 --- a/.github/CODEOWNERS +++ /dev/null @@ -1,2 +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 diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index 415bfca..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,14 +0,0 @@ -version: 2 -updates: - - package-ecosystem: maven - directory: / - schedule: - interval: daily - allow: - - dependency-name: io.kokuwa.maven:maven-parent - - dependency-name: org.keycloak:keycloak-quarkus-server - - package-ecosystem: github-actions - directory: / - schedule: - interval: monthly - day: monday diff --git a/.github/settings.xml b/.github/settings.xml deleted file mode 100644 index 44fd9ea..0000000 --- a/.github/settings.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - sonatype-nexus - ${env.SERVER_USERNAME} - ${env.SERVER_PASSWORD} - - - github.com - nope - ${env.GIT_ACTION_TOKEN} - - - diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 4da10a5..5d30921 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,50 +1,42 @@ -name: Build +name: Verify on: - push: - branches: [main] + - pull_request + - push: + branches: [main] + +env: + MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress jobs: build: runs-on: ubuntu-latest - env: - MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.github/settings.xml steps: - - name: docker/login-action docker.io - uses: docker/login-action@v3.4.0 - with: - registry: docker.io - username: ${{ secrets.DOCKERIO_USERNAME }} - password: ${{ secrets.DOCKERIO_TOKEN }} - - name: docker/login-action ghcr.io - uses: docker/login-action@v3.4.0 - with: - registry: ghcr.io - username: ${{ github.actor }} - password: ${{ secrets.GIT_ACTION_TOKEN }} - - run: git config --global user.name "${{ vars.KOKUWA_IO_BOT_NAME }}" - - run: git config --global user.email "${{ vars.KOKUWA_IO_BOT_EMAIL }}" - - uses: actions/checkout@v4 - with: - token: ${{ secrets.GIT_ACTION_TOKEN }} - - uses: crazy-max/ghaction-import-gpg@v6 - with: - gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} - passphrase: ${{ secrets.GPG_PASSPHRASE }} - git_user_signingkey: true - git_commit_gpgsign: true - - uses: actions/setup-java@v4 + - uses: actions/checkout@main + - uses: actions/setup-java@main 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 $MAVEN_ARGS deploy - env: - SERVER_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }} - SERVER_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }} + - run: mvn verify + + versions: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + version: + - 22.0.5 + - 23.0.7 + - 24.0.5 + - 25.0.6 + - 26.2.5 + steps: + - uses: actions/checkout@main + - uses: actions/setup-java@main + with: + distribution: temurin + java-version: 17 + cache: maven + - run: mvn verify -Dversion.org.keycloak.test=${{ matrix.version }} diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..af980fa --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,23 @@ +name: Lint + +on: push + +jobs: + + renovate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/renovate-config-validator + + markdownlint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/markdownlint + + yamllint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@main + - uses: docker://kokuwaio/yamllint diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml deleted file mode 100644 index 3548e88..0000000 --- a/.github/workflows/pr.yaml +++ /dev/null @@ -1,58 +0,0 @@ -name: PullRequest - -on: pull_request - -env: - MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress - -jobs: - - yaml: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: ibiqlik/action-yamllint@v3 - with: - format: colored - strict: true - - markdown: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: avto-dev/markdown-lint@v1 - with: - args: /github/workspace - - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-java@v4 - with: - distribution: temurin - java-version: 17 - cache: maven - - run: mvn $MAVEN_ARGS verify - - versions: - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - version: - - 22.0.5 - - 23.0.7 - - 24.0.5 - - 25.0.6 - - 26.0.8 - - 26.1.5 - - 26.2.5 - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-java@v4 - with: - distribution: temurin - java-version: 17 - cache: maven - - run: mvn $MAVEN_ARGS verify -Dcheck.skip -Dversion.org.keycloak.test=${{ matrix.version }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml deleted file mode 100644 index e3240ed..0000000 --- a/.github/workflows/release.yaml +++ /dev/null @@ -1,50 +0,0 @@ -name: Release - -on: workflow_dispatch - -jobs: - build: - runs-on: ubuntu-latest - env: - MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress --settings=.github/settings.xml - steps: - - name: docker/login-action docker.io - uses: docker/login-action@v3.4.0 - with: - registry: docker.io - username: ${{ secrets.DOCKERIO_USERNAME }} - password: ${{ secrets.DOCKERIO_TOKEN }} - - name: docker/login-action ghcr.io - uses: docker/login-action@v3.4.0 - with: - registry: ghcr.io - username: ${{ github.actor }} - password: ${{ secrets.GIT_ACTION_TOKEN }} - - run: git config --global user.name "${{ vars.KOKUWA_IO_BOT_NAME }}" - - run: git config --global user.email "${{ vars.KOKUWA_IO_BOT_EMAIL }}" - - uses: actions/checkout@v4 - with: - token: ${{ secrets.GIT_ACTION_TOKEN }} - - uses: crazy-max/ghaction-import-gpg@v6 - with: - gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} - passphrase: ${{ secrets.GPG_PASSPHRASE }} - git_user_signingkey: true - git_commit_gpgsign: true - - uses: actions/setup-java@v4 - 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 $MAVEN_ARGS release:prepare -Darguments="$MAVEN_ARGS" - - run: mvn $MAVEN_ARGS release:perform -Darguments="$MAVEN_ARGS" - env: - SERVER_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }} - SERVER_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }} - GIT_ACTION_TOKEN: ${{ secrets.GIT_ACTION_TOKEN }} - GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} diff --git a/.justfile b/.justfile new file mode 100644 index 0000000..c751e60 --- /dev/null +++ b/.justfile @@ -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 . diff --git a/.woodpecker/deploy.yaml b/.woodpecker/deploy.yaml new file mode 100644 index 0000000..53976dc --- /dev/null +++ b/.woodpecker/deploy.yaml @@ -0,0 +1,50 @@ +when: + instance: ci.kokuwa.io + repo: keycloak/keycloak-event-metrics + event: [manual, push] + branch: main + path: [.woodpecker/deploy.yaml, 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 diff --git a/.woodpecker/dockerhub.yaml b/.woodpecker/dockerhub.yaml new file mode 100644 index 0000000..a443560 --- /dev/null +++ b/.woodpecker/dockerhub.yaml @@ -0,0 +1,17 @@ +when: + instance: ci.kokuwa.io + repo: keycloak/keycloak-event-metrics + event: [manual, push] + branch: main + path: [.woodpecker/dockerhub.yaml, README.md] + +steps: + + metadata: + 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} diff --git a/.woodpecker/lint.yaml b/.woodpecker/lint.yaml new file mode 100644 index 0000000..7de51db --- /dev/null +++ b/.woodpecker/lint.yaml @@ -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]] diff --git a/.woodpecker/maven/settings.xml b/.woodpecker/maven/settings.xml new file mode 100644 index 0000000..4542205 --- /dev/null +++ b/.woodpecker/maven/settings.xml @@ -0,0 +1,33 @@ + + + false + /woodpecker/.m2 + + + git.kokuwa.io + ${env.FORGEJO_USERNAME} + ${env.FORGEJO_PASSWORD} + + + sonatype.org + ${env.SONATYPE_ORG_USERNAME} + ${env.SONATYPE_ORG_PASSWORD} + + + docker.io + ${env.DOCKER_IO_USERNAME} + ${env.DOCKER_IO_PASSWORD} + + + ghcr.io + ${env.GHCR_IO_USERNAME} + ${env.GHCR_IO_PASSWORD} + + + + + http://mirror.woodpecker.svc.cluster.local/maven2 + central + + + diff --git a/.woodpecker/release.yaml b/.woodpecker/release.yaml new file mode 100644 index 0000000..8ec3522 --- /dev/null +++ b/.woodpecker/release.yaml @@ -0,0 +1,61 @@ +when: + instance: ci.kokuwa.io + repo: keycloak/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 diff --git a/.woodpecker/verify.yaml b/.woodpecker/verify.yaml new file mode 100644 index 0000000..5d9002b --- /dev/null +++ b/.woodpecker/verify.yaml @@ -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 diff --git a/.woodpecker/versions.yaml b/.woodpecker/versions.yaml new file mode 100644 index 0000000..47a286e --- /dev/null +++ b/.woodpecker/versions.yaml @@ -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 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..6d8ad09 --- /dev/null +++ b/Dockerfile @@ -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 "\n\ +\n\ + /tmp/mvn-repo\n\ + %scentral\n\ +" "${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 diff --git a/Dockerfile.dockerignore b/Dockerfile.dockerignore new file mode 100644 index 0000000..744a668 --- /dev/null +++ b/Dockerfile.dockerignore @@ -0,0 +1,5 @@ +* +.* + +!pom.xml +!src/main/** diff --git a/LICENSE b/LICENSE index 261eeb9..dacd3ae 100644 --- a/LICENSE +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md index d57d9b6..cd59d4d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # Keycloak Metrics -Provides metrics for Keycloak user/admin events and user/client/session count. Tested on Keycloak [22-26](.github/workflows/pr.yaml#L48-L53). +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) -[![Build](https://img.shields.io/github/actions/workflow/status/kokuwaio/keycloak-event-metrics/build.yaml?label=Build)](https://github.com/kokuwaio/keycloak-event-metrics/actions/workflows/build.yaml) +[![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/keycloak/keycloak-event-metrics/src/branch/main/Dockerfile) +[![license](https://img.shields.io/badge/License-EUPL%201.2-blue)](https://git.kokuwa.io/keycloak/keycloak-event-metrics/src/branch/main/LICENSE) +[![prs](https://img.shields.io/gitea/pull-requests/open/keycloak/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/keycloak/keycloak-event-metrics/pulls) +[![issues](https://img.shields.io/gitea/issues/open/keycloak/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/keycloak/keycloak-event-metrics/issues) +[![build](https://ci.kokuwa.io/api/badges/keycloak/keycloak-event-metrics/status.svg)](https://ci.kokuwa.io/repos/keycloak/keycloak-event-metrics/) ## Why? @@ -114,7 +119,7 @@ If scrapping takes less than `KC_METRICS_STATS_INFO_THRESHOLD` duration will be ### Grafana Dashboard -Can be found here: [kokuwaio/keycloak keycloak-metrics.json](https://github.com/kokuwaio/keycloak/blob/main/src/test/k3s/dev/grafana/files/dashboards/keycloak-metrics.json) +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 @@ -131,7 +136,7 @@ This images are based on busybox, so you can use cp to copy the jar into your ke ### Docker -Check: [kokuwaio/keycloak](https://github.com/kokuwaio/keycloak) +Check: [kowaio/keycloak](https://git.kokuwa.io/keycloak/keycloak) Dockerfile: @@ -145,7 +150,7 @@ 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=1.0.0 +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} @@ -159,7 +164,7 @@ RUN mv ${METRICS_FILE} /opt/keycloak/providers ### build keycloak with metrics ### -FROM quay.io/keycloak/keycloak:25.0.1 +FROM quay.io/keycloak/keycloak:25.2.5 ENV KEYCLOAK_ADMIN=admin ENV KEYCLOAK_ADMIN_PASSWORD=password diff --git a/pom.xml b/pom.xml index 8e26d7f..4ed00e1 100644 --- a/pom.xml +++ b/pom.xml @@ -4,11 +4,11 @@ io.kokuwa.keycloak keycloak-event-metrics - 1.1.2-SNAPSHOT + 2.0.0-SNAPSHOT Keycloak Metrics Provides metrics for Keycloak user/admin events - https://github.com/kokuwaio/keycloak-event-metrics + https://git.kokuwa.io/keycloak/keycloak-event-metrics 2023 Kokuwa.io @@ -16,8 +16,8 @@ - Apache-2.0 - https://www.apache.org/licenses/LICENSE-2.0.txt + EUPL-1.2 + https://eupl.eu/1.2/en repo @@ -33,27 +33,23 @@ - https://github.com/kokuwaio/keycloak-event-metrics - scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git - scm:git:https://github.com/kokuwaio/keycloak-event-metrics.git + https://git.kokuwa.io/keycloak/keycloak-event-metrics + scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git + scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git HEAD - github - https://github.com/kokuwaio/keycloak-event-metrics/issues + forgejo + https://git.kokuwa.io/keycloak/keycloak-event-metrics/issues - github - https://github.com/kokuwaio/keycloak-event-metrics/actions + woodpecker + https://ci.kokuwa.io/repos/keycloak/keycloak-event-metrics - - sonatype-nexus - https://oss.sonatype.org/service/local/staging/deploy/maven2/ - - sonatype-nexus - https://oss.sonatype.org/content/repositories/snapshots/ + sonatype.org + https://central.sonatype.com/repository/maven-snapshots/ @@ -83,28 +79,8 @@ - 3.4.1 - 3.14.0 - 3.1.4 - 3.2.7 - 3.1.4 - 3.4.2 - 3.11.2 - 3.1.1 - 3.3.1 - 3.21.0 - 3.3.1 - 3.5.3 - 1.4.0 - 2.18.0 - 1.7.0 - 2.26.0 - 1.12.0 - 0.46.0 - 26.2.5 ${version.org.keycloak} - 1.18.3 @@ -153,6 +129,15 @@ org.jboss.resteasy resteasy-multipart-provider + + + com.sun.istack + istack-commons-tools + + + com.sun.istack + istack-commons-runtime + @@ -219,6 +204,7 @@ + ${project.artifactId} ${project.basedir}/src/test/resources @@ -227,15 +213,10 @@ - - org.apache.maven.plugins - maven-clean-plugin - ${version.org.apache.maven.plugins.clean} - org.apache.maven.plugins maven-compiler-plugin - ${version.org.apache.maven.plugins.compiler} + 3.14.0 ${maven.compiler.compilerArgument} @@ -243,41 +224,41 @@ org.apache.maven.plugins maven-deploy-plugin - ${version.org.apache.maven.plugins.deploy} + 3.1.4 org.apache.maven.plugins maven-failsafe-plugin - ${version.org.apache.maven.plugins.surefire} + 3.5.3 org.apache.maven.plugins maven-gpg-plugin - ${version.org.apache.maven.plugins.gpg} + 3.2.7 org.apache.maven.plugins maven-install-plugin - ${version.org.apache.maven.plugins.install} + 3.1.4 org.apache.maven.plugins maven-jar-plugin - ${version.org.apache.maven.plugins.jar} + 3.4.2 org.apache.maven.plugins maven-javadoc-plugin - ${version.org.apache.maven.plugins.javadoc} + 3.11.2 org.apache.maven.plugins maven-release-plugin - ${version.org.apache.maven.plugins.release} + 3.1.1 - clean verify + test check - deploy + deploy -DskipITs deploy,release true @{prefix} prepare release @{releaseLabel} [CI SKIP] @@ -287,7 +268,7 @@ org.apache.maven.plugins maven-resources-plugin - ${version.org.apache.maven.plugins.resources} + 3.3.1 ${project.build.propertiesEncoding} @@ -295,43 +276,32 @@ org.apache.maven.plugins maven-site-plugin - ${version.org.apache.maven.plugins.site} + 3.21.0 org.apache.maven.plugins maven-source-plugin - ${version.org.apache.maven.plugins.source} + 3.3.1 org.apache.maven.plugins maven-surefire-plugin - ${version.org.apache.maven.plugins.surefire} + 3.5.3 org.codehaus.mojo tidy-maven-plugin - ${version.org.codehaus.mojo.tidy} + 1.4.0 - org.codehaus.mojo - versions-maven-plugin - ${version.org.codehaus.mojo.versions} - - false - - ^.*-(alpha|beta|M)-?[0-9]+$ - - - - - org.sonatype.plugins - nexus-staging-maven-plugin - ${version.org.sonatype.plugins.nexus} + org.sonatype.central + central-publishing-maven-plugin + 0.8.0 net.revelc.code.formatter formatter-maven-plugin - ${version.net.revelc.code.formatter} + 2.26.0 ${formatter.configFile} @@ -339,12 +309,7 @@ net.revelc.code impsort-maven-plugin - ${version.net.revelc.code.impsort} - - - io.fabric8 - docker-maven-plugin - ${version.io.fabric8.docker} + 1.12.0 @@ -496,7 +461,7 @@ - jar-no-fork + jar @@ -507,109 +472,12 @@ - javadoc-no-fork + jar - - - io.fabric8 - docker-maven-plugin - - - build - install - - build - - - - push - deploy - - push - - - - - build - - - docker.io/kokuwaio/keycloak-event-metrics:${project.version} - - docker.io/library/busybox:1.37.0-uclibc@sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d - - ${file.separator} - - - - ${project.build.directory}/${project.build.finalName}.jar - ${project.artifactId}.jar - 444 - - - - - - - ${project.name} - ${project.description} - ${project.url} - ${project.scm.url} - ${project.organization.name} - https://github.com/orgs/kokuwaio/people - ${project.licenses[0].name} - ${project.version} - docker.io/library/busybox:1.37.0-uclibc - sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d - - - - - ghcr.io/kokuwaio/keycloak-event-metrics:${project.version} - - docker.io/library/busybox:1.37.0-uclibc@sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d - - ${file.separator} - - - - ${project.build.directory}/${project.build.finalName}.jar - ${project.artifactId}.jar - 444 - - - - - - - ${project.name} - ${project.description} - ${project.url} - ${project.scm.url} - ${project.organization.name} - https://github.com/orgs/kokuwaio/people - ${project.licenses[0].name} - ${project.version} - docker.io/library/busybox:1.37.0-uclibc - sha256:cc57e0ff4b6d3138931ff5c7180d18078813300e2508a25fb767a4d36df30d4d - - - - - - - - - - - - release - - - org.apache.maven.plugins @@ -619,22 +487,31 @@ sign + + bc + - - - org.sonatype.plugins - nexus-staging-maven-plugin - true - - sonatype-nexus - https://oss.sonatype.org/ - true - - - + + + + + release + + + + org.sonatype.central + central-publishing-maven-plugin + true + + true + sonatype.org + true + published + + diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..dc88820 --- /dev/null +++ b/renovate.json @@ -0,0 +1,5 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["local>infrastructure/renovate-config", ":reviewer(stephan.schnabel)"], + "pinDigests": false +} diff --git a/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java b/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java index 91f013f..aa179f7 100644 --- a/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java +++ b/src/test/java/io/kokuwa/keycloak/metrics/junit/KeycloakExtension.java @@ -15,6 +15,7 @@ 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; @@ -45,30 +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_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())) - .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); } From 10b4312fc50d7b2027095559952e0c2ea2522726 Mon Sep 17 00:00:00 2001 From: Woodpecker Date: Wed, 25 Jun 2025 14:15:36 +0000 Subject: [PATCH 20/27] [maven-release-plugin] prepare release 2.0.0 [CI SKIP] --- pom.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pom.xml b/pom.xml index 4ed00e1..8802b9e 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ io.kokuwa.keycloak keycloak-event-metrics - 2.0.0-SNAPSHOT + 2.0.0 Keycloak Metrics Provides metrics for Keycloak user/admin events @@ -36,7 +36,7 @@ https://git.kokuwa.io/keycloak/keycloak-event-metrics scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git - HEAD + 2.0.0 forgejo @@ -59,7 +59,7 @@ - 2025-04-28T12:25:49Z + 2025-06-25T14:15:09Z UTF-8 ISO-8859-1 From 964bc985186418c5efa98652d54576acc48680f4 Mon Sep 17 00:00:00 2001 From: Woodpecker Date: Wed, 25 Jun 2025 14:15:39 +0000 Subject: [PATCH 21/27] [maven-release-plugin] prepare for next development iteration --- pom.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pom.xml b/pom.xml index 8802b9e..c610000 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ io.kokuwa.keycloak keycloak-event-metrics - 2.0.0 + 2.0.1-SNAPSHOT Keycloak Metrics Provides metrics for Keycloak user/admin events @@ -36,7 +36,7 @@ https://git.kokuwa.io/keycloak/keycloak-event-metrics scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git - 2.0.0 + HEAD forgejo @@ -59,7 +59,7 @@ - 2025-06-25T14:15:09Z + 2025-06-25T14:15:39Z UTF-8 ISO-8859-1 From efb009aaef10866b5de1ae3e9f9be7ae900ec8aa Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Wed, 25 Jun 2025 19:44:59 +0200 Subject: [PATCH 22/27] Rename to `kokuwaio/keycloak-event-metrics` --- .woodpecker/deploy.yaml | 2 +- .woodpecker/dockerhub.yaml | 2 +- .woodpecker/release.yaml | 2 +- README.md | 10 +++++----- pom.xml | 1 - 5 files changed, 8 insertions(+), 9 deletions(-) diff --git a/.woodpecker/deploy.yaml b/.woodpecker/deploy.yaml index 53976dc..a562c15 100644 --- a/.woodpecker/deploy.yaml +++ b/.woodpecker/deploy.yaml @@ -1,6 +1,6 @@ when: instance: ci.kokuwa.io - repo: keycloak/keycloak-event-metrics + repo: kokuwaio/keycloak-event-metrics event: [manual, push] branch: main path: [.woodpecker/deploy.yaml, Dockerfile, pom.xml, src/main/**] diff --git a/.woodpecker/dockerhub.yaml b/.woodpecker/dockerhub.yaml index a443560..df265b7 100644 --- a/.woodpecker/dockerhub.yaml +++ b/.woodpecker/dockerhub.yaml @@ -1,6 +1,6 @@ when: instance: ci.kokuwa.io - repo: keycloak/keycloak-event-metrics + repo: kokuwaio/keycloak-event-metrics event: [manual, push] branch: main path: [.woodpecker/dockerhub.yaml, README.md] diff --git a/.woodpecker/release.yaml b/.woodpecker/release.yaml index 8ec3522..5d560ab 100644 --- a/.woodpecker/release.yaml +++ b/.woodpecker/release.yaml @@ -1,6 +1,6 @@ when: instance: ci.kokuwa.io - repo: keycloak/keycloak-event-metrics + repo: kokuwaio/keycloak-event-metrics event: deployment branch: main diff --git a/README.md b/README.md index cd59d4d..e0802e1 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ Provides metrics for Keycloak user/admin events and user/client/session count. T [![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) [![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/keycloak/keycloak-event-metrics/src/branch/main/Dockerfile) -[![license](https://img.shields.io/badge/License-EUPL%201.2-blue)](https://git.kokuwa.io/keycloak/keycloak-event-metrics/src/branch/main/LICENSE) -[![prs](https://img.shields.io/gitea/pull-requests/open/keycloak/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/keycloak/keycloak-event-metrics/pulls) -[![issues](https://img.shields.io/gitea/issues/open/keycloak/keycloak-event-metrics?gitea_url=https%3A%2F%2Fgit.kokuwa.io)](https://git.kokuwa.io/keycloak/keycloak-event-metrics/issues) -[![build](https://ci.kokuwa.io/api/badges/keycloak/keycloak-event-metrics/status.svg)](https://ci.kokuwa.io/repos/keycloak/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) +[![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) +[![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) +[![build](https://ci.kokuwa.io/api/badges/kokuwaio/keycloak-event-metrics/status.svg)](https://ci.kokuwa.io/repos/kokuwaio/keycloak-event-metrics/) ## Why? diff --git a/pom.xml b/pom.xml index c610000..30c1b44 100644 --- a/pom.xml +++ b/pom.xml @@ -506,7 +506,6 @@ central-publishing-maven-plugin true - true sonatype.org true published From 4c5e97e0de37b13d20dc5121be259c0d744752a0 Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Wed, 25 Jun 2025 20:40:06 +0200 Subject: [PATCH 23/27] Add Github README. --- .github/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/README.md diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..662ce3d --- /dev/null +++ b/.github/README.md @@ -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 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) +[![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) +[![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) +[![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) +[![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) From ad4604e5a85f59618a2eba2e5d196ccf094c00f9 Mon Sep 17 00:00:00 2001 From: Renovate Date: Thu, 26 Jun 2025 03:03:26 +0000 Subject: [PATCH 24/27] chore(deps): update dependency net.revelc.code.formatter:formatter-maven-plugin from 2.26.0 to 2.27.0 --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 30c1b44..96f8bce 100644 --- a/pom.xml +++ b/pom.xml @@ -301,7 +301,7 @@ net.revelc.code.formatter formatter-maven-plugin - 2.26.0 + 2.27.0 ${formatter.configFile} From 9277ad3afcf6f0e8830a736b3a82752f319adacf Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Thu, 26 Jun 2025 21:25:10 +0200 Subject: [PATCH 25/27] chore: fix repo urls in `pom.xml` --- pom.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/pom.xml b/pom.xml index 96f8bce..ea2dea8 100644 --- a/pom.xml +++ b/pom.xml @@ -8,7 +8,7 @@ Keycloak Metrics Provides metrics for Keycloak user/admin events - https://git.kokuwa.io/keycloak/keycloak-event-metrics + https://git.kokuwa.io/kokuwaio/keycloak-event-metrics 2023 Kokuwa.io @@ -33,18 +33,18 @@ - https://git.kokuwa.io/keycloak/keycloak-event-metrics - scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git - scm:git:https://git.kokuwa.io/keycloak/keycloak-event-metrics.git + https://git.kokuwa.io/kokuwaio/keycloak-event-metrics + scm:git:https://git.kokuwa.io/kokuwaio/keycloak-event-metrics.git + scm:git:https://git.kokuwa.io/kokuwaio/keycloak-event-metrics.git HEAD forgejo - https://git.kokuwa.io/keycloak/keycloak-event-metrics/issues + https://git.kokuwa.io/kokuwaio/keycloak-event-metrics/issues woodpecker - https://ci.kokuwa.io/repos/keycloak/keycloak-event-metrics + https://ci.kokuwa.io/repos/kokuwaio/keycloak-event-metrics @@ -454,7 +454,7 @@ - + org.apache.maven.plugins maven-source-plugin From cafd9647007e2f2caedd27d82f636f8cdc13feba Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Fri, 27 Jun 2025 11:38:37 +0200 Subject: [PATCH 26/27] chore: fix renovate preset location --- renovate.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/renovate.json b/renovate.json index dc88820..c59fb01 100644 --- a/renovate.json +++ b/renovate.json @@ -1,5 +1,5 @@ { "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": ["local>infrastructure/renovate-config", ":reviewer(stephan.schnabel)"], + "extends": ["local>kokuwaio/renovate-config", ":reviewer(stephan.schnabel)"], "pinDigests": false } From beb356e75f76cb20def0e1744ba5f2065b2be03d Mon Sep 17 00:00:00 2001 From: Stephan Schnabel Date: Fri, 27 Jun 2025 21:01:24 +0200 Subject: [PATCH 27/27] chore: remove github actions --- .github/README.md | 6 +++--- .github/workflows/build.yaml | 42 ------------------------------------ .github/workflows/lint.yaml | 23 -------------------- .woodpecker/deploy.yaml | 13 ++++++++++- .woodpecker/dockerhub.yaml | 17 --------------- .yamllint.yaml | 4 ---- README.md | 6 +++--- 7 files changed, 18 insertions(+), 93 deletions(-) delete mode 100644 .github/workflows/build.yaml delete mode 100644 .github/workflows/lint.yaml delete mode 100644 .woodpecker/dockerhub.yaml diff --git a/.github/README.md b/.github/README.md index 662ce3d..b95b40f 100644 --- a/.github/README.md +++ b/.github/README.md @@ -2,13 +2,13 @@ Provides metrics for Keycloak user/admin events and user/client/session count. Tested on Keycloak [22-26](.woodpecker/verify.yaml#L7-L11). -[![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) +[![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) -[![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) +[![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) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml deleted file mode 100644 index 5d30921..0000000 --- a/.github/workflows/build.yaml +++ /dev/null @@ -1,42 +0,0 @@ -name: Verify - -on: - - pull_request - - push: - branches: [main] - -env: - MAVEN_ARGS: --batch-mode --color=always --no-transfer-progress - -jobs: - - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@main - - uses: actions/setup-java@main - with: - distribution: temurin - java-version: 17 - cache: maven - - run: mvn verify - - versions: - runs-on: ubuntu-latest - strategy: - fail-fast: false - matrix: - version: - - 22.0.5 - - 23.0.7 - - 24.0.5 - - 25.0.6 - - 26.2.5 - steps: - - uses: actions/checkout@main - - uses: actions/setup-java@main - with: - distribution: temurin - java-version: 17 - cache: maven - - run: mvn verify -Dversion.org.keycloak.test=${{ matrix.version }} diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml deleted file mode 100644 index af980fa..0000000 --- a/.github/workflows/lint.yaml +++ /dev/null @@ -1,23 +0,0 @@ -name: Lint - -on: push - -jobs: - - renovate: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@main - - uses: docker://kokuwaio/renovate-config-validator - - markdownlint: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@main - - uses: docker://kokuwaio/markdownlint - - yamllint: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@main - - uses: docker://kokuwaio/yamllint diff --git a/.woodpecker/deploy.yaml b/.woodpecker/deploy.yaml index a562c15..7916e19 100644 --- a/.woodpecker/deploy.yaml +++ b/.woodpecker/deploy.yaml @@ -3,7 +3,7 @@ when: repo: kokuwaio/keycloak-event-metrics event: [manual, push] branch: main - path: [.woodpecker/deploy.yaml, Dockerfile, pom.xml, src/main/**] + path: [.woodpecker/deploy.yaml, README.md, Dockerfile, pom.xml, src/main/**] services: - name: dockerd @@ -48,3 +48,14 @@ steps: 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] diff --git a/.woodpecker/dockerhub.yaml b/.woodpecker/dockerhub.yaml deleted file mode 100644 index df265b7..0000000 --- a/.woodpecker/dockerhub.yaml +++ /dev/null @@ -1,17 +0,0 @@ -when: - instance: ci.kokuwa.io - repo: kokuwaio/keycloak-event-metrics - event: [manual, push] - branch: main - path: [.woodpecker/dockerhub.yaml, README.md] - -steps: - - metadata: - 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} diff --git a/.yamllint.yaml b/.yamllint.yaml index 8011808..21966f2 100644 --- a/.yamllint.yaml +++ b/.yamllint.yaml @@ -13,7 +13,3 @@ rules: quoted-strings: quote-type: double required: only-when-needed - - # allow everything on keys - truthy: - check-keys: false diff --git a/README.md b/README.md index e0802e1..b7d0bb0 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ Provides metrics for Keycloak user/admin events and user/client/session count. Tested on Keycloak [22-26](.woodpecker/verify.yaml#L7-L11). -[![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) +[![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) -[![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) +[![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?