Configuring Elasticsearch Destination

Edit online

About this task

You have to configure Elasticsearch as a destination to establish a communication channel between webMethods API Gateway and Elasticsearch to exchange data.

To configure Elasticsearch destination

Procedure

  1. Expand the menu options icon , in the title bar, and select Administration.
  2. Select Destinations.
  3. Select Elasticsearch > Configuration to configure Elasticsearch as the destination.
  4. Provide the following information in the Basic information section:
    Field Description
    Protocol Specifies the communication protocol used to establish communication between webMethods API Gateway and Elasticsearch.
    Hostname Specifies the host name or IP address of the machine on which Elasticsearch is running.
    Port Specifies the port where Elasticsearch server runs. The default port number is 9240.
    Index alias Specifies the index alias for Elasticsearch, where certain data is stored. This data stored helps in simplifying operations like searches, filtering, and routing across multiple indices

    The index alias links two or more indices. By linking multiple indices, you can designate one index as the primary write index while others serve as read-only replicas.

    This configuration allows you to define a destination alias. The size or age of the write index grows based on the configured ILM policy. Elasticsearch automatically creates a new write index while marking the previous one as read-only. Through this approach, you can effectively manage index size and age.

    For detailed instructions on configuring ILM policies and implementing index lifecycle management, see https://www.elastic.co/guide/en/elasticsearch/reference/current/aliases.html and https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html.
    Username Specifies the Elasticsearch user ID for authenticating Elasticsearch when webMethods API Gateway communicates with it.
    Password Specifies the password of the Elasticsearch instance to be used for establishing communication between webMethods API Gateway and Elasticsearch.
    Note: You can provide the username and password for the Elasticsearch instances having configured with Basic authentication. You can also provide HTTPS enabled Elasticsearch instance.
  5. Click Test.
    This tests the communication channel between webMethods API Gateway and the configured Elasticsearch.
  6. Click Save to save the specified email configuration value.
    You can click Cancel to revert to the last saved changes or to abandon all the changes if the values are not saved.