The Blog of Jorge de la Cruz

Everything about VMware, Veeam, InfluxData, Grafana, Zimbra, etc.

Looking for the Perfect Dashboard: InfluxDB, Telegraf, and Grafana – Part XLIII (Monitoring QNAP using SNMP v3)

- Written in: opensource

Greetings friends, what an exciting entry I bring you today. For years I have been receiving the request to do a SNMP Grafana dashboard. Honestly I always found SNMP quite complex for what it should be, I understand there are MIBs, and it is an standard, but it is just too complex to build upon it. Luckily telegraf comes to the rescue and the config is quite easy.

Some more SNMP dashboard might come, for example one for ESXis, but for now I wanted to start with a critical component of my homelab which is my NAS, where my backups reside, etc.

Grafana Dashboard for QNAP Devices, using SNMP v3

When you finish the entry you will have something similar to this. It might be different according to your device, like more drives, less drives, more fans, etc. You can quickly filter by time on the top right, and sampling to obtain more or less granularity on the charts.

Dashboard – Summary

  • QNAP Overview – On the top bar we can find a quick overview of our QNAP, number of devices, model, RAM, CPU Cores, Ethernets, etc.
  • Fan Speed – The speed at which our FANs are working.
  • System Temperature – This will show you the different main temperatures, like CPU, and system.
  • Disk Temperatures – Another great one, it will show you all your disks speeds. Usually the firstt two drives are used for NVMe cache on all models. Adjust it if not.
  • CPU/RAM/Network Usage – Time-series metrics with the consumption of the different resources by time.
  • Disk IOPS/Volume Usage – Two visualizations about disks and volumes, the first one on the left, aiming at the IOPS consumed, on the right showing us the consumption of disk in %.

Topology with all logical components

This entry is very similar to the previous ones, we will use telegraf to collect the SNMP information from our QNAPs, from there we will send them to InfluxDB, and visualize them with Grafana . The design would be something similar to this:

QNAP, and Telegraf SNMPv3 Configuration

For the very first time on the series, I am using SNMP. I must admit it is not my cup of tea, but it is true that sometimes it is the easiest way to take data out, not that easy to put together into a monitoring tool. There are a few steps we need to perform on our QNAP. I used the great work from https://gitlab.com/artkrz/telegraf-qnap as inspiration for some steps.

SNMP v3 configuration, and MIB Download

We are going to use SNMP, but not v1/v2, random without user/pass. We are going to to do it right, and secure. So we enable SNMP, version 3, and we configure authentication, and privacy. Next please download the QNAP MIB as well:

With these little steps, we are all set at the QNAP level.

Telegraf additional steps, and configuration

SNMP is a bit particular, so first of let’s install the next package on your telegraf server (use yum if RHEL based):

sudo apt-get install snmp-mibs-downloader

And now, make sure you put the NAS.mib on the correct path:

/usr/share/snmp/mibs/

Under your vi /etc/snmp/snmp.conf make sure you have the next enabled

nano /etc/snmp/snmp.conf

# As the snmp packages come without MIB files due to license reasons, loading
# of MIBs is disabled by default. If you added the MIBs you can reenable
# loading them by commenting out the following line.
mibs +ALL

# If you want to globally change where snmp libraries, commands and daemons
# look for MIBS, change the line below. Note you can set this for individual
# tools with the -M option or MIBDIRS environment variable.
#
# mibdirs /usr/share/snmp/mibs:/usr/share/snmp/mibs/iana:/usr/share/snmp/mibs/ietf

Alright, we are finally ready to rock & roll, let’s create the specific QNAP configuration under /etc/telegraf/telegraf.d/qnap.conf with the next content. Please replace your QNAPIP,  the username used on the SNMPv3 on QNAP, and the passwords used for auth and privacy:

