Enable TagMapper plugin in Harvest #3799

rahulguptajss · 2025-08-01T11:13:18Z

rahulguptajss
Aug 1, 2025
Collaborator

The TagMapper plugin is designed to convert volume tags to labels. By default, this feature is disabled and is supported via the REST Collector.

To enable this feature in Harvest, follow the steps below:

Harvest Installation Type: Native/deb/rpm

Step 1: Create `custom.yaml`

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

HARVEST_DIR="/opt/harvest"
cd "$HARVEST_DIR/conf/rest"

Create custom.yaml if not already exists:

vi custom.yaml

Update the file with the following content:

objects:
  Volume:      custom_volume.yaml

Create/Update custom_volume.yaml as below in folder $HARVEST_DIR/conf/rest/9.14.0.

cp "$HARVEST_DIR/conf/rest/9.14.0/volume.yaml" "$HARVEST_DIR/conf/rest/9.14.0/custom_volume.yaml"
sed -i 's/^#  - TagMapper/  - TagMapper/' "$HARVEST_DIR/conf/rest/9.14.0/custom_volume.yaml"

Create/Update custom_volume.yaml as below in folder $HARVEST_DIR/conf/rest/9.12.0.

cp "$HARVEST_DIR/conf/rest/9.12.0/volume.yaml" "$HARVEST_DIR/conf/rest/9.12.0/custom_volume.yaml"
sed -i 's/^#  - TagMapper/  - TagMapper/' "$HARVEST_DIR/conf/rest/9.12.0/custom_volume.yaml"

Step 2: Restart Harvest pollers

bin/harvest restart

Harvest Installation Type: 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

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

Create a custom_volume.yaml file in the /etc/nabox/harvest/user/rest/9.14.0 directory as below.

mkdir -p /etc/nabox/harvest/user/rest/9.14.0
cp /data/packages/harvest/conf/rest/9.14.0/volume.yaml /etc/nabox/harvest/user/rest/9.14.0/custom_volume.yaml
sed -i 's/^#  - TagMapper/  - TagMapper/' /etc/nabox/harvest/user/rest/9.14.0/custom_volume.yaml

Create a custom_volume.yaml file in the /etc/nabox/harvest/user/rest/9.12.0 directory as below.

mkdir -p /etc/nabox/harvest/user/rest/9.12.0
cp /data/packages/harvest/conf/rest/9.12.0/volume.yaml /etc/nabox/harvest/user/rest/9.12.0/custom_volume.yaml
sed -i 's/^#  - TagMapper/  - TagMapper/' /etc/nabox/harvest/user/rest/9.12.0/custom_volume.yaml

Step 2: Restart NABox containers

dc restart

Metrics should look like below in prometheus.

volume_labels{aggr="test1,umeng_aff300_aggr2", antiRansomwareState="disabled", cluster="umeng-aff300-01-02", datacenter="REST", instance="dc1:12994", isDestinationCloud="false", isDestinationOntap="false", isEncrypted="false", isHardwareEncrypted="false", isProtected="false", is_sis_volume="true", is_space_enforcement_logical="false", is_space_reporting_logical="false", job="harvest", junction_path="/RahulTest", node="umeng-aff300-01,umeng-aff300-02", root_volume="No", severity="page", snaplock_type="non_snaplock", snapshot_autodelete="false", snapshot_policy="none", state="online", style="flexgroup", svm="osc", svm_root="false", tags="severity:page,team:foobar", team="foobar", type="rw", volume="RahulTest"}

Note: If you prefer not to publish all tags as labels, you can modify the TagMapper plugin in the custom_volume.yaml file. By adding only the relevant tags to this configuration, only those tags will be exported.

  - TagMapper:
      - severity
      - team

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enable TagMapper plugin in Harvest #3799

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Step 1: Create `custom.yaml`

Step 2: Restart Harvest pollers

Step 1: Create `custom.yaml`

Step 2: Restart NABox containers

Replies: 0 comments

Select a reply

Uh oh!

Enable TagMapper plugin in Harvest #3799

Uh oh!

Uh oh!

rahulguptajss Aug 1, 2025 Collaborator

Step 1: Create custom.yaml

Step 2: Restart Harvest pollers

Step 1: Create custom.yaml

Step 2: Restart NABox containers

Replies: 0 comments

rahulguptajss
Aug 1, 2025
Collaborator

Step 1: Create `custom.yaml`

Step 1: Create `custom.yaml`