Changes to Volume Performance Metrics in Harvest

[rahulguptajss]

This change improves Harvest's ONTAP volume performance collection metrics by better aligning with ONTAP's recommendation that Harvest collect QoS volume metrics instead of volume metrics per KB.

• Release: Harvest 25.11
• Scope: Volume performance metrics only

Why We Changed This

The ONTAP volume metrics provided via ZapiPerf and RestPerf may be incomplete. As the KB article above mentions, ONTAP volume metrics may be missing other ops, including NAS protocol ops.

To address this, Harvest uses the KeyPerf collector for volume metrics (where supported). KeyPerf:Volume metrics are actually QoS volume workload metrics which include these additional latencies for a more complete view.

What Changed

ONTAP Version	Harvest
< 9.10	RestPerf and KeyPerf are not supported. Harvest uses the ZapiPerf:Volume collector.
>= 9.10	Harvest upgrades the ZapiPerf:Volume and RestPerf:Volume collectors to KeyPerf:Volume

• Only volume performance metrics are upgraded. No other collectors are changed.
• conf/zapiperf/default.yaml and conf/restperf/default.yaml prefix the Volume object with KeyPerf:volume.yaml.

Permissions:

• Because the KeyPerf collector relies on ONTAP REST APIs, ZAPI-only environments must grant REST permissions for volume performance metrics

I've made changes to my volume templates. What should I do?

Template changes are not automatically migrated to KeyPerf.

• If your changes are to the ZapiPerf:Volume template and your cluster is at version 9.10 or greater, you will need to reapply those changes to the KeyPerf collector. If you cluster version is earlier than 9.10, no action is required.
• If your changes are to the RestPerf:Volume template, you will need to reapply those changes to the KeyPerf collector and edit your restperf/custom.yaml file and remove the Volume: line.
• Examples that may need re-enabling:
  • Enabling FlexGroup Constituents
  • Enabling Top clients/files

What You Need To Do

• Most users: Nothing. If REST API access is already configured, the change is automatic.
• ZAPI-only environments: Grant REST permissions for volume performance metrics.
  • Setup guidance: https://netapp.github.io/harvest/nightly/prepare-cdot-clusters/#ontap-910-volume-performance-metrics

FAQs

• Q: Do I need to change my Harvest configuration?
  • A: No. The upgrade to KeyPerf is automatic for ONTAP 9.10+.
• Q: What if I have multiple clusters on different ONTAP versions?
  • A: Each cluster is handled individually. ONTAP 9.10+ uses KeyPerf, older versions continue as before.
• Q: Will this change my dashboards?
  • A: No. Dashboards are unaffected. You may see more complete volume latency data.
• Q: What if KeyPerf can’t start?
  • A: Harvest automatically falls back to your existing collectors.
• Q: How do I verify it’s working?
  • A: Check Harvest logs for upgrade messages, or confirm volume performance metrics in your monitoring system.

What You’ll See In Logs

• Successful upgrade to KeyPerf (ONTAP 9.10+):

INFO object upgraded object=Volume from=ZapiPerf to=KeyPerf template=volume.yaml

• Skipped upgrade (ONTAP < 9.10):

WARN volume KeyPerf upgrade skipped due to ONTAP version

For clusters on versions of ONTAP before 9.10, this is expected. Harvest continues using the pre-existing ZapiPerf volume object.