[[inputs.snmp]]
   # List of agents to poll
   agents = [ "YOURQNAPIP" ]
   # Polling interval
   interval = "30s"
   # Timeout for each SNMP query.
   timeout = "30s"
   # Number of retries to attempt within timeout.
   retries = 3
   # The GETBULK max-repetitions parameter
   max_repetitions = 10
   # Measurement name
   name = "snmp.QNAP"
   #SNMPv3
   version = 3
   sec_name = "YOURUSERNAME"
   auth_protocol = "SHA"
   auth_password = "YOURPASS"
   sec_level = "authPriv"
   priv_protocol = "DES"
   priv_password = "YOUROTHERPASS"


  ##
  ## System Details & Metrics
  ##
  # CPU
  [[inputs.snmp.field]]
  name = "name"
  oid = "NAS-MIB::enclosureName.1"
  is_tag = true

  [[inputs.snmp.table]]
    name = "snmp.QNAP.cpuTable"
    oid = "NAS-MIB::cpuTable"
    [[inputs.snmp.table.field]]
      name = "cpuIndex"
      oid = "NAS-MIB::cpuIndex"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "cpuID"
      oid = "NAS-MIB::cpuID"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "cpuUsage"
      oid = "NAS-MIB::cpuUsage"

  #  System
  #  Enclosures
  [[inputs.snmp.table]]
    name = "snmp.QNAP.systemTable"
  # Memory
  [[inputs.snmp.table.field]]
    name = "systemTotalMemEX"
    oid = "NAS-MIB::systemTotalMemEX"
  [[inputs.snmp.table.field]]
    name = "systemFreeMemEX"
    oid = "NAS-MIB::systemFreeMemEX"
  # System temp
  [[inputs.snmp.table.field]]
    name = "cpu-TemperatureEX"
    oid = "NAS-MIB::cpu-TemperatureEX"
  [[inputs.snmp.table.field]]
    name = "systemTemperatureEX"
    oid = "NAS-MIB::systemTemperatureEX"
  # Uptime
  [[inputs.snmp.table.field]]
    name = "systemUptime"
    oid = "NAS-MIB::systemUptimeEX"
  # Uptime
  [[inputs.snmp.table.field]]
    name = "systemCPU-UsageEX"
    oid = "NAS-MIB::systemCPU-UsageEX"

  #  Enclosures
  [[inputs.snmp.table]]
    name = "snmp.QNAP.enclosureTable"
    oid = "NAS-MIB::enclosureTable"
    # Memory
    [[inputs.snmp.table.field]]
      name = "enclosureID"
      oid = "NAS-MIB::enclosureID"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "enclosureModel"
      oid = "NAS-MIB::enclosureModel"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "enclosureName"
      oid = "NAS-MIB::enclosureName"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "enclosureSystemTemp"
      oid = "NAS-MIB::enclosureSystemTemp"

  #  Fan
  [[inputs.snmp.table]]
    name = "snmp.QNAP.systemFanTableEx"
    oid = "NAS-MIB::systemFanTableEx"
    [[inputs.snmp.table.field]]
      name = "sysFanIndexEX"
      oid = "NAS-MIB::sysFanIndexEX"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "sysFanDescrEX"
      oid = "NAS-MIB::sysFanDescrEX"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "sysFanSpeedEX"
      oid = "NAS-MIB::sysFanSpeedEX"

  #  Power
  [[inputs.snmp.table]]
    name = "snmp.QNAP.systemPowerTable"
    oid = "NAS-MIB::systemPowerTable"
    [[inputs.snmp.table.field]]
      name = "systemPowerIndex"
      oid = "NAS-MIB::systemPowerIndex"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "systemPowerID"
      oid = "NAS-MIB::systemPowerID"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "systemPowerEnclosureID"
      oid = "NAS-MIB::systemPowerEnclosureID"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "systemPowerStatus"
      oid = "NAS-MIB::systemPowerStatus"
    [[inputs.snmp.table.field]]
      name = "systemPowerFanSpeed"
      oid = "NAS-MIB::systemPowerFanSpeed"
    [[inputs.snmp.table.field]]
      name = "systemPowerFanSpeed"
      oid = "NAS-MIB::systemPowerFanSpeed"
    [[inputs.snmp.table.field]]
      name = "systemPowerTemp"
      oid = "NAS-MIB::systemPowerTemp"

  #  Interfaces
  [[inputs.snmp.table]]
    name = "snmp.QNAP.systemIfTableEx"
    oid = "NAS-MIB::systemIfTableEx"
    [[inputs.snmp.table.field]]
      name = "ifIndexEX"
      oid = "NAS-MIB::ifIndexEX"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "ifDescrEX"
      oid = "NAS-MIB::ifDescrEX"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "ifPacketsReceivedEX"
      oid = "NAS-MIB::ifPacketsReceivedEX"
    [[inputs.snmp.table.field]]
      name = "ifPacketsSentEX"
      oid = "NAS-MIB::ifPacketsSentEX"
    [[inputs.snmp.table.field]]
      name = "ifErrorPacketsEX"
      oid = "NAS-MIB::ifErrorPacketsEX"

  #  Interfaces
  [[inputs.snmp.table]]
    name = "snmp.QNAP.ifXTable"
    oid = "IF-MIB::ifXTable"
    [[inputs.snmp.table.field]]
      name = "ifName"
      oid = "IF-MIB::ifName"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "ifHCInOctets"
      oid = "IF-MIB::ifHCInOctets"
    [[inputs.snmp.table.field]]
      name = "ifHCOutOctets"
      oid = "IF-MIB::ifHCOutOctets"

  ##
  ## Disk Details & Metrics
  ##
  #  Disk
  [[inputs.snmp.table]]
    name = "snmp.QNAP.diskTable"
    oid = "NAS-MIB::diskTable"
    [[inputs.snmp.table.field]]
      name = "diskIndex"
      oid = "NAS-MIB::diskIndex"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "diskID"
      oid = "NAS-MIB::diskID"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "diskEnclosureID"
      oid = "NAS-MIB::diskEnclosureID"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "diskSummary"
      oid = "NAS-MIB::diskSummary"
    [[inputs.snmp.table.field]]
      name = "diskTemperture"
      oid = "NAS-MIB::diskTemperture"
    [[inputs.snmp.table.field]]
      name = "diskSmartInfo"
      oid = "NAS-MIB::diskSmartInfo"
    [[inputs.snmp.table.field]]
      name = "diskGlobalSpare"
      oid = "NAS-MIB::diskGlobalSpare"
    [[inputs.snmp.table.field]]
      name = "diskModel"
      oid = "NAS-MIB::diskModel"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "diskCapacity"
      oid = "NAS-MIB::diskCapacity"
      is_tag = true

  ##
  ## Volume Details & Metrics
  ##
  #  Volumes
  [[inputs.snmp.table]]
    name = "snmp.QNAP.systemVolumeTableEx"
    oid = "NAS-MIB::systemVolumeTableEx"
    [[inputs.snmp.table.field]]
      name = "sysVolumeIndexEX"
      oid = "NAS-MIB::sysVolumeIndexEX"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "sysVolumeDescrEX"
      oid = "NAS-MIB::sysVolumeDescrEX"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "sysVolumeFSEX"
      oid = "NAS-MIB::sysVolumeFSEX"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "sysVolumeTotalSizeEX"
      oid = "NAS-MIB::sysVolumeTotalSize"
    [[inputs.snmp.table.field]]
      name = "sysVolumeFreeSize"
      oid = "NAS-MIB::sysVolumeFreeSizeEX"
    [[inputs.snmp.table.field]]
      name = "sysVolumeStatus"
      oid = "NAS-MIB::sysVolumeStatusEX"

  ##
  ## Disk Performance Details & Metrics
  ##
  #  Disk Performance
  [[inputs.snmp.table]]
    name = "snmp.QNAP.diskPerformanceTable"
    oid = "NAS-MIB::diskPerformanceTable"
    [[inputs.snmp.table.field]]
      name = "diskPerformanceIndex"
      oid = "NAS-MIB::diskPerformanceIndex"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "blvID"
      oid = "NAS-MIB::blvID"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "iops"
      oid = "NAS-MIB::iops"
    [[inputs.snmp.table.field]]
      name = "latency"
      oid = "NAS-MIB::latency"

  #  JBOD
  [[inputs.snmp.table]]
    name = "snmp.QNAP.jBODHdTable1"
    oid = "NAS-MIB::jBODHdTable1"
    [[inputs.snmp.table.field]]
      name = "jBODHdIndex1"
      oid = "NAS-MIB::jBODHdIndex1"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "jBODHdDescr1"
      oid = "NAS-MIB::jBODHdDescr1"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "jBODHdTemperature1"
      oid = "NAS-MIB::sysVolumeFSEX"
    [[inputs.snmp.table.field]]
      name = "jBODHdStatus1"
      oid = "NAS-MIB::jBODHdStatus1"
    [[inputs.snmp.table.field]]
      name = "jBODHdModel1"
      oid = "NAS-MIB::jBODHdModel1"
      is_tag = true
    [[inputs.snmp.table.field]]
      name = "jBODHdCapacity1 "
      oid = "NAS-MIB::jBODHdCapacity1"
    [[inputs.snmp.table.field]]
      name = "jBODHdSmartInfo1"
      oid = "NAS-MIB::jBODHdSmartInfo1"

