The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Enable Node Problem Detector (NPD), the diagnostic tool, to identify and report problems that may impact node performance.
Exec
node-problem-detector agent enabled This command enables NPD with default configurations and built-in monitoring rules for detecting well-known issues. By default NPD is disabled.
When the NPD is enabled, it is easy to monitor and manage the health of all nodes on the cluster.
Configure the Node Problem Detector (NPD) exporter definitions.
node-problem-detector agent exporters { k8s apiserver-uri-override string | prometheus port port_number }
no node-problem-detector agent exporters { k8s apiserver-uri-override string | prometheus port port_number }
| k8s apiserver-uri-override string |
Configure the custom URI that is used to connect to the Kubernetes API server. The custom URI can be an alphanumerical string. |
| prometheus port port_number |
Specify the port number of Prometheus exporter. Port number is an integer from 0 to 65535. |
NPD functionality is disabled.
Global configuration
| Release | Modification |
|---|---|
| 2025.02.1 |
This command was introduced. |
Use this command to enable the NPD tool to monitor the health of nodes within the cluster.
This example shows how to configure the NPD in the Kubernetes environment.
node-problem-detector agent exporters k8s apiserver-uri-override http://example:8443Configure the Node Problem Detector (NPD) monitor definitions.
node-problem-detector agent monitors monitor_name { custom | filelog | journald | ksmg }
no node-problem-detector agent monitors
| monitors monitor_name |
Configure the monitor name that is used as the source value for reporting the node problems. |
| custom |
Specify to use custom plugin. |
|
filelog |
Specify to use filelog plugin. |
|
journald |
Specify to use journald plugin. |
|
ksmg |
Specify to use ksmg plugin. |
NPD functionality is disabled.
Global configuration
| Release | Modification |
|---|---|
| 2025.02.1 |
This command was introduced. |
Use this command to enable the NPD tool to monitor the health of nodes within the cluster.
This example shows how to configure the NPD monitor in the Kubernetes environment.
node-problem-detector agent monitors testConfigure the K8s exporter to enable communication with the Kubernetes API server for monitoring resources.
node-problem-detector agent exporters k8s apiserver-uri-override uri_string
| apiserver-uri-overrideuri_string |
This keyword allows you to specify a custom URI for connecting to the API server. This URI can include the IP address, port, and other options needed for the connection. If you are managing multiple clusters and need NPD to export problems to a centralized API server, this override is essential. |
None
Global configuration mode
| Release | Modification |
|---|---|
| Release 2025.02.1 |
This command was introduced. |
This configuration must be performed to enable communication with the Kubernetes API server.
The following example shows how to configure Kubernetes API server IP address and port for K8s to communicate with.
node-problem-detector agent exporters k8s apiserver-override=https://209.165.200.227:8080Configure the Node Problem Detector to act as an agent that exports node health metrics to Prometheus.
node-problem-detector agent exporters prometheus port port_number
| portport_number |
Specify the port to bind the Prometheus scrape endpoint. The default value of port number is 20257. Use 0 to disable. |
None
Global configuration mode
| Release | Modification |
|---|---|
| Release 2025.02.1 |
This command was introduced. |
This command is used to set up Node Problem Detector to work as an agent that collects node health data and exports it to Prometheus for monitoring and alerting purposes. It is an essential part of maintaining the health and reliability of Kubernetes clusters in production environments.
The following example shows the configuration of port to bind the Prometheus scrape endpoint.
node-problem-detector agent exporters prometheus port 8080
Feedback