Connecting to External Database and Kibana

Edit online

webMethods API Gateway requires Elasticsearch database to store its data and Kibana to visualize data as part of the analytics dashboard. You must download Elasticsearch and Kibana and perform configurations to enable your webMethods API Gateway instance to use it.

To connect webMethods API Gateway to Elasticsearch database

  1. Download the latest supported version of Elasticsearch for the current webMethods API Gateway version from the following URL: https://www.elastic.co/downloads/elasticsearch
  2. Unzip the downloaded Elasticsearch folder.
  3. Configure Elasticsearch. For detailed information on how to configure external Elasticsearch, see https://www.elastic.co/guide/en/elasticsearch/reference/current/settings.html.
  4. Open command prompt in this location and run the following command: 
    elasticsearch.bat -p elasticsearch.pid -Ehttp.port=9240 -Enode.name=node-1 -Etransport.port=9340 -Enetwork.host=0.0.0.0 -Expack.security.enabled=false -Ediscovery.seed_hosts=localhost:9340 -Ecluster.initial_master_nodes=node-1 -Epath.logs=C:/workspace/IBMAPIGateway/elasticsearch_logs &
  5. Navigate to Install_Dir/IntegrationServer/packages/WmAPIGateway/config/resources/elasticsearch .
  6. Open config.properties.
  7. Set the values for the following properties:
    • pg.gateway.elasticsearch.hosts to localhost:9240.
  8. Save the configuration of the config.properties file.
  9. Open analyticsds.properties.
  10. Set the value of the property apigw.analytics.ds.hosts to localhost:9240.
  11. Save the configuration of the analyticsds.properties file.

    The connection is established.

To connect webMethods API Gateway to external Kibana

  1. Download the latest version of Kibana from the following URL: https://www.elastic.co/downloads/kibana
  2. Unzip the downloaded external folder.
  3. Configure Kibana. For detailed information on how to configure Kibana, see https://www.elastic.co/guide/en/kibana/current/settings.html.
  4. Open command prompt in this location and run the following command: 
    kibana.bat --port=9405 --server.basePath="/apigatewayui/dashboardproxy" --server.host="0.0.0.0" --elasticsearch.hosts=http://localhost:9240 --pid.file="kibana.pid" &

    The connection is established.