Updating WSO2 API Manager Analytics

WSO2 introduces the WSO2 Update Manager (WUM), which is a command-line utility that allows you to get the latest updates that are available for a particular product release. These updates include the latest bug fixes and security fixes that are released by WSO2 after a particular product version is released. Therefore, you do not need to wait and upgrade to the next product release to get these bug fixes. For information on updating WSO2 API Manager with the latest available patches (issued by WSO2) using the WUM tool, see /wiki/spaces/updates/pages/16318501 in the WSO2 Updates Guide.

The following guidelines are applicable only if you replace your binary pack of WSO2 API Manager Analytics with a new pack to which the WUM updates are applied.

The unique node ID

The my-node-id.conf file is created in the <APIM-ANALYTICS_HOME>/repository/data 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/data/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/data/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.