Let’s save it, and run a quick telegraf check.

How-to test telegraf’s configuration

Before we restart telegraf services or anything, let’s run the next command, it should give you some output similar to what you can see here:

[email protected]:/home/oper# telegraf --test --config /etc/telegraf/telegraf.d/qnap.conf 
2023-02-19T19:23:01Z I! Starting Telegraf 1.24.3
2023-02-19T19:23:01Z I! Available plugins: 222 inputs, 9 aggregators, 26 processors, 20 parsers, 57 outputs
2023-02-19T19:23:01Z I! Loaded inputs: snmp
2023-02-19T19:23:01Z I! Loaded aggregators: 
2023-02-19T19:23:01Z I! Loaded processors: 
2023-02-19T19:23:01Z W! Outputs are not used in testing mode!
2023-02-19T19:23:01Z I! Tags enabled: host=tig-monitor
> snmp.QNAP.cpuTable,agent_host=192.168.1.50,cpuID=2,cpuIndex=2,host=tig-monitor cpuUsage=1i 1676834608000000000
> snmp.QNAP.cpuTable,agent_host=192.168.1.50,cpuID=3,cpuIndex=3,host=tig-monitor cpuUsage=0i 1676834608000000000
> snmp.QNAP.cpuTable,agent_host=192.168.1.50,cpuID=4,cpuIndex=4,host=tig-monitor cpuUsage=0i 1676834608000000000
> snmp.QNAP.cpuTable,agent_host=192.168.1.50,cpuID=1,cpuIndex=1,host=tig-monitor cpuUsage=1i 1676834608000000000
> snmp.QNAP.systemTable,agent_host=192.168.1.50,host=tig-monitor cpu-TemperatureEX=59i,systemFreeMemEX=1931608064i,systemTemperatureEX=43i,systemTotalMemEX=4184276992i 1676834608000000000
> snmp.QNAP.enclosureTable,agent_host=192.168.1.50,enclosureID=33,enclosureModel=USB,host=tig-monitor enclosureSerialNum="--",enclosureSlot=4i,enclosureSystemTemp=0i 1676834609000000000
> snmp.QNAP.enclosureTable,agent_host=192.168.1.50,enclosureID=0,enclosureModel=TS-435XeU,enclosureName=nase80550,host=tig-monitor enclosureSerialNum="Q221I06176R",enclosureSlot=6i,enclosureSystemTemp=43i 1676834609000000000
> snmp.QNAP.enclosureTable,agent_host=192.168.1.50,enclosureID=32,enclosureModel=BOOT,host=tig-monitor enclosureSerialNum="--",enclosureSlot=1i,enclosureSystemTemp=0i 1676834609000000000
> snmp.QNAP.systemFanTableEx,agent_host=192.168.1.50,host=tig-monitor,sysFanDescrEX=System\ FAN\ 1,sysFanIndexEX=1 sysFanSpeedEX=2760i 1676834610000000000
> snmp.QNAP.systemFanTableEx,agent_host=192.168.1.50,host=tig-monitor,sysFanDescrEX=System\ FAN\ 2,sysFanIndexEX=2 sysFanSpeedEX=2700i 1676834610000000000
> snmp.QNAP.systemFanTableEx,agent_host=192.168.1.50,host=tig-monitor,sysFanDescrEX=System\ FAN\ 3,sysFanIndexEX=3 sysFanSpeedEX=2670i 1676834610000000000
> snmp.QNAP.systemPowerTable,agent_host=192.168.1.50,host=tig-monitor,systemPowerEnclosureID=0,systemPowerID=1,systemPowerIndex=1 systemPowerFanSpeed=-1i,systemPowerStatus=0i,systemPowerTemp=-1i 1676834614000000000
> snmp.QNAP.systemPowerTable,agent_host=192.168.1.50,host=tig-monitor,systemPowerEnclosureID=32,systemPowerID=1,systemPowerIndex=2 systemPowerFanSpeed=0i,systemPowerStatus=0i,systemPowerTemp=0i 1676834614000000000
> snmp.QNAP.systemPowerTable,agent_host=192.168.1.50,host=tig-monitor,systemPowerEnclosureID=33,systemPowerID=1,systemPowerIndex=3 systemPowerFanSpeed=0i,systemPowerStatus=0i,systemPowerTemp=0i 1676834614000000000
> snmp.QNAP.systemIfTableEx,agent_host=192.168.1.50,host=tig-monitor,ifDescrEX=eth0,ifIndexEX=1 ifErrorPacketsEX=0i,ifPacketsReceivedEX=207366i,ifPacketsSentEX=33180i 1676834614000000000
> snmp.QNAP.systemIfTableEx,agent_host=192.168.1.50,host=tig-monitor,ifDescrEX=eth1,ifIndexEX=2 ifErrorPacketsEX=0i,ifPacketsReceivedEX=0i,ifPacketsSentEX=0i 1676834614000000000
> snmp.QNAP.systemIfTableEx,agent_host=192.168.1.50,host=tig-monitor,ifDescrEX=eth2,ifIndexEX=3 ifErrorPacketsEX=0i,ifPacketsReceivedEX=221838i,ifPacketsSentEX=61151i 1676834614000000000

