Removing Unused Tokens from the Database¶
From 2.6.0 onwards, WSO2 API Manager is configured by default to trigger token clean up during token generation, token refreshing and token revocation. Therefore, when the state of the token (
TOKEN_STATE) is changed during any of the latter mentioned processes for tokens that were in the
ACTIVE state before, by default, such tokens will be removed from the IDN_OAUTH2_ACCESS_TOKEN table and stored in an audit table. Thus you don't need to manually cleanup the unused tokens as guided below from API-M 2.6.0 onwards.
As you use WSO2 API Manager, the number of revoked, inactive and expired tokens accumulate in the IDN_OAUTH2_ACCESS_TOKEN table. These tokens are kept in the database for logging and audit purposes, but they can have a negative impact on the server's performance over time. Therefore, it is recommended to clean them.
The following methods can be used for token cleanup:
Configuring API Manager for token cleanup¶
WSO2 API Manager triggers token cleanup during the following instances.
- Token generation
- Token refresh
- Token revocation
This cleanup procedure is enabled by default. In this scenario Inactive, Revoked, Expired tokens will be cleaned. If you disabled this procedure and after some time you want to enable this cleanup procedure it is better to clean the access token table using script provided and enable the feature.
To enable or disable token cleanup, open the
<API-M_HOME>/repository/conf/deployment.toml file and do the following changes.(add the configuration if not exists in the deployment.toml file)
[oauth.token_cleanup] enable = true retain_access_tokens_for_auditing = true
|enable||Set this property to true to enable token cleanup. Set it to false to disable token cleanup.|
|retain_access_tokens_for_auditing||Set this property to true to move the old, invalid tokens to the Audit table when token cleaning is enabled.Set it to false if you do not wish to store old tokens in the Audit table.|
Using stored procedures for token cleanup¶
Alternatively, you can also use the stored procedures provided below, to run a token cleanup task periodically to remove the old and invalid tokens.
It is safe to run these steps in read-only mode or during a time when traffic on the server is low, but that is not mandatory.
- Take a backup of the running database.
Set up the database dump in a test environment and test it for any issues.
We recommend you to test the database dump before the cleanup task as the cleanup can take some time.
Depending on your database, select the appropriate token cleanup script from here and run it on the database dump. This takes a backup of the necessary tables, turns off SQL updates and cleans the database of unused tokens.
Once the cleanup is over, start the API Manager pointing to the cleaned-up database dump and test thoroughly for any issues. You can also schedule a cleanup task that will automatically run after a given period of time. Here's an example:
Schedule task for MySQL¶
USE 'WSO2AM_DB'; DROP EVENT IF EXISTS 'cleanup_tokens_event'; CREATE EVENT 'cleanup_tokens_event' ON SCHEDULE EVERY 1 WEEK STARTS '2018-01-01 00:00.00' DO CALL 'WSO2AM_DB'.'cleanup_tokens'(); -- 'Turn on the event_scheduler' SET GLOBAL event_scheduler = ON;
Schedule task for SQL Server¶
USE WSO2AM_DB ; GO -- Creates a schedule named CleanupTask. -- Jobs that use this schedule execute every day when the time on the server is 01:00. EXEC sp_add_schedule @schedule_name = N'CleanupTask' , @freq_type = 4, @freq_interval = 1, @active_start_time = 010000 ; GO -- attaches the schedule to the job BackupDatabase EXEC sp_attach_schedule @job_name = N'BackupDatabase', @schedule_name = N'CleanupTask' ; GO
WSO2AM_DB with the name of your API Manager database in the above script.
Registry database cleanup¶
Creating and updating APIs, adding tags and ratings cause different registry properties to be added to the Registry database(Registry DB) in WSO2 API-M. When
Registry Versioning is enabled, older properties are persisted in the database leading to unnecessary record growth in the Registry tables in the database. This directly affects the performance of the product if the number of records increase beyond a certain amount. Due to this limitation, registry versioning is disabled by default in WSO2 API Manager 3.0.0 onwards to prevent unnecessary database growth.
In WSO2 API-M versions preceding 3.0.0 (2.x.x and 1.x.x),
Registry Versioning is enabled by default, therefore we have to cleanup the Registry DB if there are large tables with millions of records.
You can always take a backup of the Registry database before the cleanup as a precaution for any issues that might occur during cleanup.
Before you begin...
Remember to shut down the server and stop any DB transactions before the database cleanup. This is to prevent any inconsistencies that could happen with new data that gets added to the DB during the cleanup.
The Cleanup scripts for the Registry DB tables are given below.
REG_LOG Table Cleanup¶
DB Types: H2, DB2, MySQL, MSSQL, Oracle and Postgresql.
CREATE TABLE REG_LOG_IDS_TO_KEEP ( REG_LOG_ID INTEGER, REG_TENANT_ID INTEGER ); INSERT INTO REG_LOG_IDS_TO_KEEP (REG_LOG_ID, REG_TENANT_ID) SELECT MAX(REG_LOG_ID) AS REG_LOG_ID, REG_TENANT_ID FROM REG_LOG GROUP BY REG_PATH, REG_TENANT_ID; DELETE FROM REG_LOG WHERE REG_LOG_ID NOT IN (SELECT REG_LOG_ID FROM REG_LOG_IDS_TO_KEEP); DROP TABLE REG_LOG_IDS_TO_KEEP; DELETE FROM REG_LOG WHERE REG_ACTION = 7;