node-feature-discovery/docs/deployment/metrics.md

---
title: "Metrics"
layout: default
sort: 6
---

# Metrics

Metrics are configured to be exposed using [prometheus operator](https://github.com/prometheus-operator/prometheus-operator)
API's by default. If you want to expose metrics using the prometheus operator
API's you need to install the prometheus operator in your cluster.
By default NFD Master and Worker expose metrics on port 8081.

The exposed metrics are

| Metric                                                   | Type      | Description                                                                |
| -------------------------------------------------------- | --------- | -------------------------------------------------------------------------- |
| `nfd_master_build_info`                                  | Gauge     | Version from which nfd-master was built                                    |
| `nfd_worker_build_info`                                  | Gauge     | Version from which nfd-worker was built                                    |
| `nfd_gc_build_info`                                      | Gauge     | Version from which nfd-gc was built                                        |
| `nfd_topology_updater_build_info`                        | Gauge     | Version from which nfd-topology-updater was built                          |
| `nfd_master_node_update_requests_total`                  | Counter   | Number of node update requests received by the master over gRPC            |
| `nfd_master_node_updates_total`                          | Counter   | Number of nodes updated                                                    |
| `nfd_master_node_feature_group_update_requests_total`    | Counter   | Number of cluster feature update requests processed by the master          |
| `nfd_master_node_update_failures_total`                  | Counter   | Number of nodes update failures                                            |
| `nfd_master_node_labels_rejected_total`                  | Counter   | Number of nodes labels rejected by nfd-master                              |
| `nfd_master_node_extendedresources_rejected_total`       | Counter   | Number of nodes extended resources rejected by nfd-master                  |
| `nfd_master_node_taints_rejected_total`                  | Counter   | Number of nodes taints rejected by nfd-master                              |
| `nfd_master_nodefeaturerule_processing_duration_seconds` | Histogram | Time taken to process NodeFeatureRule objects                              |
| `nfd_master_nodefeaturerule_processing_errors_total`     | Counter   | Number or errors encountered while processing NodeFeatureRule objects      |
| `nfd_worker_feature_discovery_duration_seconds`          | Histogram | Time taken to discover features on a node                                  |
| `nfd_topology_updater_scan_errors_total`                 | Counter   | Number of errors in scanning resource allocation of pods.                  |
| `nfd_gc_objects_deleted_total`                           | Counter   | Number of NodeFeature and NodeResourceTopology objects garbage collected.  |
| `nfd_gc_object_delete_failures_total`                    | Counter   | Number of errors in deleting NodeFeature and NodeResourceTopology objects. |

## Kustomize

To deploy NFD with metrics enabled using kustomize, you can use the
[prometheus overlay](kustomize.md#metrics).

## Helm

By default metrics are enabled when deploying NFD via Helm. To enable Prometheus
to scrape metrics from NFD, you need to pass the following values to Helm:

```bash
--set prometheus.enable=true
```

For more info on Helm deployment, see [Helm](helm.md).

It is recommended to specify
`--set prometheus.prometheusSpec.podMonitorSelectorNilUsesHelmValues=false`
when deploying prometheus-operator via Helm to enable the prometheus-operator
to scrape metrics from any PodMonitor.

or setting labels on the PodMonitor via the helm parameter `prometheus.labels`
to control which Prometheus instances will scrape this PodMonitor.

## Grafana dashboard

NFD contains an example Grafana dashboard. You can import
[`examples/grafana-dashboard.json`](https://raw.githubusercontent.com/kubernetes-sigs/node-feature-discovery/{{site.release}}/examples/grafana-dashboard.json)
to your Grafana instance to visualize the NFD metrics.