Add a new REST Snapshot template

[cgrinds]

Note: These steps are for native install.

Step 1: Create custom_snapshot.yaml

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

Navigate to the rest directory:

cd /opt/harvest/conf/rest

Create custom_snapshot.yaml:

vi custom_snapshot.yaml

Update the file with the following content:

objects:
  Snapshot:
    - snapshot.yaml

Step 2: Create snapshot.yaml

Navigate to the 9.12.0 directory:

cd /opt/harvest/conf/rest/9.12.0

Create snapshot.yaml:

vi snapshot.yaml

Update the file with the following content:

name:                     Snapshot
query:                    api/private/cli/snapshot
object:                   snapshot
 
counters:
  - ^^snapshot               => snapshot
  - ^^volume                 => volume
  - ^^vserver                => svm
  - create_time(timestamp)   => create_time
  - size                     => size
 
export_options:
  include_all_labels: true

Step 3: Restart Harvest pollers

bin/harvest restart

Step 4: Validate Snapshot collection in Harvest

Wait for at least 1 minute. To ensure that the Rest:Snapshot metrics are being collected, run the following command:

Substitute the name of your poller for $poller

grep -w 'Rest:Snapshot' /var/log/harvest/$poller.log

In the screenshot below, you can see that the poller sar is collecting Rest:Snapshot instances.

Step 5: Verify Snapshot metrics are in Prometheus

Confirm that the Snapshot metrics are being scraped by Prometheus by running the following query from Prometheus:

snapshot_size