- Home
- Work-in-Progress Documentation
- Reference Guide
- Unravel Properties reference
- ELK (Elasticsearch, Logstash, Kibana)
ELK (Elasticsearch, Logstash, Kibana)
Elasticsearch
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.elk.es.monitor.enabled Enable/disable Elasticsearch cluster monitoring. | Required | boolean | False |
com.unraveldata.elk.es.clusters Specify clusters for Elasticsearch monitoring. Comma-separated in case of multiple clusters. | Required | CSL | - |
com.unraveldata.elk.es.rest.url.<cluster_name> URL of the REST API for the cluster. Comma-separated in case of multiple URLs. Provide the URL in the following format: <elasticsearch_cluster_rest_endpoint>:<port> | Required | CSL | - |
com.unraveldata.elk.es.rest.endpoints.<cluster_name> Rest API endpoints. Comma-separated in case of multiple endpoints. | Required | CSL | /_cluster/health?level=indices,/_cluster/stats,/_nodes/stats,/_stats,/_cat/nodes?format=json&amp;amp;h=,/_cat/indices?format=json&amp;amp;h= |
com.unraveldata.elk.es.rest.user.<cluster_name> REST API user name. | Optional | string | - |
com.unraveldata.elk.es.rest.pwd.<cluster_name> REST API password. This password should be encrypted. | Optional | string | - |
com.unraveldata.elk.es.rest.ssl.enabled.<cluster_name> Enable/Disable SSL | Optional | boolean | false |
com.unraveldata.elk.es.metric.poll.interval Intervals to poll Elasticsearch metrics. | Required | sec | 90 |
com.unraveldata.elk.es.http.poll.parallelism Number of cores for parallelism. | Required | int | 2 |
com.unraveldata.elk.es.http.conn.timeout Time interval before HTTP connection is timeout. | Required | sec | 20 |
com.unraveldata.elk.es.http.read.timeout Time interval before HTTP read is timeout. | Required | sec | 120 |
com.unraveldata.elk.es.metrics.json Path to JSON configuration file. | Required | string | /usr/local/unravel/etc/elk_es_metrics.json |
Example:
Logstash
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.elk.logstash.enable Enable/Disable Logstash monitoring. | Required | boolean | false |
com.unraveldata.elk.logstash.poll_frequency_sec Poll interval for Logstash monitoring. | Required | sec | 90 |
com.unraveldata.elk.logstash.http.conn.timeout Time interval before HTTP connection is timed out. | Required | sec | 10 |
com.unraveldata.elk.logstash.http.read.timeout Time interval before HTTP read is timed out. | Required | sec | 60 |
com.unraveldata.elk.logstash.instance Comma-separated aliases for Logstash instances. For example: com.unraveldata.elk.logstash.instance=LOG,LOG1,LOG2,LOG3 | Required | CSL | - |
com.unraveldata.elk.logstash.<alias>.host Hostname of the Logstash instance. For example: com.unraveldata.elk.logstash.LOG.host=abc.xyz.com | Required | string | - |
com.unraveldata.elk.logstash.<alias>.port Port used by the Logstash instance for the hostname. For example: com.unraveldata.elk.logstash.LOG.port=9600 | Required | int | - |
Example:
Kibana
Property/Description | Set by user | Unit | Default |
|---|---|---|---|
com.unraveldata.elk.kibana.monitor.enabled Enable/Disable Kibana monitoring. | Required | boolean | false |
com.unraveldata.elk.kibana.instance Instance name. Comma-separated list in case of multiple instances. | Required | CSL | - |
com.unraveldata.elk.kibana.rest.url.kibana The REST API URL of the Kibana instance. Comma-separated in case of multiple URL values. Provide the URL in the following format: <elasticsearch_cluster_rest_endpoint>:<port> | Required | URL | - |
com.unraveldata.elk.kibana.rest.endpoints.kibana Rest API endpoints. Comma-separated in case of multiple endpoints. For example: com.unraveldata.elk.kibana.rest.endpoints.kibana=/api/status | Required | CSL | - |
com.unraveldata.elk.kibana.rest.user.kibana REST API username | Optional | string | - |
com.unraveldata.elk.kibana.rest.pwd.kibana REST API password. The password should be encrypted. | Optional | string | - |
com.unraveldata.elk.kibana.rest.ssl.enabled.kibana Enable/Disable SSL authentication. | Optional | boolean | false |
com.unraveldata.elk.kibana.metric.poll.interval Intervals to poll the kibana metrics. | Required | sec | 90 |
com.unraveldata.elk.kibana.http.poll.parallelism Number of cores for parallelism. | Required | int | 2 |
com.unraveldata.elk.kibana.http.conn.timeout Time interval before HTTP connection is timed out. | Required | sec | 20 |
com.unraveldata.elk.kibana.http.read.timeout Time interval before HTTP read is timed out. | Required | sec | 120 |
com.unraveldata.elk.kibana.metrics.json Path to JSON configuration file. | Required | string | /usr/local/unravel/etc/elk_kibana_metrics.json |
Example:
