Enable Top Clients/Files Metrics in Harvest

[rahulguptajss]

Note: Kindly ensure that Activity tracking is enabled on the Volumes as outlined in this document https://docs.netapp.com/us-en/ontap-cli/volume-activity-tracking-on.html for ONTAP.

Top Clients collection is disabled by default. To enable Top Clients Tracking in Harvest, follow these steps. Note that Top Clients support is available only through the KeyPerf Collector in ONTAP version 9.11 and later. The collection is enabled in the KeyPerf Collector Volume template via a plugin VolumeTopClients, as detailed below.

Note: Applicable from Harvest 25.11.

NABox4

⚠️ Note:
Prerequisite: ssh to NABox via admin
Create relevant directories if they don't exist. You need to run these commands in sudo bash

1. Make sure that you have the KeyPerf collector listed in your poller configuration in harvest.yml. You can do this by editing /etc/nabox/harvest/harvest.yml. You can list it as the last collector in your existing collector list.

2. Navigate to the keyperf directory.

mkdir -p /etc/nabox/harvest/user/keyperf
cd /etc/nabox/harvest/user/keyperf

Create custom.yaml:

vi custom.yaml

Update the file with the following content:

objects:
  Volume: custom_volume.yaml

3. Create a custom_volume.yaml file in the /etc/nabox/harvest/user/keyperf/9.15.0 directory as below.

mkdir -p /etc/nabox/harvest/user/keyperf/9.15.0
cp /data/packages/harvest/conf/keyperf/9.15.0/volume.yaml /etc/nabox/harvest/user/keyperf/9.15.0/custom_volume.yaml
sed -i '/^#  - VolumeTopClients:/,/^export_options:/ { /^#/s/^#// }' /etc/nabox/harvest/user/keyperf/9.15.0/custom_volume.yaml

4. Restart harvest

rpm/deb/native/container

Note:

Below steps are applicable for rpm/deb/native/container installation.

Let's assume Harvest is installed in /opt/harvest directory. Adjust paths as needed.

HARVEST_DIR="/opt/harvest"

1. Make sure that you have the KeyPerf collector listed in your poller configuration in harvest.yml. You can do this by editing "$HARVEST_DIR/harvest.yml. You can list it as the last collector in your existing collector list.

2. Navigate to the keyperf directory:

cd "$HARVEST_DIR/conf/keyperf"

Create custom.yaml:

vi custom.yaml

Update the file with the following content:

objects:
  Volume: custom_volume.yaml

3. Create a custom_volume.yaml file in the /opt/harvest/conf/keyperf/9.15.0/ directory.

cp "$HARVEST_DIR/conf/keyperf/9.15.0/volume.yaml" "$HARVEST_DIR/conf/keyperf/9.15.0/custom_volume.yaml"
sed -i '/^#  - VolumeTopClients:/,/^export_options:/ { /^#/s/^#// }' "$HARVEST_DIR/conf/keyperf/9.15.0/custom_volume.yaml"

4. Restart harvest

In the volume dashboard under the clients panel, you should see something similar to the following:

[kenpratte]

I probably did it wrong, but if I do Nabox4 step #1, by adding "- KeyPerf" in Defaults/collectors below "- Ems" the havrest container restarts every minute. If I remove it, the container becomes stable.

[cgrinds]

hi @kenpratte can you copy paste your changes here so we can check them?

[kenpratte]

Defaults:
    debug: false
    addr: ""
    collectors:
        - Zapi
        - ZapiPerf
        - Rest
        - RestPerf
        - Ems
        - KeyPerf   # Line added
    datacenter: ""
    exporters:
        - nabox-victoriametrics
    enabled: false
Exporters:

[cgrinds]

Thanks @kenpratte that looks good. Can you grab a support bundle from your Nabox and upload to https://upload.nabox.org/tapu-kana-jotu

[kenpratte]

Uploaded

[cgrinds]

Thanks for the logs @kenpratte do you recall what commands you ran to restart everything after adding the KeyPerf collector to the /etc/nabox/harvest/harvest.yml file? I don't see any obvious errors in the logs you shared. We've tested these steps on nabox4 and they are correct, so I'm looking for other possible reasons that your containers would restart loop. It's also possible the log files have rolled and we don't have them.

I see something killed the containers around 2025-11-25T16:21:59.041Z - is that when you restarted?

Would you try making the changes again and then run dc restart. If the container fails to start again, grab another bundle and upload it. If you want more real-time help, you could join our Discord server and we could chat about it there.

[kenpratte]

It did: "dc down" and then "dc up -d" to restart containers

[cgrinds]

That should work

[leejshades]

dear ,
flexvolume is work,flex group is not work.

[rahulguptajss]

@leejshades You are right. There is a bug where flexgroup top metrics are not reported. I have opened an issue to track it. #4071
Thanks!

[rahulguptajss]

@leejshades Fix for this issue is available in the nightly build if you want to give it a try.

[leejshades]

In version 26.02, there is a bug where FlexGroup top metrics are not reported.

[rahulguptajss]

Sure @leejshades We'll check.

[rahulguptajss]

@leejshades Please upgrade to the nightly build and check again. This issue is already fixed in the nightly build. Thanks.