From 1fe14ae358e143c81b6aebc68be7507b849ef1d6 Mon Sep 17 00:00:00 2001 From: Aidan Jensen Date: Sat, 11 Sep 2021 07:42:48 -0700 Subject: [PATCH 1/2] Add metrics documentation Signed-off-by: Aidan Jensen --- docs/metrics.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/metrics.md diff --git a/docs/metrics.md b/docs/metrics.md new file mode 100644 index 00000000..40e45252 --- /dev/null +++ b/docs/metrics.md @@ -0,0 +1,10 @@ +# Metrics + +## Prometheus Metrics + +Available Prometheus metrics: + +| Metric name | Description | +| -------------- | ------------------------------------- | +| `actions_node` | Number of actions per node | +| `events_error` | Number of errors in events processing | From 1f017bc6bf07507c5fd25c766d1462b9b7e99107 Mon Sep 17 00:00:00 2001 From: Aidan Jensen Date: Mon, 13 Sep 2021 15:32:04 -0700 Subject: [PATCH 2/2] Move metrics docs to main readme --- README.md | 29 +++++++++++++++++++---------- docs/metrics.md | 10 ---------- 2 files changed, 19 insertions(+), 20 deletions(-) delete mode 100644 docs/metrics.md diff --git a/README.md b/README.md index 32445ddf..1ebf70b7 100644 --- a/README.md +++ b/README.md @@ -59,16 +59,16 @@ You can run the termination handler on any Kubernetes cluster running on AWS, in - Unit & Integration Tests ## Which one should I use? -Feature |IMDS Processor | Queue Processor -:---:|:---:|:---: -K8s DaemonSet | ✅ | ❌ -K8s Deployment | ❌ | ✅ -Spot Instance Interruptions (ITN) | ✅ | ✅ -Scheduled Events | ✅ | ✅ -EC2 Instance Rebalance Recommendation | ✅ | ✅ -ASG Lifecycle Hooks | ❌ | ✅ -EC2 Status Changes | ❌ | ✅ -Setup Required | ❌ | ✅ +| Feature | IMDS Processor | Queue Processor | +| :-----------------------------------: | :------------: | :-------------: | +| K8s DaemonSet | ✅ | ❌ | +| K8s Deployment | ❌ | ✅ | +| Spot Instance Interruptions (ITN) | ✅ | ✅ | +| Scheduled Events | ✅ | ✅ | +| EC2 Instance Rebalance Recommendation | ✅ | ✅ | +| ASG Lifecycle Hooks | ❌ | ✅ | +| EC2 Status Changes | ❌ | ✅ | +| Setup Required | ❌ | ✅ | ## Installation and Configuration @@ -443,6 +443,15 @@ The termination handler relies on the following metadata endpoints to function p ## Building For build instructions please consult [BUILD.md](./BUILD.md). +## Metrics +Available Prometheus metrics: + +| Metric name | Description | +| -------------- | ------------------------------------- | +| `actions_node` | Number of actions per node | +| `events_error` | Number of errors in events processing | + + ## Communication * If you've run into a bug or have a new feature request, please open an [issue](https://github.com/aws/aws-node-termination-handler/issues/new). * You can also chat with us in the [Kubernetes Slack](https://kubernetes.slack.com) in the `#provider-aws` channel diff --git a/docs/metrics.md b/docs/metrics.md deleted file mode 100644 index 40e45252..00000000 --- a/docs/metrics.md +++ /dev/null @@ -1,10 +0,0 @@ -# Metrics - -## Prometheus Metrics - -Available Prometheus metrics: - -| Metric name | Description | -| -------------- | ------------------------------------- | -| `actions_node` | Number of actions per node | -| `events_error` | Number of errors in events processing |