For detailed information about how to apply WUM updates to API Manager Analytics, see the WSO2 Admin Guide - Updating WSO2 Products.
Best practices
This section covers the best practices to follow when applying WUM updates to API Manager Analytics. The main factors to consider are as follows.
- The following guidelines applicable only if you replace your binary pack of WSO2 API Manager Analytics with a new pack to which the WUM updates are applied. For more information about this method of applying WUM updates, see WSO2 Admin Guide - Applying Wum Updates Manually. If you follow this method, you need to move the WSO2 API Manager Analytics pack that is updated with the WUM updates to the production envronment before applying these best practices. For more informtion, see WSO2 Admin Guide - Apply WUM Updated Products Using Automation.
- These guidelines are not applicable if you apply extracted WUM updates using automation. For more information, see WSO2 Admin Guide - Apply the Extracted WUM Updates Using Automation.
The unique node ID
The my-node-id.dat file is created in the <APIM-ANALYTICS_HOME>/repository/conf/analytics directory. If you do not create it, it is automatically created at server start-up. This file contains a unique ID for the Analytics node that helps to identify it. The databases are updated with the entries in this file. Therefore, when you apply WUM updates to nodes, use the unique ID in this file to keep track of the nodes.
Indexing data and the indexing queue
When WSO2 API Manager Analytics uses Lucene for indexing, the indexing related information is stored in the <APIM-ANALYTICS_HOME>/repository/data directory. The data that requires to be indexed goes through a queue that is known as the indexing queue. Once the data is indexed, it is stored in the index_data directory.
Before you discard the old DAS instance, you must take a backup of the <DAS_HOME>/repository/data directory and copy it to the DAS binary pack that is updated with the WUM updates.
Shard allocation
Information relating to the Shard allocation is maintained in the <APIM-ANALYTICS_HOME>/repository/conf/analytics/local-shard-allocation-config.conf file. This file stores the shard number along with its state (that can be INIT or NORMAL). The INIT is the initial state. Usually this state cannot be seen from outside. This is because the INIT state changes to the NORMAL state once the server starts. If the indexing node is running, the state of shards should be NORMAL and not INIT. The NORMAL state denotes that the indexing node has started indexing.
Before you discard the old API Manager Analytics instance, you must take a backup of the <APIM-ANALYTICS_HOME>/repository/conf/analytics/local-shard-allocation-config.conf file, and copy is back to the same location in the Analytics binary pack that is updated with the WUM updates.