Configuring Analytics Data Store using UI

Edit online

About this task

You can configure analytics data store to store analytics data separately from the core data.

To configure analytics data store

Procedure

  1. Expand the menu options icon , in the title bar, and select Administration.
  2. Select Destinations.
  3. Select API Gateway > Analytics to configure analytics data store.

    Provide the following information:

    Field Description
    Protocol Specifies the communication protocol used to establish communication between API Gateway and the analytics data store.

    The available protocol types are:

    • HTTP
    • HTTPS
    Hostname Specifies the host name or IP address of the machine on which analytics data store is running.
    Port Specifies the port which analytics data store uses to communicate with API Gateway.
    Username Specifies the analytics data store user ID for authenticating analytics data store when API Gateway communicates with it.
    Password Specifies the password of the analytics data store instance to be used for establishing communication between API Gateway and analytics data store.
  4. Click Test.
    This tests the communication channel between API Gateway and the configured analytics data store.
  5. Click Save.

    You can click Cancel to revert to the last saved changes or to abandon all the changes if the values are not saved.

    Clicking Save

    • updates the configurations in the core data store.
    • updates the configurations in the analyticsds.properties file
      • in the current API Gateway node.
      • in other API Gateway nodes in a cluster.
  6. Restart API Gateway for the configuration to take effect.
    Analytics data store is configured and a communication channel is established between API Gateway and analytics data store to exchange data.
    Note: The current design supports up to 2.14 billion API transaction events, accommodating the needs of small to large operational data stores. To ensure optimal performance and avoid issues related to index rollover, implement data housekeeping procedures. Regularly purge transactional data and monitor data growth to maintain integrity and performance.