Amazon Elasticsearch

Least Privileged User

Navigate to the AWS console and create an IAM user with programmatic access. The user will need the following permissions. You can create a policy specifically for these permissions and apply the permissions to the user.

For more information, see: High Level AWS Source Configuration

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "cloudwatch:GetMetricData",
        "es:ESHttpGet",
        "es:ListTags",
        "es:DescribeElasticsearchDomainConfig",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics",
        "es:ESHttpHead",
        "es:ListDomainNames",
        "cloudwatch:DescribeAlarmHistory",
        "es:DescribeElasticsearchDomain",
        "cloudwatch:DescribeAlarmsForMetric",
        "cloudwatch:DescribeAlarms",
        "es:DescribeElasticsearchDomains"
      ],
      "Resource": "*"
    }
  ]
}

Connection Parameters

Name	Required?	Description
Region
Access Key ID	Required
Secret Access Key	Required
Additional Threads		The number of additional threads allowed to be utilized during collection.
Request Timeout (seconds)		The number of seconds to allow for the API to return a response.
Collect CloudWatch Metrics
CloudWatch Historic Mode		If enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Domain

Name	Description
ARN	The Amazon Resource Name (ARN) of the Elasticsearch domain.
Automated Snapshot Failure	The number of failed automated snapshots for the cluster. A value of 1 indicates that no automated snapshot was taken for the domain in the previous 36 hours.
Automated Snapshot Start Hour	The hour of the day, in UTC format, when the service takes a daily automated snapshot of the Elasticsearch domain.
AWS Account ID	The AWS Account ID associated with the domain
Cluster Configuration Creation Date	The creation date of the Elasticsearch cluster configuration.
Cluster Configuration Pending Deletion	Whether the Elasticsearch cluster configuration is being deleted.
Cluster Configuration State	The current state of the Elasticsearch cluster configuration.
Cluster Configuration Update Date	The last updated date of the Elasticsearch cluster configuration.
Cluster Configuration Update Version	The latest version of the Elasticsearch cluster configuration.
Cluster Index Writes Blocked	Indicates whether your cluster is accepting or blocking incoming write requests. A value of 0 means that the cluster is accepting requests. A value of 1 means that it is blocking requests.
Cluster Status Green	Indicates if all index shards are allocated to nodes in the cluster.
Cluster Status Red	Indicates if the primary and replica shards of at least one index are not allocated to nodes in a cluster.
Cluster Status Yellow	Indicates if the primary shards for all indices are allocated to nodes in a cluster, but the replica shards for at least one index are not.
Cluster Used Space (Megabytes)	The total used space for a cluster.
CPU Credit Balance	The remaining CPU credits available for data nodes in the cluster. A CPU credit provides the performance of a full CPU core for one minute.
CPU Utilization (%)	The maximum percentage of CPU resources used for data nodes in the cluster.
Created	The domain creation status.
Dedicated Master Count	Total number of dedicated master nodes, active and on standby, for the cluster.
Dedicated Master Enabled	Whether a dedicated master node is enabled for the domain cluster.
Dedicated Master Type	The instance type for a dedicated master node.
Deleted	The domain deletion status.
Deleted Documents	The total number of deleted documents across all indices in the cluster.
Disk Queue Depth (Requests)	The number of pending input and output (I/O) requests for an EBS volume.
EBS Configuration Creation Date	The creation date of the Elasticsearch EBS configuration.
EBS Configuration Pending Deletion	Whether the Elasticsearch EBS configuration is being deleted.
EBS Configuration State	The current state of the Elasticsearch EBS configuration.
EBS Configuration Update Date	The last updated date of the Elasticsearch EBS configuration.
EBS Configuration Update Version	The latest version of the Elasticsearch EBS configuration.
EBS Enabled	Whether EBS-based storage is enabled.
EBS Volume I/O (per Second)	The IOPD for a Provisioned IOPS EBS volume (SSD).
EBS Volume Size	The size of an EBS volume.
EBS Volume Type	The volume type for EBS-based storage.
Endpoints	The domain endpoints used to submit index and search requests.
Free Storage Space (Megabytes)	The free space for all data nodes in the cluster.
ID	The unique ID of the Elasticsearch domain.
Instance Count	The number of instances in the domain cluster.
Instance Type	The instance type for the Elasticsearch cluster.
JVM Memory Pressure (%)	The maximum percentage of the Java heap used for all data nodes in the cluster.
Kibana Healthy Nodes	A health check for Kibana. A value of 1 indicates normal behavior. A value of 0 indicates that Kibana is inaccessible.
KMS Key Error	A value of 1 indicates that the KMS customer master key used to encrypt data at rest has been disabled.
KMS Key Inaccessible	A value of 1 indicates that the KMS customer master key used to encrypt data at rest has been deleted or revoked its grants to Amazon ES.
Master CPU Credit Balance	The remaining CPU credits available for dedicated master nodes in the cluster. A CPU credit provides the performance of a full CPU core for one minute.
Master CPU Utilization (%)	The maximum percentage of CPU resources used by the dedicated master nodes.
Master JVM Memory Pressure (%)	The maximum percentage of the Java heap used for all dedicated master nodes in the cluster.
Master Reachable From Node	A health check for MasterNotDiscovered exceptions. A value of 1 indicates normal behavior. A value of 0 indicates that /_cluster/health/ is failing.
Name	The name of the domain.
Network Configuration Creation Date	The creation date of the Elasticsearch network configuration.
Network Configuration Pending Deletion	Whether the Elasticsearch network configuration is being deleted.
Network Configuration State	The current state of the Elasticsearch network configuration.
Network Configuration Update Date	The last updated date of the Elasticsearch network configuration.
Network Configuration Update Network Configuration	The latest version of the Elasticsearch network configuration.
Nodes	The number of nodes in the Amazon ES cluster.
Processing	The domain configuration status.
Read IO Rate (Operations per Second)	The input and output (I/O) operations rate for read operations on EBS volumes.
Read Latency (Seconds)	The latency for read operations on EBS volumes.
Read Throughput (Bytes per Second)	The data throughput rate for read operations on EBS volumes.
Region	The AWS Region this object belongs to.
Searchable Documents	The total number of searchable documents across all indices in the cluster.
Snapshot Configuration Creation Date	The creation date of the Elasticsearch snapshot configuration.
Snapshot Configuration Pending Deletion	Whether the Elasticsearch snapshot configuration is being deleted.
Snapshot Configuration State	The current state of the Elasticsearch snapshot configuration.
Snapshot Configuration Update Date	The last updated date of the Elasticsearch snapshot configuration.
Snapshot Configuration Update Version	The latest version of the Elasticsearch snapshot configuration.
Version	The Elasticsearch version.
Version Creation Date	The creation date of the Elasticsearch version.
Version Pending Deletion	Whether the Elasticsearch version is being deleted.
Version State	The current state of the Elasticsearch version.
Version Update Date	The last updated date of the Elasticsearch version.
Version Update Version	The latest version of the Elasticsearch version.
VPC Availability Zones	The availability zones for the Elasticsearch domain.
VPC ID	The VPC ID for the Elasticsearch domain.
VPC Security Groups	The security groups for VPC endpoint.
VPC Subnets	The subnets for VPC endpoint.
Write IO Rate (Operations per Second)	The input and output (I/O) operations rate for write operations on EBS volumes.
Write Latency (Seconds)	The latency for write operations on EBS volumes.
Write Throughput (Bytes per Second)	The data throughput rate for write operations on EBS volumes.
Zone Awareness Enabled	Whether zone awareness is enabled for the domain cluster.