Requesting maxdir-size parameter addition into volume_labels on nabox v4.1.0

[rahulguptajss]

Discussed in #4352

^{Originally posted by rajsuman July 15, 2026}
firstly, maxdir-size parameter is not added into volume_labels, also calculate maxdir utilization and percentage utilization for any volume is manual, basis on events we take file-id and checking current utilization of volume and its percentage.

Command: vol show -fields maxdir-size

[Hardikl]

As maxdir-size param is float value, we can go with adding as new metric volume_maxdir_size instead of adding label in volume_labels metric.

[Hardikl]

Reference details:

::*> vol show -fields maxdir-size -volume ha11
vserver volume maxdir-size 
------- ------ ----------- 
harvest ha11   320MB   

[Hardikl]

[Hardikl]

As maxdir-size param is float value, we can go with adding as new metric volume_maxdir_size instead of adding label in volume_labels metric.

@rajsuman,
As mentioned above, we do add new metric volume_maxdir_size for this issue, does that cover your use-cases?

[rajsuman]

@Hardikl adding maxdir-size as a new metrics will also work but we're also looking to calculate percentage of utilised maxdir-size by each volume along with maxdir used size also we can't upgrade our NAbox currently. So let me know the process to add metrics into current setup.

[rajsuman]

@Hardikl, pls let me know the progress

[Hardikl]

@rajsuman ,

As you mentioned that you can't upgrade your NaBox currently. Then below are the steps to add the new metric volume_maxdir_size.

NABox4 Steps

⚠️ Note:
Below steps are applicable for NABox and Rest Collector.

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

Step 1: Create custom.yaml

Navigate to the rest directory:

cd /etc/nabox/harvest/user/rest

Create custom.yaml:

vi custom.yaml

Update the file with the following content:

objects:
  Volume: custom_volume.yaml

Step 2: Create custom_volume.yaml

Navigate to the 9.12.0 directory:

mkdir -p /etc/nabox/harvest/user/rest/9.12.0
cd /etc/nabox/harvest/user/rest/9.12.0

Create custom_volume.yaml:

vi custom_volume.yaml

Update the file with the following content:

name:                     Volume
query:                    api/private/cli/volume
object:                   volume

counters:
  - ^^volume
  - ^^vserver                                     => svm
  - ^aggr_list                                    => aggr
  - ^autosize_mode                                => autosize_mode
  - ^clone_parent_name                            => clone_parent_volume
  - ^clone_parent_vserver                         => clone_parent_svm
  - ^clone_volume                                 => is_flexclone
  - ^instance_uuid                                => uuid
  - ^is_encrypted                                 => isEncrypted
  - ^is_sis_volume                                => is_sis_volume
  - ^is_space_enforcement_logical                 => is_space_enforcement_logical
  - ^is_space_reporting_logical                   => is_space_reporting_logical
  - ^junction_path                                => junction_path
  - ^nodes                                        => node
  - ^snaplock_type                                => snaplock_type
  - ^snapshot_policy                              => snapshot_policy
  - ^space_mgmt_try_first                         => space_mgmt_try_first
  - ^state                                        => state
  - ^tags                                         => tags
  - ^tiering_minimum_cooling_days                 => tiering_minimum_cooling_days
  - ^tiering_policy                               => tiering_policy
  - ^type                                         => type
  - ^volume_style_extended                        => style
  - ^vsroot                                       => svm_root
  - autosize_grow_threshold_percent               => autosize_grow_threshold_percent
  - autosize_shrink_threshold_percent             => autosize_shrink_threshold_percent
  - available                                     => size_available
  - compression_space_saved                       => sis_compress_saved
  - compression_space_saved_percent               => sis_compress_saved_percent
  - dedupe_space_saved                            => sis_dedup_saved
  - dedupe_space_saved_percent                    => sis_dedup_saved_percent
  - expected_available                            => space_expected_available
  - files                                         => inode_files_total
  - files_used                                    => inode_files_used
  - filesystem_size                               => filesystem_size
  - logical_available                             => space_logical_available
  - logical_used                                  => space_logical_used
  - logical_used_by_afs                           => space_logical_used_by_afs
  - logical_used_by_snapshots                     => space_logical_used_by_snapshots
  - logical_used_percent                          => space_logical_used_percent
  - max_autosize                                  => autosize_maximum_size
  - maxdir_size                                   => maxdir_size
  - min_autosize                                  => autosize_minimum_size
  - overwrite_reserve                             => overwrite_reserve_total
  - overwrite_reserve_used                        => overwrite_reserve_used
  - percent_snapshot_space                        => snapshot_reserve_percent
  - percent_used                                  => size_used_percent
  - performance_tier_inactive_user_data           => space_performance_tier_inactive_user_data
  - performance_tier_inactive_user_data_percent   => space_performance_tier_inactive_user_data_percent
  - physical_used                                 => space_physical_used
  - physical_used_percent                         => space_physical_used_percent
  - sis_space_saved                               => sis_total_saved
  - sis_space_saved_percent                       => sis_total_saved_percent
  - size                                          => size
  - size_available_for_snapshots                  => snapshots_size_available
  - size_used_by_snapshots                        => snapshots_size_used
  - snapshot_count
  - snapshot_reserve_available                    => snapshot_reserve_available
  - snapshot_reserve_size                         => snapshot_reserve_size
  - snapshot_space_used                           => snapshot_reserve_used_percent
  - total                                         => size_total
  - used                                          => size_used
  - filter:
      - is_constituent=*

