Help needed creatinging custom generator.yml #1151

andonovski · 2024-04-03T09:47:43Z

andonovski
Apr 3, 2024

I need to monitor Fortinet devices using SNMP, and I have a problem how to generate generator.yml file from Fortinet MIBs.
Is there any automation process behind this, or generator.yml must be edited manually?

To me it's not clear at all what should I put in generator.yml, I guess I can't just put all the OIDS I find for the Fortinet devices.

bastischubert · 2024-05-05T12:15:58Z

bastischubert
May 5, 2024
Maintainer

totally depends on what you'd like to see from your fortinet devices.

i'm using a config for example that is scraping all metrics i'm interested in - you could also scrape interface metrics for example in one module and fortigate specific in another.

i manually went through the WHOLE mib file and created the generator config with the OIDs i needed - this is cumbersome but gave ME the best results as i know what i'm searching for - YMMV

my current config - just for ref:

modules:
  fortinet_fortigate:
    walk:
      - 1.3.6.1.4.1.12356.101.13.2.1.1.3 # fgHaStatsCpuUsage
      - 1.3.6.1.4.1.12356.101.3.2.1.1.5 # fgVdEntCpuUsage
      - 1.3.6.1.4.1.12356.101.4.1.3 # fgSysCpuUsage
      - 1.3.6.1.4.1.12356.101.13.2.1.1.4 # fgHaStatsMemUsage
      - 1.3.6.1.4.1.12356.101.13.2.1.1.2 # fgHaStatsSerial
      - 1.3.6.1.4.1.12356.101.13.2.1.1.6 # fgHaStatsSesCount
      - 1.3.6.1.4.1.12356.101.13.2.1.1.9 # fgHaStatsIdsCount
      - 1.3.6.1.4.1.12356.101.13.2.1.1.10 # fgHaStatsAvCount
      - 1.3.6.1.4.1.12356.101.13.2.1.1.11 # fgHaStatsHostname
      - 1.3.6.1.4.1.12356.101.13.1.1 # fgHaSystemMode
      - 1.3.6.1.4.1.12356.101.13.1.2 # fgHaGroupId
      - 1.3.6.1.4.1.12356.101.13.1.7 # fgHaGroupName
      - 1.3.6.1.2.1.1.1 # sysDescr
      - 1.3.6.1.2.1.1.3 # sysUpTime
      - 1.3.6.1.2.1.1.6 # sysLocation
      - 1.3.6.1.2.1.2.2.1.2 # ifDescr
      - 1.3.6.1.2.1.2.2.1.3 # ifType
      - 1.3.6.1.2.1.2.2.1.7 # ifAdminStatus
      - 1.3.6.1.2.1.2.2.1.8 # ifOperStatus
      - 1.3.6.1.2.1.2.2.1.13 # ifInDiscards
      - 1.3.6.1.2.1.2.2.1.14 # ifInErrors
      - 1.3.6.1.2.1.2.2.1.19 # ifOutDiscards
      - 1.3.6.1.2.1.2.2.1.20 # ifOutErrors
      - 1.3.6.1.2.1.15.3.1.2 # bgpPeerState
      - 1.3.6.1.2.1.15.3.1.3 # bgpPeerAdminStatus
      - 1.3.6.1.2.1.15.3.1.16 # bgpPeerFsmEstablishedTime
      - 1.3.6.1.2.1.15.6.1.3 # bgp4PathAttrIpAddrPrefix
      - 1.3.6.1.2.1.31.1.1.1.1 # ifName
      - 1.3.6.1.2.1.31.1.1.1.6 # ifHCInOctets
      - 1.3.6.1.2.1.31.1.1.1.7 # ifHCInUcastPkts
      - 1.3.6.1.2.1.31.1.1.1.8 # ifHCInMulticastPkts
      - 1.3.6.1.2.1.31.1.1.1.9 # ifHCInBroadcastPkts
      - 1.3.6.1.2.1.31.1.1.1.10 # ifHCOutOctets
      - 1.3.6.1.2.1.31.1.1.1.11 # ifHCOutUcastPkts
      - 1.3.6.1.2.1.31.1.1.1.12 # ifHCOutMulticastPkts
      - 1.3.6.1.2.1.31.1.1.1.13 # ifHCOutBroadcastPkts
      - 1.3.6.1.2.1.31.1.1.1.15 # ifHighSpeed
      - 1.3.6.1.2.1.31.1.1.1.18 # ifAlias
      - 1.3.6.1.4.1.12356.101.3.2.1.1.2 # fgVdEntName
      - 1.3.6.1.4.1.12356.101.3.2.1.1.6 # fgVdEntMemUsage
      - 1.3.6.1.4.1.12356.101.3.2.1.1.7 # fgVdEntSesCount
      - 1.3.6.1.4.1.12356.101.4.1.1 # fgSysVersion
      - 1.3.6.1.4.1.12356.101.4.1.4 # fgSysMemUsage
      - 1.3.6.1.4.1.12356.101.4.1.6 # fgSysDiskUsage
      - 1.3.6.1.4.1.12356.101.4.1.8 # fgSysSesCount
      - 1.3.6.1.4.1.12356.101.4.1.15 # fgSysSes6Count
      - 1.3.6.1.4.1.12356.101.4.1.20 # fgSysUpTime
      - 1.3.6.1.4.1.12356.101.4.3.2.1.2 # fgHwSensorEntName
      - 1.3.6.1.4.1.12356.101.4.3.2.1.3 # fgHwSensorEntValue
      - 1.3.6.1.4.1.12356.101.4.3.2.1.4 # fgHwSensorEntAlarmStatus
      - 1.3.6.1.4.1.12356.101.12.1.1 # fgVpnTunnelUpCount
      - 1.3.6.1.4.1.12356.101.7.2.1.1.1 # fgIntfEntVdom
      - 1.3.6.1.4.1.12356.101.11.2.2.1.1 # fgIpSessNumber
      - 1.3.6.1.4.1.12356.101.11.2.3.1.1 # fgIp6SessNumber
      - 1.3.6.1.4.1.12356.101.12.2.2.1.2 # fgVpnTunEntPhase1Name
      - 1.3.6.1.4.1.12356.101.12.2.2.1.3 # fgVpnTunEntPhase2Name
      - 1.3.6.1.4.1.12356.101.12.2.2.1.18 # fgVpnTunEntInOctets
      - 1.3.6.1.4.1.12356.101.12.2.2.1.19 # fgVpnTunEntOutOctets
      - 1.3.6.1.4.1.12356.101.12.2.2.1.20 # fgVpnTunEntStatus
      - 1.3.6.1.4.1.12356.101.12.2.2.1.21 # fgVpnTunEntVdom
      - 1.3.6.1.4.1.12356.101.12.2.3.1.2 # fgVpnSslStatsLoginUsers
      - 1.3.6.1.4.1.12356.101.12.2.3.1.4 # fgVpnSslStatsActiveWebSessions
      - 1.3.6.1.4.1.12356.101.12.2.3.1.6 # fgVpnSslStatsActiveTunnels
      - 1.3.6.1.4.1.12356.101.12.2.4.1.2 # fgVpnSslTunnelVdom
      - 1.3.6.1.4.1.12356.101.12.2.4.1.3 # fgVpnSslTunnelUserName
      - 1.3.6.1.4.1.12356.101.12.2.4.1.4 # fgVpnSslTunnelSrcIp
      - 1.3.6.1.4.1.12356.101.12.2.4.1.7 # fgVpnSslTunnelBytesIn
      - 1.3.6.1.4.1.12356.101.12.2.4.1.8 # fgVpnSslTunnelBytesOut
      - 1.3.6.1.4.1.12356.101.14.2.3 # fgWcInfoWtpCapacity
      - 1.3.6.1.4.1.12356.101.14.2.5 # fgWcInfoWtpSessions
      - 1.3.6.1.4.1.12356.101.14.2.7 # fgWcInfoStationCount
      - 1.3.6.1.4.1.12356.101.14.4.3.1.3 # fgWcWtpConfigWtpName
      - 1.3.6.1.4.1.12356.101.14.4.4.1.3 # fgWcWtpSessionWtpIpAddress
      - 1.3.6.1.4.1.12356.101.14.4.4.1.6 # fgWcWtpSessionWtpBaseMacAddress
      - 1.3.6.1.4.1.12356.101.14.4.4.1.7 # fgWcWtpSessionConnectionState
      - 1.3.6.1.4.1.12356.101.14.4.4.1.8 # fgWcWtpSessionWtpUpTime
      - 1.3.6.1.4.1.12356.101.14.4.4.1.9 # fgWcWtpSessionWtpDaemonUpTime
      - 1.3.6.1.4.1.12356.101.14.4.4.1.10 # fgWcWtpSessionWtpSessionUpTime
      - 1.3.6.1.4.1.12356.101.14.4.4.1.12 # fgWcWtpSessionWtpModelNumber
      - 1.3.6.1.4.1.12356.101.14.4.4.1.14 # fgWcWtpSessionWtpSwVersion
      - 1.3.6.1.4.1.12356.101.14.4.4.1.17 # fgWcWtpSessionWtpStationCount
      - 1.3.6.1.4.1.12356.101.14.4.4.1.18 # fgWcWtpSessionWtpByteRxCount
      - 1.3.6.1.4.1.12356.101.14.4.4.1.19 # fgWcWtpSessionWtpByteTxCount
      - 1.3.6.1.4.1.12356.101.14.4.4.1.20 # fgWcWtpSessionWtpCpuUsage
      - 1.3.6.1.4.1.12356.101.14.4.4.1.21 # fgWcWtpSessionWtpMemoryUsage
      - 1.3.6.1.4.1.12356.101.14.4.5.1.7 # fgWcWtpSessionRadioOperatingChannel
      - 1.3.6.1.4.1.12356.101.14.4.5.1.8 # fgWcWtpSessionRadioOperatingPower
      - 1.3.6.1.4.1.12356.101.14.4.5.1.9 # fgWcWtpSessionRadioStationCount
      - 1.3.6.1.4.1.12356.101.14.4.6.1.3 # fgWcWtpSessionVapSsid
      - 1.3.6.1.4.1.12356.101.14.4.6.1.4 # fgWcWtpSessionVapStationCount
      - 1.3.6.1.4.1.12356.101.14.5.1.2 # fgWcStaWlan
      - 1.3.6.1.4.1.12356.101.14.5.1.3 # fgWcStaWtpId
      - 1.3.6.1.4.1.12356.101.14.5.1.7	# fgWcStaIpAddress
      - 1.3.6.1.4.1.12356.101.14.5.1.12 # fgWcStaSignal
      - 1.3.6.1.4.1.12356.101.14.5.1.13 # fgWcStaNoise
      - 1.3.6.1.4.1.12356.101.14.5.1.15 # fgWcStaBandwidthTx
      - 1.3.6.1.4.1.12356.101.14.5.1.16 # fgWcStaBandwidthRx
      - 1.3.6.1.4.1.12356.101.14.5.1.17 # fgWcStaChannel
      - 1.3.6.1.6.3.10.2.1.3 # snmpEngineTime
    overrides:
      fgHwSensorEntValue:
        regex_extracts:
          '':
          - regex: '(.*)'
            value: '$1'
      ifAdminStatus:
        type: DisplayString
      ifOperStatus:
        type: DisplayString
      fgWcWtpSessionVapSsid:
        type: DisplayString

