Integrate Software AG Products Using Digital Event Services : Using Digital Event Services to Communicate between Software AG Products : Administering Digital Event Services : Configuring Services : Configuring Digital Event Persistence Services for Elasticsearch
Configuring Digital Event Persistence Services for Elasticsearch
With Digital Event Persistence services, you can store events to an Elasticsearch 2.3.2 storage engine.
Note:  
Digital Event Persistence does not support Elasticsearch clusters with Shield enabled.
When using Elasticsearch, you can persist events using Secure Sockets Layer (SSL). For more information about persisting events over SSL to an Elasticsearch instance, see Configuring SSL for Digital Event Persistence.
You can either specify static values in the configuration fields, or use dynamic service configuration to persist events to different storage destinations based on event data. You can specify dynamic service configuration variables in the Cluster URI(s), Cluster Name, and Index Name fields.
To specify a variable, start and end your variable name with $. For example, to persist events in an Elasticsearch index depending on a customer's name, specify $customer_name$ in the Index Name field . As a result, Digital Event Persistence stores events that are related to a customer with the name john_smith in an index with the same name.
For more information about adding dynamic service configuration to a digital event type, see Adding Dynamic Service Information to Digital Event Types.
To create Digital Event Services (DES) services of type Digital Event Persistence for Elasticsearch
1. In Command Central, navigate to Environments > Instances > All > instance_name > Digital Event Services > Configuration.
2. Select Event Persistence from the drop-down menu.
3. Click , and then select Elasticsearch 2.3.2 for the service type.
4. Specify values for the following fields:
Parameter
Description
Service Name
Required. The name of the new service. Specify a unique service name that starts with a character. Valid separator characters are periods (.) and dashes (-). The service name is not case-sensitive.
Note:  
You cannot rename an existing service. If you want to modify the service name, you must delete the existing service and create a new one with a different name.
Service Description
Optional. A description of the new service.
Cluster URI(s)
Required. Supports dynamic service configuration. A comma-separated list of servers in an Elasticsearch cluster to which the Digital Event Persistence service can connect. If the initial host is unavailable, Digital Event Persistence attempts to connect to the other servers in the cluster. Specify the URI of the servers in the Elasticsearch cluster as follows: elasticsearch://host:port, where host is the host name of the server, and port is the port on which the server listens for incoming requests.
The default value is elasticsearch://localhost:9300.
You can use dynamic service configuration to specify all or part of the name of the cluster, for example: elasticsearch://$host$:port.
Cluster Name
Required. Supports dynamic service configuration. The name of the Elasticsearch cluster.
You can use dynamic service configuration to specify all or part of the name of a cluster, for example: $cluster_name$.
Index Name
Required. Supports dynamic service configuration. The name of the index in which the events are stored.
You can use dynamic service configuration to specify all or part of the name of the index, for example: $index_name$.
Note:  
Elasticsearch supports only lowercase index names.
Core threads
Required. The number of threads to keep in the pool at all times. The default value is 5.
Maximum Threads
Required. The maximum number of threads on which to run bulk indexing tasks. The default value is 10.
Queue Size
Required. The size of the thread pools work queue. A value of 0 indicates an unlimited queue. A value other than 0 sets the number of pending bulk indexing tasks that can be queued before the processing thread blocks. The default value is 10.
Keep Alive(sec)
Required. The time limit in seconds for which threads remain idle before being terminated. The default value is 5.
Pre-Start Core Threads
Required. Whether the core threads start immediately rather than as work is pulled from the queue. Values are true or false (default).
Batch Size
Required. The number of events that are written to Elasticsearch with a single write operation. The default value is 1000.
Note:  
If the Elasticsearch service queues a batch of events before the batch write timer expires, the service immediately persists all queued events to Elasticsearch.
Batch Write Timer(sec)
Required. Batch write frequency in seconds. The default value is 15.
Note:  
If the batch write timer expires before the Elasticsearch service queues a batch of events, all currently queued events are persisted to Elasticsearch.
Enable SSL
Required. Enable or disable SSL for both REST and TCP ports. The default value is false.
For more information about how to configure SSL for Digital Event Persistence, see Configuring SSL for Digital Event Persistence.
Key Store
Optional. Specify the absolute file path to the Java KeyStore (JKS) file as follows: folder/sub_folder/filename.
Trust Store
Optional. Specify the absolute file path to the JKS truststore file as follows: folder/sub_folder/filename.
5. Optionally, click Test to verify that your configuration is valid.
Note:  
When using dynamic service configuration, it is not possible to successfully connect to Elasticsearch using the Test button. However, field validation works as expected.
6. Save your changes.
Copyright © 2017 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback