You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Clarify metric collection methods for NTH modes
* Explained how Prometheus metric collection differs between IMDS and Queue modes.
* Added a warning about serviceMonitor and podMonitor being Prometheus Operator resources.
* Updated Queue mode to include two methods for metrics collection: using serviceMonitor with the Prometheus Operator or adding the aws-node-termination-handler service in `scrape_configs`.
* Provided an example `scrape_configs` for Prometheus in the Helm chart.
* Updated IMDS mode to mention podMonitor for metrics collection.
Copy file name to clipboardExpand all lines: README.md
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -587,6 +587,28 @@ Available Prometheus metrics:
587
587
|`actions_node`| Number of actions per node (Deprecated: Use actions metric instead)|
588
588
|`events_error`| Number of errors in events processing |
589
589
590
+
The method of collecting Prometheus metrics changes depending on whether NTH is running in IMDS mode or Queue mode.
591
+
592
+
> [!WARNING]
593
+
> Both `serviceMonitor` and `podMonitor` are custom resources provided by the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator) for seamless integration with Kubernetes services and pods. For more details, please refer to [the API reference docs](https://prometheus-operator.dev/docs/api-reference/api/) for the Prometheus Operator.
594
+
595
+
In Queue mode, metrics can be collected in two ways:
596
+
- Use a `serviceMonitor` custom resource with the Prometheus Operator to collect metrics.
597
+
- Alternatively, add aws-node-termination-handler service address statically in Prometheus `scrape_configs`.
598
+
599
+
Example `scrape_configs` in prometheus helm chart:
0 commit comments