4 replies

ghost Nov 11, 2024

I have fortinet generate.yml and my snmp.yml file created the module in fnfortinet so is this correct?

bastischubert Nov 12, 2024
Maintainer

not shure if i can answer that - have you used your generatede config and got all the necessary data in prometheus? guess then it works

HassanNetops Jan 26, 2025

Hi, I'm able to retrieve data for all OIDs except the interfaces. I ran your example file through the generator as well, but Prometheus is showing an error for it. When I remove the OIDs below from the "walk" section, Prometheus processes the YAML file correctly and the metrics show up. Could you please help me figure out what’s going wrong?

  - 1.3.6.1.2.1.1.1 # sysDescr
  - 1.3.6.1.2.1.1.3 # sysUpTime
  - 1.3.6.1.2.1.1.6 # sysLocation
  - 1.3.6.1.2.1.2.2.1.2 # ifDescr
  - 1.3.6.1.2.1.2.2.1.3 # ifType
  - 1.3.6.1.2.1.2.2.1.7 # ifAdminStatus
  - 1.3.6.1.2.1.2.2.1.8 # ifOperStatus
  - 1.3.6.1.2.1.2.2.1.13 # ifInDiscards
  - 1.3.6.1.2.1.2.2.1.14 # ifInErrors
  - 1.3.6.1.2.1.2.2.1.19 # ifOutDiscards
  - 1.3.6.1.2.1.2.2.1.20 # ifOutErrors
  - 1.3.6.1.2.1.15.3.1.2 # bgpPeerState
  - 1.3.6.1.2.1.15.3.1.3 # bgpPeerAdminStatus
  - 1.3.6.1.2.1.15.3.1.16 # bgpPeerFsmEstablishedTime
  - 1.3.6.1.2.1.15.6.1.3 # bgp4PathAttrIpAddrPrefix
  - 1.3.6.1.2.1.31.1.1.1.1 # ifName
  - 1.3.6.1.2.1.31.1.1.1.6 # ifHCInOctets
  - 1.3.6.1.2.1.31.1.1.1.7 # ifHCInUcastPkts
  - 1.3.6.1.2.1.31.1.1.1.8 # ifHCInMulticastPkts
  - 1.3.6.1.2.1.31.1.1.1.9 # ifHCInBroadcastPkts
  - 1.3.6.1.2.1.31.1.1.1.10 # ifHCOutOctets
  - 1.3.6.1.2.1.31.1.1.1.11 # ifHCOutUcastPkts
  - 1.3.6.1.2.1.31.1.1.1.12 # ifHCOutMulticastPkts
  - 1.3.6.1.2.1.31.1.1.1.13 # ifHCOutBroadcastPkts
  - 1.3.6.1.2.1.31.1.1.1.15 # ifHighSpeed
  - 1.3.6.1.2.1.31.1.1.1.18 # ifAlias

