Configuring Analytics Data Store manually

Edit online

About this task

You can configure analytics data store to store analytics data separately from the core data. You can configure the analytics data store manually if you want webMethods API Gateway to automatically connect to analytics data store when you start webMethods API Gateway.

To configure analytics data store

Procedure

  1. Navigate to SAGInstallDirectory\IntegrationServer\instances\​instance_name\packages\WmAPIGateway\config\resources​\elasticsearch\analyticsds.properties.
    The analyticsds.properties file contains all the properties and external Elasticsearch configurations.
  2. Configure the following properties:
    Property and Description
    apigw.analytics.ds.hosts

    Mandatory

    This property lists analytics data store hosts and ports. The values are comma separated.

    Default value: changeOnInstall

    If you modify this value, for example, localhost:port, you must edit the value in all nodes and restart the webMethods API Gateway server for the configuration to take effect.

    Note: Once a host is added to this property, this is the value that is used to connect to the analytics data store and the host configured in SAGInstallDirectory\IntegrationServer\instances\default\packages\WmAPIGateway\config\resources\beans\gateway-analytics-ds.xml file is not considered.
    apigw.analytics.ds.http.keepAlive

    Mandatory

    This property creates the persistent connection between client and server.

    Default value: true

    apigw.analytics.ds.http.connectionTimeout

    Mandatory

    This property specifies the time, in milliseconds, after which the connection times out.

    Default value: 10000

    apigw.analytics.ds.http.socketTimeout

    Mandatory

    This property specifies the wait time, in milliseconds, for a reply once the connection to analytics data store is established after which it times out.

    Default value: 30000

    apigw.analytics.ds.http.maxRetryTimeout

    Mandatory

    This property specifies the wait time, in milliseconds, for retries after which it times out.

    Default value: 100000

    IBM recommends that you set the maximum retry time for a request to (number of nodes * socketTimeOut ) + connectionTimeout.

    apigw.analytics.ds.http.keepAlive.maxConnections

    Mandatory

    This property specifies the maximum number of persistent connections that can be established between an webMethods API Gateway and analytics data store cluster.

    Default value: 50

    apigw.analytics.ds.http.keepAlive.maxConnectionsPerRoute

    Mandatory

    This property specifies the maximum number of persistent connections that can be established per HTTP route to an analytics data store server.

    Default value: 15

    apigw.analytics.ds.http.username

    This property specifies the user name to connect to analytics data store using basic authentication.

    apigw.analytics.ds.http.password

    This property specifies the password to connect to analytics data store using basic authentication.

    apigw.analytics.ds.https.keystore.filepath

    This property specifies the keystore file path for establishing HTTPS communication with analytics data store.

    apigw.analytics.ds.https.truststore.filepath

    This property specifies the truststore file path for establishing HTTPS communication with analytics data store.

    apigw.analytics.ds.https.keystore.password

    This property specifies the keystore password for establishing HTTPS communication with analytics data store.

    apigw.analytics.ds.https.keystore.alias

    This property specifies the keystore alias for establishing HTTPS communication with analytics data store.

    apigw.analytics.ds.https.truststore.password

    This property specifies the truststore password for establishing HTTPS communication with analytics data store.

    apigw.analytics.ds.https.enabled

    This property specifies whether you want to enable or disable the HTTPS communication with analytics data store.

    Default value: false

    If this property is set to false none of the above properties related to HTTPS are respected.

    apigw.analytics.ds.outbound.proxy.enabled

    This property specifies whether you want to enable or disable outbound proxy communication.

    Default value: true

    apigw.analytics.ds.outbound.proxy.alias

    This property specifies the outbound proxy alias name used to connect to analytics data store.

    apigw.analytics.ds.https.enforce.hostname.verification

    This property enforces the host name verification for SSL communication.

    Default value: false

    apigw.analytics.ds.sniff.enable

    Mandatory

    This property enables sniffers to add the other nodes in an analytics data store cluster to the client so that the client can talk to all nodes.

    Default value: true

    This configuration must be set to false if you are changing the network when webMethods API Gateway or analytics data store is running.

    apigw.analytics.ds.tenantId

    This property allows you to specify a tenant name, which must be same as what is defined for API Data Store and across all nodes.

    The default value of this property is the Integration Server instance name. So, ensure that you provide same name for all Integration Server nodes in a cluster.

    If you modify this value, you must edit the value in all nodes and restart the webMethods API Gateway server for the change to take effect.

    apigw.analytics.ds.sniff.timeInterval

    Mandatory

    This property enables adding the newly added analytics data store cluster nodes to existing REST client in a specified time interval in milliseconds.

    Default value: 60000

    apigw.analytics.ds.client.http.response.size

    Mandatory

    This property specifies the response size, in MB, for webMethods API Gateway analytics data store client.

    Default value: 100

  3. Start webMethods API Gateway for the HTTP client to take effect.