This documentation is for WSO2 Identity Server 5.6.0. View documentation for the latest release.
Purging Analytics Data - WSO2 Identity Server 5.6.0 - WSO2 Documentation

All docs This doc
||
Skip to end of metadata
Go to start of metadata

Data purging is an option to remove historical data in WSO2 Identity Server Analytics. This is important since it is not possible to delete tables or table data in WSO2 Identity Server Analytics. By purging data, you can achieve high performance in IS data analysis without removing analyzed summary data. Only data from the stream data generated by identity server is purged. This data is contained in the following tables:

  • ORG_WSO2_IS_ANALYTICS_STREAM_OVERALLSESSION
  • ORG_WSO2_IS_ANALYTICS_STREAM_PROCESSEDOVERALLAUTHENTICATION
  • ORG_WSO2_IS_ANALYTICS_STREAM_SESSIONINFO

Make sure you do not purge data in tables other than those mentioned above because that deletes your summarized historical data.

There are two ways to purge data in IS Analytics:

Using the Management Console

To schedule data purging via the Management Console, follow the steps below:

  1. Log in to the WSO2 IS Analytics Management Console.
  2. In the Main tab, click Data Explorer (Manage > Interactive Analysis) to open the Data Explorer page.
  3. Select the required table in the Table Name field, and click Schedule Data Purging as shown below. 

    This opens the Schedule Data Purging dialog box.
  4. In the Schedule Data Purging dialog box, set the time and days within which you want to purge data as shown below. Then click Save.
  5. Repeat these steps for all 3 tables mentioned above to schedule all of them to be cleared regularly.

Using the global method

This action affects all tenants.

  1. Open the <IS_HOME>/repository/conf/analytics/analytics-config.xml file.
  2. Change the contents under the <analytics-data-purging> property as shown below:

    <analytics-data-purging>
          <purging-enable>true</purging-enable>
          <cron-expression>0 0 12 * * ?</cron-expression>
          <purge-include-tables>
             <table>.*</table>
          </purge-include-tables>
          <data-retention-days>365</data-retention-days>
    </analytics-data-purging>
  3. Save your changes.
  • No labels