Connecting to Analytics Data Store

You need to establish a communication channel between webMethods API Gateway and analytics data store to exchange data. This section explains the steps to enable webMethods API Gateway to connect to analytics data store.

You can also connect to an analytics data store through externalized configurations. For more details, see Externalizing Configurations.

A sample analytics data store externalized configuration is as follows:


---
apigw:
  analyticsDataStore:
    tenantId: default
    hosts: localhost:9241
    http:
      username: analyticsdatastore
      password: changeme
      keepAlive: true
      keepAliveMaxConnections: 60
      keepAliveMaxConnectionsPerRoute: 20
      connectionTimeout: 2000
      socketTimeout: 40000
      maxRetryTimeout: 200000
    https:
      enabled: false
      keystoreFilepath: C:/softwares/analyticsdatastore/config/demouser-keystore.jks
      truststoreFilepath: C:/softwares/analyticsdatastore/config/truststore.jks
      keystoreAlias: cn=demouser
      keystorePassword: 6572b9b06156a0ff778c
      truststorePassword: 2c0820e69e7dd5356576
      enforceHostnameVerification: false
    sniff:
      enable: false
      timeInterval: 70000
    outboundProxy:
      enabled: false
      alias: somealias
    clientHttpResponseSize: 200

To connect webMethods API Gateway to analytics data store

  1. Configure an Elasticsearch as analytics data store. For information about configuring and connecting to an Elasticsearch, see Connecting to an Elasticsearch.
  2. Configure an Kibana connecting to analytics data store for rendering dashboards in webMethods API Gateway.
    Note: Once analytics data store is used or connected on startup of webMethods API Gateway, the default internal Kibana is not used anymore. For rendering dashboards, you require Kibana.
  3. Configure the apigw.analytics.ds.hosts property in the analyticsds.properties file located at InstallDir\IntegrationServer\instances\instance_name\packages\WmAPIGateway\config\resources\elasticsearch. For example, apigw.analytics.ds.hosts=localhost:9241.
    Note: When you reset the apigw.analytics.ds.hosts with an invalid host value, analytics data store is not used to store the analytics data. Set the apigw.kibana.autostart property to true in the uiconfiguration.properties file located at InstallDir\profiles\IS_default\apigateway\config to use internal Kibana again.

    webMethods API Gateway connects to the analytics data store.

Start up sequence of components when using analytics data store for the first time:

  1. Start external analytics data store.
  2. Start webMethods API Gateway.
  3. After webMethods API Gateway is started and available, start Kibana.