diff --git a/.github/workflows/run-performance-tests.yml b/.github/workflows/run-performance-tests.yml new file mode 100644 index 000000000000..3d9519966ae2 --- /dev/null +++ b/.github/workflows/run-performance-tests.yml @@ -0,0 +1,149 @@ +# Performance test workflow to compare a baseline against a candidate DHIS2 version +# You can run the workflow using the GitHub CLI like so +# gh workflow run run-performance-tests.yml \ +# --field simulation_class="org.hisp.dhis.test.tracker.EnrollmentsTest" \ +# --field dhis2_image_baseline="dhis2/core:2.42.1" \ +# --field dhis2_image_candidate="dhis2/core-dev:latest" +# +# To use a specific database version, provide both dump URL and matching image suffix: +# --field dhis2_db_dump_url="https://databases.dhis2.org/sierra-leone/2.42.2/dhis2-db-sierra-leone.sql.gz" \ +# --field dhis2_db_image_suffix="sierra-leone-2.42.2" +name: Performance tests +description: Compare performance between baseline and candidate DHIS2 versions +run-name: Performance test comparing ${{ inputs.dhis2_image_baseline }} to ${{ inputs.dhis2_image_candidate }} + +on: + workflow_dispatch: + inputs: + simulation_class: + description: 'Fully qualified Gatling simulation class to run (e.g., org.hisp.dhis.test.EnrollmentsTest)' + required: true + type: string + mvn_args: + description: 'Additional maven arguments' + required: false + default: '' + type: string + # Read https://github.com/dhis2/dhis2-core/blob/master/docker/DOCKERHUB.md on how we publish + # DHIS2 Docker images + dhis2_image_baseline: + description: 'Baseline DHIS2 image for comparison' + required: false + default: 'dhis2/core-dev:latest' + type: string + dhis2_image_candidate: + description: 'Candidate DHIS2 image to compare against baseline' + required: true + type: string + dhis2_db_dump_url: + description: 'URL to DHIS2 database dump (optional)' + required: false + type: string + dhis2_db_image_suffix: + description: 'Docker image suffix for the DB image (e.g., sierra-leone-2.42.2). WARNING: Must match the version in dhis2_db_dump_url' + required: false + default: 'sierra-leone-dev' + type: string + +jobs: + performance-tests: + runs-on: perf + timeout-minutes: 40 + defaults: + run: + working-directory: dhis-2/dhis-test-performance + + steps: + - name: Checkout performance tests + uses: actions/checkout@v5 + with: + sparse-checkout: | + dhis-2/dhis-test-performance + + - name: Set up JDK 17 + uses: actions/setup-java@v5 + with: + java-version: '17' + distribution: 'temurin' + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Clean target directory + run: mvn clean + + - name: Run performance tests - baseline + run: | + DHIS2_IMAGE="${{ inputs.dhis2_image_baseline }}" \ + SIMULATION_CLASS="${{ inputs.simulation_class }}" \ + MVN_ARGS="${{ inputs.mvn_args }}" \ + DHIS2_DB_DUMP_URL="${{ inputs.dhis2_db_dump_url }}" \ + DHIS2_DB_IMAGE_SUFFIX="${{ inputs.dhis2_db_image_suffix }}" \ + ./run-simulation.sh + + - name: Run performance tests - candidate + run: | + DHIS2_IMAGE="${{ inputs.dhis2_image_candidate }}" \ + SIMULATION_CLASS="${{ inputs.simulation_class }}" \ + MVN_ARGS="${{ inputs.mvn_args }}" \ + DHIS2_DB_DUMP_URL="${{ inputs.dhis2_db_dump_url }}" \ + DHIS2_DB_IMAGE_SUFFIX="${{ inputs.dhis2_db_image_suffix }}" \ + ./run-simulation.sh + + # In 3.12 https://github.com/gatling/gatling/issues/4596 Gatling started to write the test + # results into a binary format. Gatling OSS does not support exporting that into an + # accessible format for us. The serializer/deserializer are OSS though. Our fork at + # https://github.com/dhis2/gatling/tree/glog-cli uses them to provide a CLI to extract the + # binary simulation.log into a simulation.csv. CLI releases can be downloaded from + # https://github.com/dhis2/gatling/releases. The CLI is installed on the self-hosted runner. + - name: Convert binary simulation.log to simulation.csv + if: always() + run: | + glog --config ./src/test/resources/gatling.conf --scan-subdirs target/gatling + + - name: Upload Gatling report + if: always() # reports should always be uploaded as tests can fail due to our performance assertions + uses: actions/upload-artifact@v4 + with: + name: gatling-report-${{ github.run_id }}-${{ github.sha }} + path: dhis-2/dhis-test-performance/target/gatling/ + + - name: Create test result analysis instructions + if: always() + run: | + echo "## 🚀 Performance Test Results" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "Performance tests completed comparing:" >> $GITHUB_STEP_SUMMARY + echo "* **Baseline**: \`${{ inputs.dhis2_image_baseline }}\`" >> $GITHUB_STEP_SUMMARY + echo "* **Candidate**: \`${{ inputs.dhis2_image_candidate }}\`" >> $GITHUB_STEP_SUMMARY + echo "* **Simulation Class**: \`${{ inputs.simulation_class }}\`" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "### 🖥️ Environment" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "Tests run on self-hosted runner with the following specifications:" >> $GITHUB_STEP_SUMMARY + echo "* **CPU**: Intel(R) Xeon(R) CPU E3-1275 v6 @ 3.80GHz (8 core)" >> $GITHUB_STEP_SUMMARY + echo "* **Memory**: 64GiB System Memory" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "### 📥 Download Results" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "Use GitHub CLI to download the performance test results:" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "**Download this run's data:**" >> $GITHUB_STEP_SUMMARY + echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY + echo "gh run download ${{ github.run_id }}" >> $GITHUB_STEP_SUMMARY + echo "\`\`\`" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "**Download latest run's data for current branch:**" >> $GITHUB_STEP_SUMMARY + echo "\`\`\`bash" >> $GITHUB_STEP_SUMMARY + echo "gh run download \$(gh run list --workflow=\"Performance tests\" --branch=\"\$(git branch --show-current)\" --limit=1 --json databaseId --jq '.[0].databaseId')" >> $GITHUB_STEP_SUMMARY + echo "\`\`\`" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "### 📊 View Results" >> $GITHUB_STEP_SUMMARY + echo "" >> $GITHUB_STEP_SUMMARY + echo "Results are in \`gatling-report-${{ github.run_id }}-${{ github.sha }}/\` with subdirectories:" >> $GITHUB_STEP_SUMMARY + echo "* **\`-/\`** - one for each test run (baseline has earlier timestamp)" >> $GITHUB_STEP_SUMMARY + echo " * \`index.html\` - Gatling HTML report (open in browser)" >> $GITHUB_STEP_SUMMARY + echo " * \`simulation-run.txt\` - Test run metadata (indicates baseline/candidate)" >> $GITHUB_STEP_SUMMARY + echo " * \`simulation.log\` - Binary test data (response times, etc.)" >> $GITHUB_STEP_SUMMARY + echo " * \`simulation.csv\` - Parsed binary data in CSV format" >> $GITHUB_STEP_SUMMARY + diff --git a/dhis-2/dhis-test-performance/docker-compose.yml b/dhis-2/dhis-test-performance/docker-compose.yml new file mode 100644 index 000000000000..125058271238 --- /dev/null +++ b/dhis-2/dhis-test-performance/docker-compose.yml @@ -0,0 +1,72 @@ +services: + # https://docs.dhis2.org/en/manage/reference/dhisconf.html + web: + image: "${DHIS2_IMAGE:-dhis2/core-dev:latest}" + mem_limit: 16gb + environment: + JAVA_OPTS: + "-Dlog4j2.configurationFile=/opt/dhis2/log4j2.xml \ + -Xmx10000m -Xms10000m" + volumes: + - ./docker/log4j2.xml:/opt/dhis2/log4j2.xml:ro + - ./docker/dhis.conf:/opt/dhis2/dhis.conf:ro + ports: + - "127.0.0.1:8080:8080" # DHIS2 + depends_on: + db: + condition: service_healthy + + # Healthcheck sidecar is needed for embedded tomcat images (master branch) that don't have + # curl/wget + web-healthcheck: + image: curlimages/curl:latest + network_mode: service:web + command: ["sleep", "infinity"] + depends_on: + - web + restart: unless-stopped + healthcheck: + test: ["CMD", "sh", "-c", "curl --fail --silent http://localhost:8080/api/ping"] + interval: 10s + timeout: 3s + retries: 3 + start_period: 120s + + # https://docs.dhis2.org/en/manage/reference/postgresql.html + # https://www.postgresql.org/docs/16/runtime-config-resource.html#RUNTIME-CONFIG-RESOURCE-MEMORY + # https://www.cybertec-postgresql.com/en/effective_cache_size-a-practical-example/ + # https://github.com/mastodon/mastodon/blob/fb6c22f5c275685aa644d84c003e1d6922e15d40/docker-compose.yml#L8 + # https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server + db: + build: + context: ./docker + dockerfile: Dockerfile.postgres + args: + POSTGRES_BASE_IMAGE: postgis/postgis:13-3.5 + DHIS2_DB_DUMP_URL: "${DHIS2_DB_DUMP_URL:-https://databases.dhis2.org/sierra-leone/dev/dhis2-db-sierra-leone.sql.gz}" + image: dhis2-postgres:13-3.5-${DHIS2_DB_IMAGE_SUFFIX:-sierra-leone-dev} + mem_limit: 16gb + shm_size: 256mb + volumes: + - ./docker/postgresql.conf:/etc/postgresql.conf + environment: + POSTGRES_USER: &postgres_user dhis + POSTGRES_DB: &postgres_db dhis + POSTGRES_PASSWORD: &postgres_password dhis + # https://www.postgresql.org/docs/current/libpq-envars.html + PGUSER: *postgres_user + PGDATABASE: *postgres_db + PGPASSWORD: *postgres_password + healthcheck: + test: + [ + "CMD-SHELL", + 'psql --quiet --host=127.0.0.1 --port=5432 --set=application_name=docker --command "/** docker healthcheck **/ SELECT ''ok''" > /dev/null', + ] + start_period: 120s + interval: 3s + timeout: 3s + retries: 5 + ports: + - "127.0.0.1:5432:5432" + diff --git a/dhis-2/dhis-test-performance/docker/Dockerfile.postgres b/dhis-2/dhis-test-performance/docker/Dockerfile.postgres new file mode 100644 index 000000000000..41b8eb74a9ac --- /dev/null +++ b/dhis-2/dhis-test-performance/docker/Dockerfile.postgres @@ -0,0 +1,18 @@ +ARG POSTGRES_BASE_IMAGE=postgis/postgis:13-3.5 +ARG DHIS2_DB_DUMP_URL + +FROM busybox AS downloader +ARG DHIS2_DB_DUMP_URL +WORKDIR /tmp +RUN wget --output-document dump.sql.gz "$DHIS2_DB_DUMP_URL" + +FROM ${POSTGRES_BASE_IMAGE} + +ENV POSTGRES_USER=dhis \ + POSTGRES_DB=dhis \ + POSTGRES_PASSWORD=dhis \ + PGUSER=dhis \ + PGDATABASE=dhis \ + PGPASSWORD=dhis + +COPY --from=downloader /tmp/dump.sql.gz /docker-entrypoint-initdb.d/ diff --git a/dhis-2/dhis-test-performance/docker/dhis.conf b/dhis-2/dhis-test-performance/docker/dhis.conf new file mode 100644 index 000000000000..5ba1b1b4930b --- /dev/null +++ b/dhis-2/dhis-test-performance/docker/dhis.conf @@ -0,0 +1,9 @@ +connection.dialect = org.hibernate.dialect.PostgreSQLDialect +connection.driver_class = org.postgresql.Driver +connection.url = jdbc:postgresql://db/dhis +connection.username = dhis +connection.password = dhis + +system.update_notifications_enabled = 0ff + +tracker.import.preheat.cache.enabled = off diff --git a/dhis-2/dhis-test-performance/docker/postgresql.conf b/dhis-2/dhis-test-performance/docker/postgresql.conf new file mode 100644 index 000000000000..8ce76a10a98e --- /dev/null +++ b/dhis-2/dhis-test-performance/docker/postgresql.conf @@ -0,0 +1,829 @@ +# This replicates the config used on our performance test server to enable comparison of running +# performance tests with and without Docker. +# +# ----------------------------- +# PostgreSQL configuration file +# ----------------------------- +# +# This file consists of lines of the form: +# +# name = value +# +# (The "=" is optional.) Whitespace may be used. Comments are introduced with +# "#" anywhere on a line. The complete list of parameter names and allowed +# values can be found in the PostgreSQL documentation. +# +# The commented-out settings shown in this file represent the default values. +# Re-commenting a setting is NOT sufficient to revert it to the default value; +# you need to reload the server. +# +# This file is read on server startup and when the server receives a SIGHUP +# signal. If you edit the file on a running system, you have to SIGHUP the +# server for the changes to take effect, run "pg_ctl reload", or execute +# "SELECT pg_reload_conf()". Some parameters, which are marked below, +# require a server shutdown and restart to take effect. +# +# Any parameter can also be given as a command-line option to the server, e.g., +# "postgres -c log_connections=on". Some parameters can be changed at run time +# with the "SET" SQL command. +# +# Memory units: B = bytes Time units: us = microseconds +# kB = kilobytes ms = milliseconds +# MB = megabytes s = seconds +# GB = gigabytes min = minutes +# TB = terabytes h = hours +# d = days + + +#------------------------------------------------------------------------------ +# FILE LOCATIONS +#------------------------------------------------------------------------------ + +# The default values of these variables are driven from the -D command-line +# option or PGDATA environment variable, represented here as ConfigDir. + +#data_directory = 'ConfigDir' # use data in another directory + # (change requires restart) +#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file + # (change requires restart) +#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file + # (change requires restart) + +# If external_pid_file is not explicitly set, no extra PID file is written. +#external_pid_file = '' # write an extra PID file + # (change requires restart) + + +#------------------------------------------------------------------------------ +# CONNECTIONS AND AUTHENTICATION +#------------------------------------------------------------------------------ + +# - Connection Settings - + +listen_addresses = '*' + # comma-separated list of addresses; + # defaults to 'localhost'; use '*' for all + # (change requires restart) +port = 5432 # (change requires restart) +max_connections = 200 # (change requires restart) +#reserved_connections = 0 # (change requires restart) +#superuser_reserved_connections = 3 # (change requires restart) +#unix_socket_directories = '/tmp' # comma-separated list of directories + # (change requires restart) +#unix_socket_group = '' # (change requires restart) +#unix_socket_permissions = 0777 # begin with 0 to use octal notation + # (change requires restart) +#bonjour = off # advertise server via Bonjour + # (change requires restart) +#bonjour_name = '' # defaults to the computer name + # (change requires restart) + +# - TCP settings - +# see "man tcp" for details + +#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds; + # 0 selects the system default +#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds; + # 0 selects the system default +#tcp_keepalives_count = 0 # TCP_KEEPCNT; + # 0 selects the system default +#tcp_user_timeout = 0 # TCP_USER_TIMEOUT, in milliseconds; + # 0 selects the system default + +#client_connection_check_interval = 0 # time between checks for client + # disconnection while running queries; + # 0 for never + +# - Authentication - + +#authentication_timeout = 1min # 1s-600s +#password_encryption = scram-sha-256 # scram-sha-256 or md5 +#scram_iterations = 4096 +#db_user_namespace = off + +# GSSAPI using Kerberos +#krb_server_keyfile = 'FILE:${sysconfdir}/krb5.keytab' +#krb_caseins_users = off +#gss_accept_delegation = off + +# - SSL - + +#ssl = off +#ssl_ca_file = '' +#ssl_cert_file = 'server.crt' +#ssl_crl_file = '' +#ssl_crl_dir = '' +#ssl_key_file = 'server.key' +#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers +#ssl_prefer_server_ciphers = on +#ssl_ecdh_curve = 'prime256v1' +#ssl_min_protocol_version = 'TLSv1.2' +#ssl_max_protocol_version = '' +#ssl_dh_params_file = '' +#ssl_passphrase_command = '' +#ssl_passphrase_command_supports_reload = off + + +#------------------------------------------------------------------------------ +# RESOURCE USAGE (except WAL) +#------------------------------------------------------------------------------ + +# - Memory - + +shared_buffers = 4000MB # min 128kB + # (change requires restart) +#huge_pages = try # on, off, or try + # (change requires restart) +#huge_page_size = 0 # zero for system default + # (change requires restart) +#temp_buffers = 8MB # min 800kB +#max_prepared_transactions = 0 # zero disables the feature + # (change requires restart) +# Caution: it is not advisable to set max_prepared_transactions nonzero unless +# you actively intend to use prepared transactions. +work_mem = 12MB # min 64kB +#hash_mem_multiplier = 2.0 # 1-1000.0 multiplier on hash table work_mem +maintenance_work_mem = 256MB # min 1MB +#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem +#logical_decoding_work_mem = 64MB # min 64kB +#max_stack_depth = 2MB # min 100kB +#shared_memory_type = mmap # the default is the first option + # supported by the operating system: + # mmap + # sysv + # windows + # (change requires restart) +dynamic_shared_memory_type = posix # the default is usually the first option + # supported by the operating system: + # posix + # sysv + # windows + # mmap + # (change requires restart) +#min_dynamic_shared_memory = 0MB # (change requires restart) +#vacuum_buffer_usage_limit = 256kB # size of vacuum and analyze buffer access strategy ring; + # 0 to disable vacuum buffer access strategy; + # range 128kB to 16GB + +# - Disk - + +#temp_file_limit = -1 # limits per-process temp file space + # in kilobytes, or -1 for no limit + +# - Kernel Resources - + +#max_files_per_process = 1000 # min 64 + # (change requires restart) + +# - Cost-Based Vacuum Delay - + +#vacuum_cost_delay = 0 # 0-100 milliseconds (0 disables) +#vacuum_cost_page_hit = 1 # 0-10000 credits +#vacuum_cost_page_miss = 2 # 0-10000 credits +#vacuum_cost_page_dirty = 20 # 0-10000 credits +#vacuum_cost_limit = 200 # 1-10000 credits + +# - Background Writer - + +#bgwriter_delay = 200ms # 10-10000ms between rounds +#bgwriter_lru_maxpages = 100 # max buffers written/round, 0 disables +#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round +#bgwriter_flush_after = 0 # measured in pages, 0 disables + +# - Asynchronous Behavior - + +#backend_flush_after = 0 # measured in pages, 0 disables +#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching +#maintenance_io_concurrency = 10 # 1-1000; 0 disables prefetching +#max_worker_processes = 8 # (change requires restart) +#max_parallel_workers_per_gather = 2 # limited by max_parallel_workers +#max_parallel_maintenance_workers = 2 # limited by max_parallel_workers +#max_parallel_workers = 8 # number of max_worker_processes that + # can be used in parallel operations +#parallel_leader_participation = on +#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate + # (change requires restart) + + +#------------------------------------------------------------------------------ +# WRITE-AHEAD LOG +#------------------------------------------------------------------------------ + +# - Settings - + +#wal_level = replica # minimal, replica, or logical + # (change requires restart) +#fsync = on # flush data to disk for crash safety + # (turning this off can cause + # unrecoverable data corruption) +# NOTE(ivo): this is set to 'False' on the perf server is not valid according to +# https://postgresqlco.nf/doc/en/param/synchronous_commit/ but `show synchronous_commit;` says its +# off +synchronous_commit = off # synchronization level; + # off, local, remote_write, remote_apply, or on +#wal_sync_method = fsync # the default is the first option + # supported by the operating system: + # open_datasync + # fdatasync (default on Linux and FreeBSD) + # fsync + # fsync_writethrough + # open_sync +#full_page_writes = on # recover from partial page writes +#wal_log_hints = off # also do full page writes of non-critical updates + # (change requires restart) +#wal_compression = off # enables compression of full-page writes; + # off, pglz, lz4, zstd, or on +#wal_init_zero = on # zero-fill new WAL files +#wal_recycle = on # recycle WAL files +wal_buffers = 14MB # min 32kB, -1 sets based on shared_buffers + # (change requires restart) +wal_writer_delay = 10000ms # 1-10000 milliseconds +#wal_writer_flush_after = 1MB # measured in pages, 0 disables +#wal_skip_threshold = 2MB + +#commit_delay = 0 # range 0-100000, in microseconds +#commit_siblings = 5 # range 1-1000 + +# - Checkpoints - + +#checkpoint_timeout = 5min # range 30s-1d +checkpoint_completion_target = 0.8 # checkpoint target duration, 0.0 - 1.0 +#checkpoint_flush_after = 0 # measured in pages, 0 disables +#checkpoint_warning = 30s # 0 disables +max_wal_size = 1GB +min_wal_size = 80MB + +# - Prefetching during recovery - + +#recovery_prefetch = try # prefetch pages referenced in the WAL? +#wal_decode_buffer_size = 512kB # lookahead window used for prefetching + # (change requires restart) + +# - Archiving - + +#archive_mode = off # enables archiving; off, on, or always + # (change requires restart) +#archive_library = '' # library to use to archive a WAL file + # (empty string indicates archive_command should + # be used) +#archive_command = '' # command to use to archive a WAL file + # placeholders: %p = path of file to archive + # %f = file name only + # e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f' +#archive_timeout = 0 # force a WAL file switch after this + # number of seconds; 0 disables + +# - Archive Recovery - + +# These are only used in recovery mode. + +#restore_command = '' # command to use to restore an archived WAL file + # placeholders: %p = path of file to restore + # %f = file name only + # e.g. 'cp /mnt/server/archivedir/%f %p' +#archive_cleanup_command = '' # command to execute at every restartpoint +#recovery_end_command = '' # command to execute at completion of recovery + +# - Recovery Target - + +# Set these only when performing a targeted recovery. + +#recovery_target = '' # 'immediate' to end recovery as soon as a + # consistent state is reached + # (change requires restart) +#recovery_target_name = '' # the named restore point to which recovery will proceed + # (change requires restart) +#recovery_target_time = '' # the time stamp up to which recovery will proceed + # (change requires restart) +#recovery_target_xid = '' # the transaction ID up to which recovery will proceed + # (change requires restart) +#recovery_target_lsn = '' # the WAL LSN up to which recovery will proceed + # (change requires restart) +#recovery_target_inclusive = on # Specifies whether to stop: + # just after the specified recovery target (on) + # just before the recovery target (off) + # (change requires restart) +#recovery_target_timeline = 'latest' # 'current', 'latest', or timeline ID + # (change requires restart) +#recovery_target_action = 'pause' # 'pause', 'promote', 'shutdown' + # (change requires restart) + + +#------------------------------------------------------------------------------ +# REPLICATION +#------------------------------------------------------------------------------ + +# - Sending Servers - + +# Set these on the primary and on any standby that will send replication data. + +#max_wal_senders = 10 # max number of walsender processes + # (change requires restart) +#max_replication_slots = 10 # max number of replication slots + # (change requires restart) +#wal_keep_size = 0 # in megabytes; 0 disables +#max_slot_wal_keep_size = -1 # in megabytes; -1 disables +#wal_sender_timeout = 60s # in milliseconds; 0 disables +#track_commit_timestamp = off # collect timestamp of transaction commit + # (change requires restart) + +# - Primary Server - + +# These settings are ignored on a standby server. + +#synchronous_standby_names = '' # standby servers that provide sync rep + # method to choose sync standbys, number of sync standbys, + # and comma-separated list of application_name + # from standby(s); '*' = all + +# - Standby Servers - + +# These settings are ignored on a primary server. + +#primary_conninfo = '' # connection string to sending server +#primary_slot_name = '' # replication slot on sending server +#hot_standby = on # "off" disallows queries during recovery + # (change requires restart) +#max_standby_archive_delay = 30s # max delay before canceling queries + # when reading WAL from archive; + # -1 allows indefinite delay +#max_standby_streaming_delay = 30s # max delay before canceling queries + # when reading streaming WAL; + # -1 allows indefinite delay +#wal_receiver_create_temp_slot = off # create temp slot if primary_slot_name + # is not set +#wal_receiver_status_interval = 10s # send replies at least this often + # 0 disables +#hot_standby_feedback = off # send info from standby to prevent + # query conflicts +#wal_receiver_timeout = 60s # time that receiver waits for + # communication from primary + # in milliseconds; 0 disables +#wal_retrieve_retry_interval = 5s # time to wait before retrying to + # retrieve WAL after a failed attempt +#recovery_min_apply_delay = 0 # minimum delay for applying changes during recovery + +# - Subscribers - + +# These settings are ignored on a publisher. + +#max_logical_replication_workers = 4 # taken from max_worker_processes + # (change requires restart) +#max_sync_workers_per_subscription = 2 # taken from max_logical_replication_workers +#max_parallel_apply_workers_per_subscription = 2 # taken from max_logical_replication_workers + + +#------------------------------------------------------------------------------ +# QUERY TUNING +#------------------------------------------------------------------------------ + +# - Planner Method Configuration - + +#enable_async_append = on +#enable_bitmapscan = on +#enable_gathermerge = on +#enable_hashagg = on +#enable_hashjoin = on +#enable_incremental_sort = on +#enable_indexscan = on +#enable_indexonlyscan = on +#enable_material = on +#enable_memoize = on +#enable_mergejoin = on +#enable_nestloop = on +#enable_parallel_append = on +#enable_parallel_hash = on +#enable_partition_pruning = on +#enable_partitionwise_join = off +#enable_partitionwise_aggregate = off +#enable_presorted_aggregate = on +#enable_seqscan = on +#enable_sort = on +#enable_tidscan = on + +# - Planner Cost Constants - + +#seq_page_cost = 1.0 # measured on an arbitrary scale +#random_page_cost = 4.0 # same scale as above +#cpu_tuple_cost = 0.01 # same scale as above +#cpu_index_tuple_cost = 0.005 # same scale as above +#cpu_operator_cost = 0.0025 # same scale as above +#parallel_setup_cost = 1000.0 # same scale as above +#parallel_tuple_cost = 0.1 # same scale as above +#min_parallel_table_scan_size = 8MB +#min_parallel_index_scan_size = 512kB +effective_cache_size = 7000MB + +#jit_above_cost = 100000 # perform JIT compilation if available + # and query more expensive than this; + # -1 disables +#jit_inline_above_cost = 500000 # inline small functions if query is + # more expensive than this; -1 disables +#jit_optimize_above_cost = 500000 # use expensive JIT optimizations if + # query is more expensive than this; + # -1 disables + +# - Genetic Query Optimizer - + +#geqo = on +#geqo_threshold = 12 +#geqo_effort = 5 # range 1-10 +#geqo_pool_size = 0 # selects default based on effort +#geqo_generations = 0 # selects default based on effort +#geqo_selection_bias = 2.0 # range 1.5-2.0 +#geqo_seed = 0.0 # range 0.0-1.0 + +# - Other Planner Options - + +#default_statistics_target = 100 # range 1-10000 +#constraint_exclusion = partition # on, off, or partition +#cursor_tuple_fraction = 0.1 # range 0.0-1.0 +#from_collapse_limit = 8 +#jit = on # allow JIT compilation +#join_collapse_limit = 8 # 1 disables collapsing of explicit + # JOIN clauses +#plan_cache_mode = auto # auto, force_generic_plan or + # force_custom_plan +#recursive_worktable_factor = 10.0 # range 0.001-1000000 + + +#------------------------------------------------------------------------------ +# REPORTING AND LOGGING +#------------------------------------------------------------------------------ + +# - Where to Log - + +log_destination = 'stderr' # Valid values are combinations of + # stderr, csvlog, jsonlog, syslog, and + # eventlog, depending on platform. + # csvlog and jsonlog require + # logging_collector to be on. + +# This is used when logging to stderr: +logging_collector = on # Enable capturing of stderr, jsonlog, + # and csvlog into log files. Required + # to be on for csvlogs and jsonlogs. + # (change requires restart) + +# These are only used if logging_collector is on: +#log_directory = 'log' # directory where log files are written, + # can be absolute or relative to PGDATA +log_filename = 'postgresql.log' # 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern, + # can include strftime() escapes +#log_file_mode = 0600 # creation mode for log files, + # begin with 0 to use octal notation +#log_rotation_age = 1d # Automatic rotation of logfiles will + # happen after that time. 0 disables. +#log_rotation_size = 10MB # Automatic rotation of logfiles will + # happen after that much log output. + # 0 disables. +#log_truncate_on_rotation = off # If on, an existing log file with the + # same name as the new log file will be + # truncated rather than appended to. + # But such truncation only occurs on + # time-driven rotation, not on restarts + # or size-driven rotation. Default is + # off, meaning append to existing files + # in all cases. + +# These are relevant when logging to syslog: +#syslog_facility = 'LOCAL0' +#syslog_ident = 'postgres' +#syslog_sequence_numbers = on +#syslog_split_messages = on + +# This is only relevant when logging to eventlog (Windows): +# (change requires restart) +#event_source = 'PostgreSQL' + +# - When to Log - + +#log_min_messages = warning # values in order of decreasing detail: + # debug5 + # debug4 + # debug3 + # debug2 + # debug1 + # info + # notice + # warning + # error + # log + # fatal + # panic + +#log_min_error_statement = error # values in order of decreasing detail: + # debug5 + # debug4 + # debug3 + # debug2 + # debug1 + # info + # notice + # warning + # error + # log + # fatal + # panic (effectively off) + +log_min_duration_statement = 0 # -1 is disabled, 0 logs all statements + # and their durations, > 0 logs only + # statements running at least this number + # of milliseconds + +#log_min_duration_sample = -1 # -1 is disabled, 0 logs a sample of statements + # and their durations, > 0 logs only a sample of + # statements running at least this number + # of milliseconds; + # sample fraction is determined by log_statement_sample_rate + +#log_statement_sample_rate = 1.0 # fraction of logged statements exceeding + # log_min_duration_sample to be logged; + # 1.0 logs all such statements, 0.0 never logs + + +#log_transaction_sample_rate = 0.0 # fraction of transactions whose statements + # are logged regardless of their duration; 1.0 logs all + # statements from all transactions, 0.0 never logs + +#log_startup_progress_interval = 10s # Time between progress updates for + # long-running startup operations. + # 0 disables the feature, > 0 indicates + # the interval in milliseconds. + +# - What to Log - + +#debug_print_parse = off +#debug_print_rewritten = off +#debug_print_plan = off +#debug_pretty_print = on +#log_autovacuum_min_duration = 10min # log autovacuum activity; + # -1 disables, 0 logs all actions and + # their durations, > 0 logs only + # actions running at least this number + # of milliseconds. +# https://pgbadger.darold.net/documentation.html#POSTGRESQL-CONFIGURATION +log_checkpoints = on +log_connections = on +log_disconnections = on +log_lock_waits = on +log_temp_files = 0 +log_autovacuum_min_duration = 0 +log_error_verbosity = default +#log_disconnections = off +#log_duration = off +#log_error_verbosity = default # terse, default, or verbose messages +#log_hostname = off +# query id is not supported in PG 13 +# log_line_prefix = '%t [%p]: user=%u,db=%d,app=%a,id=%Q ' # special values: +log_line_prefix = '%t [%p]: user=%u,db=%d,app=%a ' # special values: + # %a = application name + # %u = user name + # %d = database name + # %r = remote host and port + # %h = remote host + # %b = backend type + # %p = process ID + # %P = process ID of parallel group leader + # %t = timestamp without milliseconds + # %m = timestamp with milliseconds + # %n = timestamp with milliseconds (as a Unix epoch) + # %Q = query ID (0 if none or not computed) + # %i = command tag + # %e = SQL state + # %c = session ID + # %l = session line number + # %s = session start timestamp + # %v = virtual transaction ID + # %x = transaction ID (0 if none) + # %q = stop here in non-session + # processes + # %% = '%' + # e.g. '<%u%%%d> ' + # log_checkpoints = on +#log_lock_waits = off # log lock waits >= deadlock_timeout +#log_recovery_conflict_waits = off # log standby recovery conflict waits + # >= deadlock_timeout +#log_parameter_max_length = -1 # when logging statements, limit logged + # bind-parameter values to N bytes; + # -1 means print in full, 0 disables +#log_parameter_max_length_on_error = 0 # when logging an error, limit logged + # bind-parameter values to N bytes; + # -1 means print in full, 0 disables +#log_statement = 'none' # none, ddl, mod, all +#log_replication_commands = off +#log_temp_files = -1 # log temporary files equal or larger + # than the specified size in kilobytes; + # -1 disables, 0 logs all temp files +# use UTC so it aligns with Gatlings report directories which have a timestamp suffix in UTj +log_timezone = 'UTC' + +# - Process Title - + +#cluster_name = '' # added to process titles if nonempty + # (change requires restart) +#update_process_title = on + + +#------------------------------------------------------------------------------ +# STATISTICS +#------------------------------------------------------------------------------ + +# - Cumulative Query and Index Statistics - + +#track_activities = on +#track_activity_query_size = 1024 # (change requires restart) +#track_counts = on +#track_io_timing = off +#track_wal_io_timing = off +#track_functions = none # none, pl, all +#stats_fetch_consistency = cache # cache, none, snapshot + + +# - Monitoring - + +# compute_query_id = on # not supported in PG 13 :( this has the default of auto on test.performance.dhis2.org +#log_statement_stats = off +#log_parser_stats = off +#log_planner_stats = off +#log_executor_stats = off + + +#------------------------------------------------------------------------------ +# AUTOVACUUM +#------------------------------------------------------------------------------ + +#autovacuum = on # Enable autovacuum subprocess? 'on' + # requires track_counts to also be on. +#autovacuum_max_workers = 3 # max number of autovacuum subprocesses + # (change requires restart) +#autovacuum_naptime = 1min # time between autovacuum runs +#autovacuum_vacuum_threshold = 50 # min number of row updates before + # vacuum +#autovacuum_vacuum_insert_threshold = 1000 # min number of row inserts + # before vacuum; -1 disables insert + # vacuums +#autovacuum_analyze_threshold = 50 # min number of row updates before + # analyze +#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum +#autovacuum_vacuum_insert_scale_factor = 0.2 # fraction of inserts over table + # size before insert vacuum +#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze +#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum + # (change requires restart) +#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age + # before forced vacuum + # (change requires restart) +#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for + # autovacuum, in milliseconds; + # -1 means use vacuum_cost_delay +#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for + # autovacuum, -1 means use + # vacuum_cost_limit + + +#------------------------------------------------------------------------------ +# CLIENT CONNECTION DEFAULTS +#------------------------------------------------------------------------------ + +# - Statement Behavior - + +#client_min_messages = notice # values in order of decreasing detail: + # debug5 + # debug4 + # debug3 + # debug2 + # debug1 + # log + # notice + # warning + # error +#search_path = '"$user", public' # schema names +#row_security = on +#default_table_access_method = 'heap' +#default_tablespace = '' # a tablespace name, '' uses the default +#default_toast_compression = 'pglz' # 'pglz' or 'lz4' +#temp_tablespaces = '' # a list of tablespace names, '' uses + # only default tablespace +#check_function_bodies = on +#default_transaction_isolation = 'read committed' +#default_transaction_read_only = off +#default_transaction_deferrable = off +#session_replication_role = 'origin' +#statement_timeout = 0 # in milliseconds, 0 is disabled +#lock_timeout = 0 # in milliseconds, 0 is disabled +#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled +#idle_session_timeout = 0 # in milliseconds, 0 is disabled +#vacuum_freeze_table_age = 150000000 +#vacuum_freeze_min_age = 50000000 +#vacuum_failsafe_age = 1600000000 +#vacuum_multixact_freeze_table_age = 150000000 +#vacuum_multixact_freeze_min_age = 5000000 +#vacuum_multixact_failsafe_age = 1600000000 +#bytea_output = 'hex' # hex, escape +#xmlbinary = 'base64' +#xmloption = 'content' +#gin_pending_list_limit = 4MB +#createrole_self_grant = '' # set and/or inherit + +# - Locale and Formatting - + +datestyle = 'iso, mdy' +#intervalstyle = 'postgres' +timezone = 'UTC' +#timezone_abbreviations = 'Default' # Select the set of available time zone + # abbreviations. Currently, there are + # Default + # Australia (historical usage) + # India + # You can create your own file in + # share/timezonesets/. +#extra_float_digits = 1 # min -15, max 3; any value >0 actually + # selects precise output mode +#client_encoding = sql_ascii # actually, defaults to database + # encoding + +# These settings are initialized by initdb, but they can be changed. +#icu_validation_level = warning # report ICU locale validation + # errors at the given level + +# - Shared Library Preloading - + +#local_preload_libraries = '' +#session_preload_libraries = '' +#shared_preload_libraries = '' # (change requires restart) +#jit_provider = 'llvmjit' # JIT library to use + +# - Other Defaults - + +#dynamic_library_path = '$libdir' +#extension_destdir = '' # prepend path when loading extensions + # and shared objects (added by Debian) +#gin_fuzzy_search_limit = 0 + + +#------------------------------------------------------------------------------ +# LOCK MANAGEMENT +#------------------------------------------------------------------------------ + +#deadlock_timeout = 1s +max_locks_per_transaction = 200 # min 10 + # (change requires restart) +#max_pred_locks_per_transaction = 64 # min 10 + # (change requires restart) +#max_pred_locks_per_relation = -2 # negative values mean + # (max_pred_locks_per_transaction + # / -max_pred_locks_per_relation) - 1 +#max_pred_locks_per_page = 2 # min 0 + + +#------------------------------------------------------------------------------ +# VERSION AND PLATFORM COMPATIBILITY +#------------------------------------------------------------------------------ + +# - Previous PostgreSQL Versions - + +#array_nulls = on +#backslash_quote = safe_encoding # on, off, or safe_encoding +#escape_string_warning = on +#lo_compat_privileges = off +#quote_all_identifiers = off +#standard_conforming_strings = on +#synchronize_seqscans = on + +# - Other Platforms and Clients - + +#transform_null_equals = off + + +#------------------------------------------------------------------------------ +# ERROR HANDLING +#------------------------------------------------------------------------------ + +#exit_on_error = off # terminate session on any error? +#restart_after_crash = on # reinitialize after backend crash? +#data_sync_retry = off # retry or panic on failure to fsync + # data? + # (change requires restart) +#recovery_init_sync_method = fsync # fsync, syncfs (Linux 5.8+) + + +#------------------------------------------------------------------------------ +# CONFIG FILE INCLUDES +#------------------------------------------------------------------------------ + +# These options allow settings to be loaded from files other than the +# default postgresql.conf. Note that these are directives, not variable +# assignments, so they can usefully be given more than once. + +#include_dir = '...' # include files ending in '.conf' from + # a directory, e.g., 'conf.d' +#include_if_exists = '...' # include file only if it exists +#include = '...' # include file + + +#------------------------------------------------------------------------------ +# CUSTOMIZED OPTIONS +#------------------------------------------------------------------------------ + +# Add settings for extensions here diff --git a/dhis-2/dhis-test-performance/pom.xml b/dhis-2/dhis-test-performance/pom.xml new file mode 100644 index 000000000000..1185de690447 --- /dev/null +++ b/dhis-2/dhis-test-performance/pom.xml @@ -0,0 +1,77 @@ + + + 4.0.0 + + org.dhis + performance-tests-gatling + 1.0 + Performance tests for DHIS2 using Gatling framework + + + .. + 17 + 17 + UTF-8 + + 3.14.3 + 4.19.0 + 2.46.1 + + + + + io.gatling + gatling-app + ${gatling.version} + + + io.gatling.highcharts + gatling-charts-highcharts + ${gatling.version} + + + + + + + io.gatling + gatling-maven-plugin + ${gatling-maven-plugin.version} + + + com.diffplug.spotless + spotless-maven-plugin + ${spotless.version} + + + true + + + + 1.27.0 + + + + + ${rootDir}/license-header + + + + + + @formatter:off + @formatter:on + + + pom.xml + + + false + + + UNIX + + + + + diff --git a/dhis-2/dhis-test-performance/run-simulation.sh b/dhis-2/dhis-test-performance/run-simulation.sh new file mode 100755 index 000000000000..3808f96b9e87 --- /dev/null +++ b/dhis-2/dhis-test-performance/run-simulation.sh @@ -0,0 +1,97 @@ +#!/bin/bash +# Run Gatling simulations against a DHIS2 instance running in Docker +# +# Usage: DHIS2_IMAGE= SIMULATION_CLASS= [DHIS2_DB_DUMP_URL=] [MVN_ARGS=] ./run-simulation.sh +# Example: DHIS2_IMAGE=dhis2/core-dev:local SIMULATION_CLASS=org.hisp.dhis.test.EnrollmentsTest MVN_ARGS="-DpageSize=100" ./run-simulation.sh +# Available Docker image tags: https://github.com/dhis2/dhis2-core/blob/master/docker/DOCKERHUB.md +set -euo pipefail + +show_usage() { + echo "Usage: DHIS2_IMAGE= SIMULATION_CLASS= [DHIS2_DB_DUMP_URL=] $0" + echo "Example: DHIS2_IMAGE=dhis2/core-dev:latest SIMULATION_CLASS=org.hisp.dhis.test.EnrollmentsTest $0" + echo "Optional: DHIS2_DB_DUMP_URL defaults to https://databases.dhis2.org/sierra-leone/dev/dhis2-db-sierra-leone.sql.gz" + echo "Available Docker image tags: https://github.com/dhis2/dhis2-core/blob/master/docker/DOCKERHUB.md" +} + +if [ -z "${DHIS2_IMAGE:-}" ]; then + echo "Error: DHIS2_IMAGE environment variable is required" + show_usage + exit 1 +fi + +if [ -z "${SIMULATION_CLASS:-}" ]; then + echo "Error: SIMULATION_CLASS environment variable is required" + show_usage + exit 1 +fi + +MVN_ARGS=${MVN_ARGS:-""} +DHIS2_DB_DUMP_URL=${DHIS2_DB_DUMP_URL:-"https://databases.dhis2.org/sierra-leone/dev/dhis2-db-sierra-leone.sql.gz"} +DHIS2_DB_IMAGE_SUFFIX=${DHIS2_DB_IMAGE_SUFFIX:-"sierra-leone-dev"} +HEALTHCHECK_TIMEOUT=${HEALTHCHECK_TIMEOUT:-300} # default of 5min +HEALTHCHECK_INTERVAL=${HEALTHCHECK_INTERVAL:-10} # default of 10s + +cleanup() { + echo "" + echo "Cleaning up..." + docker compose down --volumes +} + +trap cleanup EXIT INT + +wait_for_health() { + echo "Waiting for DHIS2 to start..." + local start_time + start_time=$(date +%s) + + while ! docker compose ps web-healthcheck | grep -q "healthy"; do + sleep "$HEALTHCHECK_INTERVAL" + echo "Still waiting..." + if [ $(($(date +%s) - start_time)) -gt "$HEALTHCHECK_TIMEOUT" ]; then + echo "Timeout waiting for DHIS2 to start" + exit 1 + fi + done + echo "DHIS2 is ready! (took $(($(date +%s) - start_time))s)" +} + +echo "Testing with image: $DHIS2_IMAGE" + +docker compose down --volumes +docker compose up --detach + +wait_for_health + +# vacuum to get up to date PostgreSQL statistics +docker compose exec db psql -U dhis -c 'VACUUM;' + +echo "Running $SIMULATION_CLASS..." +mvn gatling:test \ + -Dgatling.simulationClass="$SIMULATION_CLASS" \ + $MVN_ARGS + +gatling_run_dir="target/gatling/$(cat target/gatling/lastRun.txt)" + +# Create simulation run metadata file in key=value format +simulation_run_file="$gatling_run_dir/simulation-run.txt" +{ + echo "RUN_DIR=$gatling_run_dir" + echo "COMMAND=DHIS2_IMAGE=$DHIS2_IMAGE DHIS2_DB_DUMP_URL=$DHIS2_DB_DUMP_URL SIMULATION_CLASS=$SIMULATION_CLASS${MVN_ARGS:+ MVN_ARGS=$MVN_ARGS}${HEALTHCHECK_TIMEOUT:+ HEALTHCHECK_TIMEOUT=$HEALTHCHECK_TIMEOUT}${HEALTHCHECK_INTERVAL:+ HEALTHCHECK_INTERVAL=$HEALTHCHECK_INTERVAL} $0" + echo "SCRIPT_NAME=$0" + echo "SCRIPT_ARGS=$*" + echo "DHIS2_IMAGE=$DHIS2_IMAGE" + echo "DHIS2_DB_DUMP_URL=$DHIS2_DB_DUMP_URL" + echo "DHIS2_DB_IMAGE_SUFFIX=$DHIS2_DB_IMAGE_SUFFIX" + echo "SIMULATION_CLASS=$SIMULATION_CLASS" + echo "MVN_ARGS=$MVN_ARGS" + echo "HEALTHCHECK_TIMEOUT=$HEALTHCHECK_TIMEOUT" + echo "HEALTHCHECK_INTERVAL=$HEALTHCHECK_INTERVAL" + echo "GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD 2>/dev/null || echo 'unknown')" + echo "GIT_COMMIT=$(git rev-parse HEAD 2>/dev/null || echo 'unknown')" + echo "GIT_DIRTY=$([ -n "$(git status --porcelain 2>/dev/null)" ] && echo 'true' || echo 'false')" +} > "$simulation_run_file" + +echo "Completed test for $DHIS2_IMAGE" +echo "Gatling test results are in: $gatling_run_dir" +echo "Gatling run metadata is in: $simulation_run_file" + diff --git a/dhis-2/dhis-test-performance/src/test/resources/gatling.conf b/dhis-2/dhis-test-performance/src/test/resources/gatling.conf new file mode 100644 index 000000000000..83a37c3e948f --- /dev/null +++ b/dhis-2/dhis-test-performance/src/test/resources/gatling.conf @@ -0,0 +1,10 @@ +gatling { + http { + requestTimeout = 600000 # 10 minutes for long-running DHIS2 operations + } + data { + leak { + noActivityTimeout = 60 # Period, in seconds, for which Gatling may have no activity before considering a leak may be happening + } + } +} diff --git a/dhis-2/dhis-test-performance/src/test/resources/logback-test.xml b/dhis-2/dhis-test-performance/src/test/resources/logback-test.xml new file mode 100644 index 000000000000..1c2c5d01c0f0 --- /dev/null +++ b/dhis-2/dhis-test-performance/src/test/resources/logback-test.xml @@ -0,0 +1,11 @@ + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + +