Skip to main content

Integration

Pulse for Elasticsearch​

Both the platform and the agent offer full support for all Elasticsearch flavors and deployment locations.

Pulse Agent Configuration​

If you haven't done so yet, follow the instructions under the Pulse Agent integration section for installation and basic configuration instructions.

The clusters section of the configuration file should point to the cluster hosts or a load balancer pointing to them. Multiple hosts are supported (separated by comma), as well as specifying username and password for protected clusters. See below for best practices for creating that user.

clusters:
  - type: elasticsearch
    hosts: http://10.50.2.1:9200,http://10.50.2.2:9200,http://10.50.2.3:9200
    username: pulse-monitoring-collector
    password: pwd

Setting Up A Dedicated Monitoring User​

It is highly recommended to provide the agent with credentials for a dedicated user with just the required permissions. This is possible to do via API (see example below or the official documentation) or using Kibana. The built-in role to use is called remote_monitoring_collector. You'll also need to add a new role to support monitoring of snapshots and kibana monitoring.

PUT _security/role/pulse-additional-priviliges
{
    "cluster" : [
      "monitor_snapshot"
    ],
    "applications": [
   {
     "application": "kibana-.kibana",
     "privileges": [
       "feature_stackAlerts.read"
     ],
     "resources": [
       "*"
     ]
   }
 ]
}

with Kibana 7.13 and below, remove the "applications" part.

POST /_security/user/pulse-monitoring-collector
{
  "password" : "L0ng-r4nd0m-p@ssw0rd",
  "roles" : [ "remote_monitoring_collector","pulse-additional-priviliges"],
  "full_name" : "Cluster metrics collector for Pulse",
  "email" : "support@bigdataboutique.com"
}