Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

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

NameRequired?Description
Region
Access Key IDRequired
Secret Access KeyRequired
Additional ThreadsThe 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 ModeIf enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Domain

NameDescription
ARNThe Amazon Resource Name (ARN) of the Elasticsearch domain.
Automated Snapshot FailureThe 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 HourThe hour of the day, in UTC format, when the service takes a daily automated snapshot of the Elasticsearch domain.
AWS Account IDThe AWS Account ID associated with the domain
Cluster Configuration Creation DateThe creation date of the Elasticsearch cluster configuration.
Cluster Configuration Pending DeletionWhether the Elasticsearch cluster configuration is being deleted.
Cluster Configuration StateThe current state of the Elasticsearch cluster configuration.
Cluster Configuration Update DateThe last updated date of the Elasticsearch cluster configuration.
Cluster Configuration Update VersionThe latest version of the Elasticsearch cluster configuration.
Cluster Index Writes BlockedIndicates 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 GreenIndicates if all index shards are allocated to nodes in the cluster.
Cluster Status RedIndicates if the primary and replica shards of at least one index are not allocated to nodes in a cluster.
Cluster Status YellowIndicates 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 BalanceThe 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.
CreatedThe domain creation status.
Dedicated Master CountTotal number of dedicated master nodes, active and on standby, for the cluster.
Dedicated Master EnabledWhether a dedicated master node is enabled for the domain cluster.
Dedicated Master TypeThe instance type for a dedicated master node.
DeletedThe domain deletion status.
Deleted DocumentsThe 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 DateThe creation date of the Elasticsearch EBS configuration.
EBS Configuration Pending DeletionWhether the Elasticsearch EBS configuration is being deleted.
EBS Configuration StateThe current state of the Elasticsearch EBS configuration.
EBS Configuration Update DateThe last updated date of the Elasticsearch EBS configuration.
EBS Configuration Update VersionThe latest version of the Elasticsearch EBS configuration.
EBS EnabledWhether EBS-based storage is enabled.
EBS Volume I/O (per Second)The IOPD for a Provisioned IOPS EBS volume (SSD).
EBS Volume SizeThe size of an EBS volume.
EBS Volume TypeThe volume type for EBS-based storage.
EndpointsThe domain endpoints used to submit index and search requests.
Free Storage Space (Megabytes)The free space for all data nodes in the cluster.
IDThe unique ID of the Elasticsearch domain.
Instance CountThe number of instances in the domain cluster.
Instance TypeThe 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 NodesA health check for Kibana. A value of 1 indicates normal behavior. A value of 0 indicates that Kibana is inaccessible.
KMS Key ErrorA value of 1 indicates that the KMS customer master key used to encrypt data at rest has been disabled.
KMS Key InaccessibleA 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 BalanceThe 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 NodeA health check for MasterNotDiscovered exceptions. A value of 1 indicates normal behavior. A value of 0 indicates that /_cluster/health/ is failing.
NameThe name of the domain.
Network Configuration Creation DateThe creation date of the Elasticsearch network configuration.
Network Configuration Pending DeletionWhether the Elasticsearch network configuration is being deleted.
Network Configuration StateThe current state of the Elasticsearch network configuration.
Network Configuration Update DateThe last updated date of the Elasticsearch network configuration.
Network Configuration Update Network ConfigurationThe latest version of the Elasticsearch network configuration.
NodesThe number of nodes in the Amazon ES cluster.
ProcessingThe 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.
RegionThe AWS Region this object belongs to.
Searchable DocumentsThe total number of searchable documents across all indices in the cluster.
Snapshot Configuration Creation DateThe creation date of the Elasticsearch snapshot configuration.
Snapshot Configuration Pending DeletionWhether the Elasticsearch snapshot configuration is being deleted.
Snapshot Configuration StateThe current state of the Elasticsearch snapshot configuration.
Snapshot Configuration Update DateThe last updated date of the Elasticsearch snapshot configuration.
Snapshot Configuration Update VersionThe latest version of the Elasticsearch snapshot configuration.
VersionThe Elasticsearch version.
Version Creation DateThe creation date of the Elasticsearch version.
Version Pending DeletionWhether the Elasticsearch version is being deleted.
Version StateThe current state of the Elasticsearch version.
Version Update DateThe last updated date of the Elasticsearch version.
Version Update VersionThe latest version of the Elasticsearch version.
VPC Availability ZonesThe availability zones for the Elasticsearch domain.
VPC IDThe VPC ID for the Elasticsearch domain.
VPC Security GroupsThe security groups for VPC endpoint.
VPC SubnetsThe 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 EnabledWhether zone awareness is enabled for the domain cluster.

Updated 8 months ago

Amazon Elasticsearch


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.