Skip to content

Add metrics documentation #491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 14, 2021
Merged

Add metrics documentation #491

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fe14ae
Add metrics documentation
aidandj Sep 11, 2021
1f017bc
Move metrics docs to main readme
aidandj Sep 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down