https://github.com/keycloak/keycloak-benchmark

Keycloak Benchmark
https://github.com/keycloak/keycloak-benchmark

Last synced: 6 days ago
JSON representation

Keycloak Benchmark

• Host: GitHub
• URL: https://github.com/keycloak/keycloak-benchmark
• Owner: keycloak
• License: apache-2.0
• Created: 2020-12-07T07:39:08.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T08:56:24.000Z (15 days ago)
• Last Synced: 2024-10-29T10:04:24.702Z (15 days ago)
• Language: Java
• Homepage: https://www.keycloak.org/keycloak-benchmark/
• Size: 4.08 MB
• Stars: 130
• Watchers: 16
• Forks: 72
• Open Issues: 69
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
= Keycloak Benchmark

image:https://github.com/keycloak/keycloak-benchmark/actions/workflows/build.yml/badge.svg[Java CI with Maven,link=https://github.com/keycloak/keycloak-benchmark/actions/workflows/build.yml]

image:https://github.com/keycloak/keycloak-benchmark/actions/workflows/docs-pages.yml/badge.svg[Documentation,link=https://github.com/keycloak/keycloak-benchmark/actions/workflows/docs-pages.yml]

image:https://github.com/keycloak/keycloak-benchmark/actions/workflows/provision-minikube.yml/badge.svg[minikube,link=https://github.com/keycloak/keycloak-benchmark/actions/workflows/provision-minikube.yml]

The https://github.com/keycloak/keycloak-benchmark[Keycloak Benchmark repository] contains the necessary tools to run performance tests of a https://www.keycloak.org/[Keycloak server].

It has the following goals:

. Setup Keycloak for reproducible results.

. Run load tests against any Keycloak instance.

. Use an observability stack to analyze test runs.

The repository has multiple modules that can be used together or separately to achieve this:

* The benchmark module contains load tests based on Gatling.

* The provisioning module contains a more advanced Kubernetes setup based on minikube, and docker-compose scripts for a simpler setup. The setup for minikube contains a Grafana based observability stack while the docker-compose based setup doesn't.

* The dataset module contains a Keycloak add-on that can create entities in a Keycloak data store to prepare it for a load test.

== Keycloak Compatibility

This `main` branch Keycloak benchmark works with the Keycloak nightly versions,

for specific Keycloak release-based binaries please look at

https://github.com/keycloak/keycloak-benchmark/releases.

== Further reading

Read more on how to use it on https://www.keycloak.org/keycloak-benchmark/