bastischubert Jan 28, 2025
Maintainer

can you please post the error that prometheus is showing and maybe clarify what exactly is throwing errors? prometheus itself should not work on neither generator.yml nor snmp.yml so i guess you're talking about generator or snmp_exporter

epieye · 2025-01-12T15:24:24Z

epieye
Jan 12, 2025

I struggled with this too. I haven't found comprehensive documentation either. I thank people like bastischubert for trying to help. I have a generator.yml similar to the one posted, except I used ifInOctets and ifOutOctets and not the mumerical OIDs.

I ran it with

./generator -m /usr/share/snmp/mibs/ generate

where usr/share/snmp/mibs/ contains the MIB files that I downloaded from my fortinet devices.

3 replies

HassanNetops Jan 26, 2025

@epieye Were you able to resolve this issue? I'm facing something similar where I can retrieve data for all OIDs except those under 1.3.6.1.2.1.*. When I remove these from the YAML file, the device status in Prometheus changes to "up."

epieye Jan 28, 2025

I did resolve my issue, but there was a lot of hacking, I'm not sure what the resolution really was. I know I had misunderstood a whole bunch of things to start with, but using the -m flag to point at the directory rather than a specific file was one. Unlike bastischubert, the names worked for me. Specifically in my generator.yml I have

if_mib:
walk:
- "ifInOctets"
- "ifOutOctets"

