mirror of
https://github.com/storytold/terraform-aws-observability-accelerator.git
synced 2026-10-17 00:23:17 +00:00
Rodrigue Koffi
c135e90854
* Add custom metrics collection docs * fixup! Add custom metrics collection docs * Add screenshot
58 lines
2.8 KiB
Markdown
58 lines
2.8 KiB
Markdown
# AWS Observability Accelerator for Terraform
|
|
|
|
Welcome to the AWS Observability Accelerator for Terraform!
|
|
|
|
The AWS Observability accelerator is a set of Terraform modules to help you
|
|
configure Observability for your container workloads and environemnts with AWS
|
|
Observability services. This project proposes a core module to bootstrap
|
|
your Amazon EKS cluster with the AWS Distro for OpenTelemetry (ADOT) Operator for EKS,
|
|
Amazon Managed Service for Prometheus, Amazon Managed Grafana.
|
|
|
|
Additionally we have a set of workload modules to leverage curated ADOT
|
|
collector configurations, Grafana dashboards, Prometheus recording rules and alerts.
|
|
|
|
<img width="1501" alt="image" src="https://user-images.githubusercontent.com/10175027/193913383-94aaf4e2-58c6-4779-935b-e40528e86c03.png">
|
|
|
|
## Getting started
|
|
|
|
This project provides a set of Terraform modules to enable metrics and traces collection,
|
|
dashboards and alerts for monitoring:
|
|
|
|
- Amazon EKS clusters infrastructure
|
|
- NGINX workloads (running on Amazon EKS)
|
|
- Java/JMX workloads (running on Amazon EKS)
|
|
- Amazon Managed Service for Prometheus workspaces with Amazon CloudWatch
|
|
|
|
These modules can be directly configured in your exisiting Terraform configurations or ready
|
|
to be deployed in our packaged
|
|
[examples](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples)
|
|
|
|
We have supporting examples for quick setup such as:
|
|
|
|
- Creating an empty Amazon EKS cluster and a VPC
|
|
- Creating and configure an Amazon Managed Grafana workspace with SSO
|
|
|
|
## Motivation
|
|
|
|
To gain deep visibility into your workloads and environements, AWS proposes a
|
|
set of secure, scalabale, highly available, production-grade managed open
|
|
source services such as Amazon Managed Service for Prometheus, Amazon Managed
|
|
Grafana and Amazon OpenSearch.
|
|
|
|
AWS customers have asked for best-practices and guidance to collect metrics, logs
|
|
and traces from their containerized applications and microservices with ease of
|
|
deployment. Customers can use the AWS Observability Accelerator to configure their
|
|
metrics collection, leveraging [AWS Distro for OpenTelemetry](https://aws-otel.github.io/),
|
|
to have opinionated dashoards and alerts available in only minutes.
|
|
|
|
|
|
## Support & Feedback
|
|
|
|
AWS Observability Accelerator for Terraform is maintained by AWS Solution Architects.
|
|
It is not part of an AWS service and support is provided best-effort by the
|
|
AWS Observability Accelerator community.
|
|
|
|
To post feedback, submit feature ideas, or report bugs, please use the [issues](https://github.com/aws-observability/terraform-aws-observability-accelerator/issues) section of this GitHub repo.
|
|
|
|
If you are interested in contributing, see the [contribution guide](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/CONTRIBUTING.md).
|