Connecting to Analytics Data Store

About this task

You need to establish a communication channel between API Gateway and analytics data store to exchange data. This section explains the steps to enable 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 API Gateway to analytics data store

Procedure

Configure an external Elasticsearch as analytics data store. For information about configuring and connecting to an external Elasticsearch, see Connecting to an External Elasticsearch.
Configure an external Kibana connecting to analytics data store for rendering dashboards in API Gateway. For information about how to connect to external Kibana, see Connecting to an External Kibana.

Note: Once analytics data store is used or connected on startup of API Gateway, the default internal Kibana is not used anymore. For rendering dashboards, you require external Kibana.
Configure the apigw.analytics.ds.hosts property in the analyticsds.properties file located at SAGInstallDirectory\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 SAGInstallDirectory\profiles\IS_default\apigateway\config to use internal Kibana again.

API Gateway connects to the analytics data store.

What to do next

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

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