metrics.md

Containerized Data Importer metrics

This document aims to help users that are not familiar with metrics exposed by the Containerized Data Importer. All metrics documented here are auto-generated by the utility tool tools/metricsdocs and reflects exactly what is being exposed.

Containerized Data Importer Metrics List

clone_progress

The clone progress in percentage. Type: Counter.

kubevirt_cdi_clone_dv_unusual_restartcount_total

Total restart count in CDI Data Volume cloner pod. Type: Counter.

kubevirt_cdi_cr_ready

CDI CR Ready. Type: Gauge.

kubevirt_cdi_dataimportcron_outdated

DataImportCron has an outdated import. Type: Gauge.

kubevirt_cdi_dataimportcron_outdated_total

Total count of outdated DataImportCron imports. Type: Counter.

kubevirt_cdi_import_dv_unusual_restartcount_total

Total restart count in CDI Data Volume importer pod. Type: Counter.

kubevirt_cdi_incomplete_storageprofiles_total

Total number of incomplete and hence unusable StorageProfile. Type: Gauge.

kubevirt_cdi_operator_up_total

CDI operator status. Type: Gauge.

kubevirt_cdi_upload_dv_unusual_restartcount_total

Total restart count in CDI Data Volume upload server pod. Type: Counter.

Developing new metrics

After developing new metrics or changing old ones, please run make generate-doc to regenerate this document.

If you feel that the new metric doesn't follow these rules, please change tools/metricsdocs with your needs.