ADOT Helm chart for EKS on EC2 metrics and logs to CW Container Insights

This repository contains a Helm chart to provide easy to operate end-to-end AWS Elastic Kubernetes Service (EKS) on AWS Elastic Compute Cloud (EC2) monitoring with AWS Distro for OpenTelemetry(ADOT) collector for metrics and Fluent Bit for logs.

The configuration is ready to collect metrics and logs and send them to CloudWatch Container Insights (CWCI).

Prerequisite

EKS Cluster on EC2
IAM Role
Helm v3+

Get Repository Information

Helm must be installed to use the chart. Please refer to Helm's documentation to get started.

Once Helm is set up properly, add this repo as follows:

$ helm repo add [repo_name] https://TO_BE_RELEASED.github.io/adot-helm-eks-ec2
# You can then run following command to see the chart.
$ helm search repo [repo_name]

Install Chart

$ helm install \
  [RELEASE_NAME] [REPO_NAME]/adot-helm-eks-ec2 \
  --set clusterName=[Cluster_Name] --set awsRegion=[AWS_Region]

Cluster_Name and AWS_Region must be specified with your own EKS cluster and the region. You can find these values by executing following command.

$ kubectl config current-context

[IAM_User_Name]@[Cluster_Name].[AWS_Region].eksctl.io

To verify the installation is successful, you can execute the following command.

$ kubectl get pods --all-namespaces

# If you see four running pods, two for Fluent Bit and two for ADOT Collector as DaemonSets
# within the specified namespaces, they are successfully deployed.  

NAMESPACE                NAME                             READY   STATUS    RESTARTS   AGE
amazon-cloudwatch        fluent-bit-f27cz                 1/1     Running   0          4s
amazon-cloudwatch        fluent-bit-m2mkr                 1/1     Running   0          4s
aws-cloudwatch-metrics   adot-collector-daemonset-7nrst   1/1     Running   0          4s
aws-cloudwatch-metrics   adot-collector-daemonset-x7n8x   1/1     Running   0          4s

Verify whether the metrics and logs were sent to CloudWatch

Open CloudWatch console
Select "Logs -> Log groups" on the left navigation bar.
Check if following four log groups exist (performance log group will take longer than others).

/aws/containerinsights/[CLUSTER_NAME]/application
/aws/containerinsights/[CLUSTER_NAME]/dataplane
/aws/containerinsights/[CLUSTER_NAME]/host
/aws/containerinsights/[CLUSTER_NAME]/performance

Select "Insights -> Container Insights" on the left navigation bar.
Choose Performance monitoring in the drop-down menu on the top-left side.
Choose the levels such as EKS pods, EKS nodes, and EKS namespaces from the drop-down menu in the automated dashboard.
If you observe metrics of the running pods for CPU Utilization, Memory Utilization, etc, the metrics are successfully collected and visualized in Container Insights.

Configuration

See Customizing the Chart Before Installing. To see all configurable options with detailed comments:

$ helm show values [REPO_NAME]/adot-helm-eks-ec2

By changing values in values.yaml, you are able to customize the chart to use your preferred configuration. Following options are some useful configurations that can be applied in this Helm chart.

Optional: Deploy ADOT Collector as Sidecar

Use helm install command from Install Chart to deploy ADOT Collector and Fluent Bit as DaemonSet. However, ADOT Collector can be deployed as Sidecar with the following command.

$ helm install \
  [RELEASE_NAME] [REPO_NAME]/adot-helm-eks-ec2 \
  --set clusterName=[Cluster_Name] --set awsRegion=[AWS_Region] \
  --set adotCollector.daemonSet.enabled=false --set adotCollector.sidecar.enabled=true

The use of --set flag with enabled=true or false can switch on/off the specified deployment mode. The command set enabled=false for ADOT Collector as DaemonSet and 'enabled=true' to deploy ADOT Collector as Sidecar. You can also check whether your applications are successfully deployed by executing the following command.

$ kubectl get pods --all-namespaces

NAMESPACE                NAME                            READY   STATUS    RESTARTS   AGE
adot-sidecar-namespace   adot-sidecar-658dc9ffbb-w9zv2   2/2     Running   0          5m18s
amazon-cloudwatch        fluent-bit-9dcql                1/1     Running   0          5m18s
amazon-cloudwatch        fluent-bit-wqhmd                1/1     Running   0          5m18s

Optional: Deploy ADOT Collector as Deployment and StatefulSet

Deploying ADOT Collector as Deployment mode and StatefulSet mode requires installing ADOT Operator. See OpenTelemetry Operator Helm Chart for detailed explanation.

Uninstall Chart

The following command uninstalls the chart. This will remove all the Kubernetes components associated with the chart and deletes the release.

$ helm uninstall [RELEASE_NAME]

Upgrade Chart

$ helm upgrade [RELEASE_NAME] [REPO_NAME]/adot-helm-eks-ec2

Contributing

See CONTRIBUTING.md.

Contributors

Hyunuk Lim James Park

Further Information

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-setup-logs-FluentBit.html
https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Container-Insights-EKS-otel.html

License

Apache 2.0 License.

Support Plan

Our team plans to fully support the code we plan to release in this repo.

Jacob-Morgan / adot-helm-eks-ec2