endpoints:
  - query: api/private/cli/volume/efficiency/stat
    counters:
      - ^^volume
      - ^^vserver                                 => svm
      - num_compress_attempts
      - num_compress_fail
      - filter:
          - privilege_level=diagnostic

  - query: api/private/cli/volume/footprint
    counters:
      - ^^volume
      - ^^vserver                                 => svm
      - delayed_free_footprint
      - flexvol_metadata_footprint                => metadata_footprint
      - total_footprint
      - total_metadata_footprint
      - volume_blocks_footprint_bin0              => performance_tier_footprint
      - volume_blocks_footprint_bin0_percent      => performance_tier_footprint_percent
      - volume_blocks_footprint_bin1              => capacity_tier_footprint
      - volume_blocks_footprint_bin1_percent      => capacity_tier_footprint_percent
      - volume_guarantee_footprint                => guarantee_footprint

  - query: api/private/cli/volume/snapshot/autodelete
    counters:
      - ^^volume
      - ^^vserver                                 => svm
      - ^enabled                                  => snapshot_autodelete

plugins:
  - Volume:
      schedule:
        - data: 15m  # should be multiple of poll duration
      include_constituents: false
  - MetricAgent:
      compute_metric:
        - inode_used_percent PERCENT inode_files_used inode_files_total
        - snapshot_reserve_used SUBTRACT snapshot_reserve_size snapshot_reserve_available
        - overwrite_reserve_available SUBTRACT overwrite_reserve_total overwrite_reserve_used
  - LabelAgent:
      value_to_num:
        - new_status state online online `0`
      replace_regex:
        - svm_root root_volume `false` `No`
        - svm_root root_volume `true` `Yes`
        - svm_root root_volume `^$` `Yes`      # svm_root is not available in Rest response for volumes like vol0
      # Ignore transient volumes, e.g. SnapProtect, SnapManager, SnapCenter, CommVault, Clone, and Metadata volumes
      exclude_regex:
        - volume `.+_CVclone`
        - volume `.+(0[1-9]|[12][0-9]|3[01])(0[1-9]|1[012])\d\d[0-9]{6}`
        - volume `cl_.+_(19|20)\d\d(0[1-9]|1[012])( 0[1-9]|[12][0-9]|3[01])[0-9]{6}`
        - volume `sdw_cl_.+`
        - volume `MDV_CRS_.+`
        - volume `MDV_aud_.+`
        - volume `^fg_oss_`
        - volume `cohesity_.+`
      exclude_equals:
        - type `tmp`
        - node_root `true`
#  - ChangeLog
#  - TagMapper

export_options:
  instance_keys:
    - aggr
    - node
    - style
    - svm
    - volume
  instance_labels:
    - antiRansomwareState
    - autosize_mode
    - clone_parent_snapshot
    - clone_parent_svm
    - clone_parent_volume
    - isEncrypted
    - isHardwareEncrypted
    - is_sis_volume
    - is_space_enforcement_logical
    - is_space_reporting_logical
    - junction_path
    - root_volume
    - snaplock_type
    - snapshot_autodelete
    - snapshot_policy
    - space_mgmt_try_first
    - state
    - svm_root
    - tags
    - tiering_policy
    - tiering_minimum_cooling_days
    - type

Step 3: Restart NABox containers

dc restart

---

After the dc restart command, volume_maxdir_size metric now would be available in prometheus/victoriametric as below

Please follow the above steps and let us know if you face any query or issues and share your feedback.

[rajsuman]

Hi @Hardikl, hope we covered everything about maxdir-size in this metrics. Like maxdir-size, file-used fields

Command
vol explore inode -scope NASPROD_GMFT.3585 -dump name,size

Output
name=/Goanywhere/filearea/netweaver/outgoing/error
size=703496192

We use to do calculation once above used output is received using command with volume show -fields maxdir-size (total size) to do calculation of used percentage of maxdir-size

Can we setup a call ?

[Hardikl]

Thanks @rajsuman for the details. Earlier, you mentioned maxdir-size, which you should be able to get by following the above steps.

Now, coming to the calculation part, I understood that vol explore command can give size of file_id 3585, and using this value with maxdir_size can help identify the percentage.

While I am mapping this field to the Ontap REST API, private CLI API, or CLI, I found that your expected field file-used is already being monitored by Harvest. However, it doesn't seem to be same as what you show above. Please correct me if I have misread it.

Template: https://github.com/NetApp/harvest/blob/main/conf/rest/9.12.0/volume.yaml#L39
Doc: https://netapp.github.io/harvest/26.05/ontap-metrics/#volume_inode_files_used

---

Could you run the following two curl commands on your system with your volume and check if the SIZE=703496192 field is coming up ?
-> If yes, then please share end-to-end calculation of which actual fields (from private CLI OR public REST API) would be used to derive the utilization value. Based on that, we can patch accordingly.
-> If no, then we may need to ask any ONTAP SME if the equivalent field exist in the REST API for this.

Note: you can update USER,PASSWORD, CLUSTER_IP and VOLUME accordingly.

% curl -sk -u USER:PASSWORD 'https://CLUSTER_IP/api/private/cli/volume?return_records=true&fields=maxdir-size,files_used,filesystem_size,files&volume=VOLUME'

% curl -sk -u USER:PASSWORD 'https://CLUSTER_IP/api/storage/volumes?return_records=true&fields=max_dir_size,space,files&name=VOLUME'