Grafana Dashboards

I created a Dashboard from scratch by selecting the best requests to the database, finishing off colors, thinking about graphics, and how to display them, and everything is automated so that it fits our environment without any problem and without having to edit anything manually. The Dashboard can be found here, once imported, you can use the top drop-down menus to select between the different variables:

Import Grafana Dashboards easily

I have already a wonderful Dashboard, ready just for you with everything you need to monitor our environment in a very simple way. Select the name you want and enter the ID: 18229, which is the unique ID of the Dashboard, or the URL:

With the menus above you can display and adjust the Dashboard to your different choices:

I hope you like it, and I would like to leave you the complete series here, so you can start playing with the plugins that I have been telling you about all these years:

Reader Interactions

Comments

  2. Ahmet says

    Hi Jorge;

    I did qnap configuration. I wrote the necessary information in the necessary places in the qnap.conf file but I am getting an error during testing. error code :

    2023-03-07T07:27:52Z E! [telegraf] Error running agent: error loading config file /etc/telegraf/telegraf.d/qnap.conf: error parsing data: line 493: key `name’ is in conflict with line 1e9d

  3. jorgeuk says

    Hello, that is weird, there is no such line as 493 on my qnap.conf, I just have 293 lines. I have copied/paste it again, please review it and copy/paste it again. Are you using nano? or vi? No additional code is getting there?

    Thanks!

  4. Ahmet says

    yes there are 293 lines. but this is the error. I downloaded the config file and opened it in notepad++. likewise 293 lines. I can’t understand why it is showing 493 lines on the error screen.

  6. Ahmet says

    yes, I made the snmtp settings on qnap as in the article. I downloaded mib and copied it to /usr/share/snmp/mibs/ folder. I filled in the config file according to my own information. So I did everything according to the article.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: