18.16. Performance considerations

You can test performance using the apache bench from the apache utils. Creating a simple pass token for a user, eases the performance testing.

Then you can run:

ab -l -n 200 -c 8 -s 30 'https://localhost/validate/check?user=yourUser&pass=yourPassword'

The performance depends on several aspects like the connection speed to your database and the connection speed to your user stores.

18.16.1. Is the database the bottleneck?

Because almost every request reads from the database and the user store, a slow database or a slow network link to it makes privacyIDEA feel slow - even though privacyIDEA itself is not the cause. Before assuming the application is at fault, check where the time is actually spent:

  • The Resolver Timing panel on the Dashboard shows the per-resolver latency of user-store operations. Consistently high values there point at the user store (e.g. a remote LDAP/SQL/HTTP backend) or the network to it, not at privacyIDEA.

  • For the database itself, use the database’s own diagnostics, which are far more precise than anything in the application:

    • PostgreSQL: set log_min_duration_statement (for example to 200 ms) to log slow statements, and/or enable the pg_stat_statements extension to see which statements cost the most over time.

    • MySQL / MariaDB: enable the slow query log (slow_query_log = 1 together with a suitable long_query_time).

  • Also check the network round-trip latency to the database host, whether the connection pool is saturated, and that the database server has enough CPU, memory and I/O.

The ab benchmark above, run against a simple pass token, is a quick way to isolate the privacyIDEA + database path from token and user-store crypto.

18.16.2. Processes

You should run several processes and threads. You might start with the number of processes equal to the number of your CPU cores. But you should evaluate, which is the best number of processes to get the highest performance.

18.16.3. Config caching

Starting with privacyIDEA 2.15 privacyIDEA uses a Cache per instance and process to cache system configuration, resolver, realm and policies.

As the configuration might have been changed in the database by another process or another instance, privacyIDEA compares a cache timestamp with the timestamp in the database. Thus at the beginning of the request privacyIDEA reads the timestamp from the database.

You can configure how often the timestamp should be read using the pi.cfg variable PI_CHECK_RELOAD_CONFIG. You can set this to seconds. If you use this config value to set values higher than 0, you will improve your performance. But: other processes or instances will learn later about configuration changes which might lead to unexpected behavior.

18.16.4. Cryptography

Cryptography, especially Public-key cryptography is typically based on solving difficult and/or time-consuming problems. privacyIDEA uses a lot of cryptographic techniques to ensure the security of its operation.

Some cryptographic operations are not strictly necessary for the secure operation but provide additional safety for the user. If performance is an issue, some of these can be disabled to improve the throughput.

Please also read Cryptographic considerations of privacyIDEA to understand the implications.

18.16.4.1. The Audit-log

Each entry in the Audit log is digitally signed to detect tampering.

Loading the private key from PI_AUDIT_KEY_PRIVATE validates it, which takes considerably longer than creating a signature with it. The loaded key is kept for the lifetime of the worker process, so this happens once per process and not once per audit entry. If you can be sure that the private key has not been tampered with, the config entry PI_AUDIT_NO_PRIVATE_KEY_CHECK = True in The Config File skips the validation, but it only saves the single check each worker process does on the first request it handles. The audit object is created for every request, so that is where the key is loaded, whether or not an audit entry is written.

With the config entry PI_AUDIT_NO_SIGN = True the signing of the Audit-log can be deactivated completely.

18.16.4.2. The privacyIDEA Response

By default, privacyIDEA signs every JSON-Response with the private key in PI_AUDIT_KEY_PRIVATE. As for the audit log, the key is loaded and validated when a worker process signs its first response and is then kept for the lifetime of that process, so the config entry PI_RESPONSE_NO_PRIVATE_KEY_CHECK = True only skips that one validation.

The signing of the response can be disabled completely by setting PI_NO_RESPONSE_SIGN to True.

18.16.5. Logging

Choose a logging level like WARNING or ERROR. Setting the logging level to INFO or DEBUG will produce much log output and lead to a decrease in performance.

18.16.6. Response

You can strip the authentication response to get a slight increase in performance by using the policy no_details_on_success.

18.16.7. Clean configuration

Remove unused resolvers and policies. Have a realm with several resolvers is a bit slower than one realm with one resolver. Finding the user in the first resolver is faster than in the last resolver. Although e.g. the LDAP resolver utilizes caching.

Also see What happens in the tokenview?.