AWS EKS Observability Toolkit
The AWS EKS Observability Toolkit is a workflow node. Its tools include List EKS Clusters, Describe Cluster, List Node Groups, Describe Node Group, plus 7 more listed below. Create a connection before you use any of these tools. Type @ in a field when the value should come from an earlier step.
Authentication
Create an AWS connection before you use any of these tools. Every tool in this toolkit is read-only.
Set up credentials in AWS
- Open IAM, Users and select or create a user.
- Open Security credentials, then Create access key, and copy the Access Key ID and Secret Access Key.
- Open Permissions and attach AmazonEKSReadOnlyAccess, CloudWatchReadOnlyAccess, and AmazonEC2ReadOnlyAccess.
- Note the AWS region where the EKS clusters run.
Connect the credentials in EKB
- On the first AWS EKS Observability node, open Connection.
- Click + New.
- Enter a Connection Name.
- Paste the Access Key ID and Secret Access Key.
- Choose a Region. The default is
us-east-1. Use the region from AWS. - Select the new connection in Select saved connection.
Enter token manually saves the same credentials on that node instead of a saved connection.
Tools
List EKS Clusters
List all EKS clusters in the configured AWS region.
Describe Cluster
Get the endpoint, version, and status of an EKS cluster.
| Field | Required | Description |
|---|---|---|
| Cluster Name | Yes | EKS cluster name. Type @ to select a variable. |
List Node Groups
List managed node groups for an EKS cluster.
| Field | Required | Description |
|---|---|---|
| Cluster Name | Yes | EKS cluster name. Type @ to select a variable. |
Describe Node Group
Get instance types, scaling, and health for a node group.
| Field | Required | Description |
|---|---|---|
| Cluster Name | Yes | EKS cluster name. Type @ to select a variable. |
| Node Group Name | Yes | Node group name. Type @ to select a variable. |
Filter Log Events
Search a CloudWatch log group with a filter pattern and a time range.
| Field | Required | Description |
|---|---|---|
| Log Group Name | Yes | CloudWatch Log Group name. Type @ to select a variable. |
| Filter Pattern | No | CloudWatch Logs filter pattern (e.g. '( $.level = "ERROR" )'). Empty for all events. Type @ to select a variable. |
| Start Time Hours Ago | No | How many hours back to search (default: 1). Type @ to select a variable. |
| Limit | No | Max log events to return (1-10000). Type @ to select a variable. |
Logs Insights Query
Run a CloudWatch Logs Insights query against a log group.
| Field | Required | Description |
|---|---|---|
| Log Group Name | Yes | CloudWatch Log Group name. Type @ to select a variable. |
| Query String | Yes | CloudWatch Logs Insights query (e.g. 'fields @timestamp, @message / filter @message like /ERROR/ / sort @timestamp desc / limit 20'). Type @ to select a variable. |
| Start Time Hours Ago | No | How many hours back to query (default: 1). Type @ to select a variable. |
| Limit | No | Max results to return. Type @ to select a variable. |
Get Log Events
Read log events from a CloudWatch log stream.
| Field | Required | Description |
|---|---|---|
| Log Group Name | Yes | CloudWatch Log Group name. Type @ to select a variable. |
| Log Stream Name | Yes | CloudWatch Log Stream name. Type @ to select a variable. |
| Start Time Hours Ago | No | How many hours back to read (default: 1). Type @ to select a variable. |
| Limit | No | Max log events to return (1-10000). Type @ to select a variable. |
Get Metric Statistics
Read CloudWatch metric statistics for a cluster, node, or pod.
| Field | Required | Description |
|---|---|---|
| Namespace | Yes | CloudWatch namespace (e.g. 'AWS/EKS', 'AWS/EC2', 'ContainerInsights'). Type @ to select a variable. |
| Metric Name | Yes | Metric name (e.g. 'CPUUtilization', 'pod_count'). Type @ to select a variable. |
| Dimensions | No | Dimension filters as key=value pairs separated by commas (e.g. 'ClusterName=my-cluster,Namespace=kube-system'). Type @ to select a variable. |
| Start Time Hours Ago | No | How many hours back (default: 24). Type @ to select a variable. |
| Period Seconds | No | Aggregation period in seconds (default: 3600 = 1 hour). Type @ to select a variable. |
| Statistics | No | Statistics to return: Average, Sum, Minimum, Maximum, SampleCount (comma-separated). Type @ to select a variable. |
List Metrics
List CloudWatch metrics in a namespace.
| Field | Required | Description |
|---|---|---|
| Namespace | Yes | CloudWatch namespace (e.g. 'AWS/EKS', 'AWS/EC2'). Type @ to select a variable. |
| Dimensions | No | Dimension name filters (comma-separated, e.g. 'ClusterName,Namespace'). Type @ to select a variable. |
Describe Instances
Read state, type, and addresses for EC2 worker instances.
| Field | Required | Description |
|---|---|---|
| Instance Ids | No | Comma-separated instance IDs (e.g. 'i-0abc123,i-0def456'). Leave empty for all instances. Type @ to select a variable. |
| Max Results | No | Max results to return. Type @ to select a variable. |
Instance Status
Read EC2 system and instance status checks.
| Field | Required | Description |
|---|---|---|
| Instance Ids | No | Comma-separated instance IDs. Leave empty for all instances. Type @ to select a variable. |
Related
See all integrations on the toolkits overview.