But I also tried his numerical values. I'm pretty sure this worked too.

system:
walk:
- 1.3.6.1.2.1.1.1 # sysDescr
- 1.3.6.1.2.1.1.3 # sysUpTime
- 1.3.6.1.2.1.1.6 # sysLocation

But I am only interested in network usage.

Another thing I got wrong was where names are just labels, and where they refer to another file (i.e. they must match). e.g. calling the module if_mib. Bastischubert called it fortinet_fortigate but he must've changed other things to match.

You may know all of that, but I had a steep learning curve coming from never using prometheus before.

Here is my entire generator.yml (including some commented out stuff that doesn't work). Hope it helps.

auths:
public_v1:
version: 1
public_v2:
version: 2

modules:
system:
walk:
- 1.3.6.1.2.1.1.1 # sysDescr
- 1.3.6.1.2.1.1.3 # sysUpTime
- 1.3.6.1.2.1.1.6 # sysLocation
- sysDescr
- sysUpTime

- "SNMPv2-MIB::system" # cannot find oid 'SNMPv2-MIB::system' to walk

SNMPv2-MIB::sysDescr.0 = STRING: FortiSwitch108E

SNMPv2-MIB::system

lookups:
  - source_indexes: [sysORIndex]
    lookup: "SNMPv2-MIB::sysORDescr"

if_mib:
walk:
- "ifInOctets"
- "ifOutOctets"
lookups:
- source_indexes: [ifIndex]
lookup: "ifAlias"
- source_indexes: [ifIndex]
lookup: "ifDescr"
- source_indexes: [ifIndex]
lookup: "ifName"
overrides:
ifAlias:
ignore: true # Lookup metric
ifDescr:
ignore: true # Lookup metric
ifName:
ignore: true # Lookup metric
ifType:
type: EnumAsInfo
ip_mib:
walk: [ipv4InterfaceTable]

bastischubert Jan 28, 2025
Maintainer

since i do not have access to a fortinet device currently i can't test it, but if you would be able to provide a fortigate device thats can be scraped i'm happy to build a module into the standard snmp.yml that we ship.

epieye · 2025-01-28T18:13:00Z

epieye
Jan 28, 2025

I guess I should've previewed that before posting it. Hopefully it is readable enough.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Help needed creatinging custom generator.yml #1151

{{title}}

Replies: 3 comments 7 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Help needed creatinging custom generator.yml #1151

andonovski Apr 3, 2024

Replies: 3 comments · 7 replies

bastischubert May 5, 2024 Maintainer

ghost Nov 11, 2024

bastischubert Nov 12, 2024 Maintainer

HassanNetops Jan 26, 2025

bastischubert Jan 28, 2025 Maintainer

epieye Jan 12, 2025

HassanNetops Jan 26, 2025

epieye Jan 28, 2025

- "SNMPv2-MIB::system" # cannot find oid 'SNMPv2-MIB::system' to walk

SNMPv2-MIB::sysDescr.0 = STRING: FortiSwitch108E

SNMPv2-MIB::system

bastischubert Jan 28, 2025 Maintainer

epieye Jan 28, 2025

andonovski
Apr 3, 2024

Replies: 3 comments 7 replies

bastischubert
May 5, 2024
Maintainer

bastischubert Nov 12, 2024
Maintainer

bastischubert Jan 28, 2025
Maintainer

epieye
Jan 12, 2025

bastischubert Jan 28, 2025
Maintainer

epieye
Jan 28, 2025