Elasticsearch Integration

Meridian persists/forwards certain data to Elasticsearch.

The following sections describe the configuration possibilities as well as the available features.

Internally, all Elasticsearch integrations use the Jest library to access the Elasticsearch REST interface.

Configuration

The location of the configuration file depends on the feature. For flows, find it in ${OPENNMS_HOME}/etc/org.opennms.features.flows.persistence.elastic.cfg.

You can set the following properties:

Property Description Required Default

elasticUrl

URL(s) to Elasticsearch nodes. Can either point directly to REST API or seed nodes. The format is: <host>:<port>. Comma separate multiple values.

required

http://localhost:9200

elasticIndexStrategy

Index strategy for data, allowed values yearly, monthly, daily, hourly

optional

daily

globalElasticUser

Username to use for all nodes, when X-Pack Security is configured.

optional

-

globalElasticPassword

Password to use for all nodes, when X-Pack Security is configured.

optional

-

ignoreCertificates

Set this to ignore HTTPS/SSL/TLS certificates.

optional

false

defaultMaxTotalConnectionPerRoute

Sets the default maximum connections per route. If a negative value is given, the value is ignored.

optional

<available processors> * 2

maxTotalConnection

Sets the default maximum total connections. If a negative value is given, the value is ignored.

optional

<max connections per route> * 3

nodeDiscovery

Enable/disable node discovery. Valid values are true|false.

optional

false

nodeDiscoveryFrequency

Defines the frequency, in seconds, in which the nodes are re-discovered. Must be set, if discovery=true

optional

-

proxy

Defines a proxy server for communicating with your Elasticsearch cluster. Must be a valid URL.

optional

-

httpCompression

Defines that HTTP compression is enabled.

optional

-

retries

Defines how many times an operation is retried before considered failed.

optional

0

retryCooldown

Defines the cool-down in ms to wait before retrying. Value of 0 means no cool-down. Value must be >= 0.

optional

500

connTimeout

Defines the connection timeout in ms.

optional

5000

readTimeout

Defines the read timeout in ms.

optional

30000

bulkRetryCount

Defines the number of retries performed before a bulk operation is considered failed. When bulk operations fail, only the failed items are retried.

optional

5

settings.index.number_of_shards

The number of primary shards that an index should have. Refer to Elasticsearch Reference → Index Modules for more details.

optional

-

settings.index.number_of_replicas

The number of replicas each primary shard has. Refer to Elasticsearch Reference → Index Modules for more details.

optional

-

settings.index.refresh_interval

How often to perform a refresh operation, which makes recent changes to the index visible to search. Refer to Elasticsearch Reference → Index Modules for more details.

optional

-

settings.index.routing_partition_size

The number of shards a custom routing valuce can go to. Refer to Elasticsearch Reference → Index Modules for more details.

optional

-

indexPrefix

Prefix is prepended to the index and template names. Used in cases where you want to share the same Elasticsearch cluster with many Meridian instances.

optional

-

If a configuration management tool is used, the properties file can be created and is used as startup configuration
If credentials are provided, preemptive authorization is used for all defined Elasticsearch nodes.
Configuration Example to Access Elasticsearch
elasticUrl=http://elastic:9200
elasticIndexStrategy=daily
globalElasticUser=elastic
globalElasticPassword=changeme

Credentials

It is possible to define credentials for each Elasticsearch node individually. Credentials for each node must be stored in ${OPENNMS_HOME}/etc/elastic-credentials.xml.

Custom credentials
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<elastic-credentials>
    <credentials url="http://localhost:9200" username="ulf" password="ulf" />
    <credentials url="https://10.10.0.1:9333" username="ulf" password="flu" />
</elastic-credentials>
Credentials are globally defined and will be used by each feature.