SNMP: fortinet-fortigate.yaml and remove un-needed profile (#20374)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
Fotis Voutsas committed
May 29, 2025 at 13:58 UTC
6da495387d7dd638ff0aafdd432dc368a50c7a23
2 files changed
+84
-80
src/go/plugin/go.d/config/go.d/snmp.profiles/default/_fortinet-fortigate-cpu-memory.yaml
deleted
-23
@@ -1,23 +0,0 @@
1
-# CPU and memory metrics for Fortinet FortiGate devices
2
-metrics:
3
- ### CPU
4
- - MIB: FORTINET-FORTIGATE-MIB
5
- symbol:
6
- # Current CPU usage (percentage).
7
- OID: 1.3.6.1.4.1.12356.101.4.1.3.0
8
- # core check only
9
- name: cpu.usage
10
- description: Current CPU usage
11
- family: Fortinet/Fortigate/CPU/Utilization
12
- unit: "%"
13
-
14
- ### Memory
15
- - MIB: FORTINET-FORTIGATE-MIB
16
- symbol:
17
- # Current memory utilization (percentage).
18
- OID: 1.3.6.1.4.1.12356.101.4.1.4.0
19
- # core check only
20
- name: memory.usage
21
- description: Current memory utilization
22
- family: Fortinet/Fortigate/Memory/Utilization
23
- unit: "%"
src/go/plugin/go.d/config/go.d/snmp.profiles/default/fortinet-fortigate.yaml
+84
-57
@@ -5,7 +5,6 @@
5
extends:
6
- _base.yaml
7
- _generic-if.yaml
8
- - _fortinet-fortigate-cpu-memory.yaml
8
- _fortinet-fortigate-vpn-tunnel.yaml
9
10
device:
@@ -15,7 +14,6 @@ device:
14
# We only target Fortinet Fortigate devices (1.3.6.1.4.1.12356.101/fnFortiGateMib)
15
sysobjectid: 1.3.6.1.4.1.12356.101.1.*
16
18
-
17
# Note related to use of index `1` of entPhysicalTable columns:
18
# Based on snmpwalks of Fortigate devices, the main/chassis hardware have the index `1`
19
# Librennms is also using index `1`: https://github.com/librenms/librenms/blob/1ac60e3b1d90616119f3c4adc28213e3c35c2477/includes/definitions/discovery/fortigate.yaml#L10-L13
@@ -27,7 +25,7 @@ metadata:
25
serial_number:
26
symbol:
27
MIB: ENTITY-MIB
30
- OID: 1.3.6.1.2.1.47.1.1.1.1.11.1 # entPhysicalSerialNum OID at index `1`
28
+ OID: 1.3.6.1.2.1.47.1.1.1.1.11.1 # entPhysicalSerialNum OID at index `1`
29
name: entPhysicalSerialNum
30
# Examples: `FG5H1E1110000000`
31
version:
@@ -40,14 +38,14 @@ metadata:
38
# - v5.4.8,build1183,180115 (GA)
39
product_name:
40
symbol:
43
- OID: 1.3.6.1.2.1.47.1.1.1.1.10.1 # entPhysicalName OID at index `1`
41
+ OID: 1.3.6.1.2.1.47.1.1.1.1.10.1 # entPhysicalName OID at index `1`
42
name: entPhysicalSoftwareRev
43
match_pattern: '^(\S+)\s+'
46
- match_value: '$1'
44
+ match_value: "$1"
45
# Examples: `FortiGate-1500D` from `FortiGate-1500D v5.4.8,build1183b1183,180115 (GA)`
46
model:
47
symbol:
50
- OID: 1.3.6.1.2.1.47.1.1.1.1.13.1 # entPhysicalModelName OID at index `1`
48
+ OID: 1.3.6.1.2.1.47.1.1.1.1.13.1 # entPhysicalModelName OID at index `1`
49
name: entPhysicalModelName
50
# Examples: `FGT_501E`
51
os_name:
@@ -63,43 +61,41 @@ metadata:
61
OID: 1.3.6.1.4.1.12356.101.4.1.1.0
62
name: fgSysVersion
63
match_pattern: 'v([\d.]+)'
66
- match_value: '$1'
64
+ match_value: "$1"
65
# Examples: `5.6.4` from `v5.6.4,build1575,180425 (GA)`
66
67
metrics:
70
-
68
### CPU
69
- MIB: FORTINET-FORTIGATE-MIB
70
symbol:
74
- # Current CPU usage (percentage).
71
OID: 1.3.6.1.4.1.12356.101.4.1.3.0
72
name: fgSysCpuUsage
77
- description: Current CPU usage (percentage)
73
+ description: Current CPU usage
74
+ family: Fortinet/Fortigate/CPU/Utilization
75
unit: "%"
76
77
### Processors
81
- # Only valid for processors types that support these statistics.
78
- MIB: FORTINET-FORTIGATE-MIB
79
table:
80
OID: 1.3.6.1.4.1.12356.101.4.4.2
81
name: fgProcessorTable
82
metric_type: monotonic_count_and_rate
83
symbols:
88
- # The total number of packets received by this processor.
84
- OID: 1.3.6.1.4.1.12356.101.4.4.2.1.6
85
name: fgProcessorPktRxCount
86
description: Number of packets received by this processor
87
+ family: Fortinet/Fortigate/CPU/Packets
88
unit: "{packet}"
93
- # The total number of packets transmitted by this processor.
89
- OID: 1.3.6.1.4.1.12356.101.4.4.2.1.7
90
name: fgProcessorPktTxCount
91
description: Number of packets transmitted by this processor
92
+ family: Fortinet/Fortigate/CPU/Packets
93
unit: "{packet}"
98
- # The total number of packets dropped by this processor.
94
- OID: 1.3.6.1.4.1.12356.101.4.4.2.1.8
95
name: fgProcessorPktDroppedCount
96
description: Number of packets dropped by this processor
102
- unit: "{packet}"
97
+ family: Fortinet/Fortigate/CPU/Packets
98
+ unit: "{drop}"
99
metric_tags:
100
# A unique identifier within the fgProcessorTable.
101
- tag: processor_index
@@ -114,12 +110,14 @@ metrics:
110
# The processor's CPU usage (percentage), which is an average calculated over the last minute.
111
- OID: 1.3.6.1.4.1.12356.101.4.4.2.1.2
112
name: fgProcessorUsage
117
- description: Processor CPU usage (percentage) averaged over last minute
113
+ description: Processor CPU usage averaged over last minute
114
+ family: Fortinet/Fortigate/CPU/Utilization
115
unit: "%"
116
# The processor's CPU system space usage, which is an average calculated over the last minute.
117
- OID: 1.3.6.1.4.1.12356.101.4.4.2.1.10
118
name: fgProcessorSysUsage
119
description: Processor CPU system space usage averaged over last minute
120
+ family: Fortinet/Fortigate/CPU/Utilization
121
unit: "%"
122
metric_tags:
123
# A unique identifier within the fgProcessorTable.
@@ -134,7 +132,8 @@ metrics:
132
# Current memory utilization (percentage).
133
OID: 1.3.6.1.4.1.12356.101.4.1.4.0
134
name: fgSysMemUsage
137
- description: Current memory utilization (percentage)
135
+ description: Current memory utilization
136
+ family: Fortinet/Fortigate/Memory
137
unit: "%"
138
- MIB: FORTINET-FORTIGATE-MIB
139
symbol:
@@ -142,13 +141,15 @@ metrics:
141
OID: 1.3.6.1.4.1.12356.101.4.1.5.0
142
name: fgSysMemCapacity
143
description: Total physical memory installed in kilobytes
144
+ family: Fortinet/Fortigate/Memory
145
unit: "kBy"
146
- MIB: FORTINET-FORTIGATE-MIB
147
symbol:
148
# Current lowmem utilization (percentage). Lowmem is memory available for the kernel's own data structures and kernel specific tables. The system can get into a bad state if it runs out of lowmem.
149
OID: 1.3.6.1.4.1.12356.101.4.1.9.0
150
name: fgSysLowMemUsage
151
- description: Current low memory utilization (percentage)
151
+ description: Current low memory utilization
152
+ family: Fortinet/Fortigate/Memory
153
unit: "%"
154
- MIB: FORTINET-FORTIGATE-MIB
155
symbol:
@@ -156,6 +157,7 @@ metrics:
157
OID: 1.3.6.1.4.1.12356.101.4.1.10.0
158
name: fgSysLowMemCapacity
159
description: Total low memory capacity in kilobytes
160
+ family: Fortinet/Fortigate/Memory
161
unit: "kBy"
162
163
### Disk
@@ -165,6 +167,7 @@ metrics:
167
OID: 1.3.6.1.4.1.12356.101.4.1.6.0
168
name: fgSysDiskUsage
169
description: Current hard disk usage in megabytes
170
+ family: Fortinet/Fortigate/Storage/Disk
171
unit: "MBy"
172
- MIB: FORTINET-FORTIGATE-MIB
173
symbol:
@@ -172,6 +175,7 @@ metrics:
175
OID: 1.3.6.1.4.1.12356.101.4.1.7.0
176
name: fgSysDiskCapacity
177
description: Total hard disk capacity in megabytes
178
+ family: Fortinet/Fortigate/Storage/Disk
179
unit: "MBy"
180
181
### Virtual Domains
@@ -184,32 +188,46 @@ metrics:
188
# Operation mode of the virtual domain: nat(1), transparent(2)
189
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.3
190
name: fgVdEntOpMode
187
- description: Operation mode of the virtual domain (nat or transparent)
188
- unit: "TBD"
191
+ description: Operation mode of the virtual domain
192
+ family: Fortinet/Fortigate/Virtual Domains/Operation Mode
193
+ unit: "{status}"
194
+ mapping:
195
+ 1: master
196
+ 2: backup
197
+ 3: standalone
198
# HA cluster member state of the virtual domain on this device: master(1), backup(2), standalone(3)
199
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.4
200
name: fgVdEntHaState
201
description: HA cluster member state of the virtual domain
193
- unit: "TBD"
202
+ family: Fortinet/Fortigate/Virtual Domains/High Availability
203
+ unit: "{status}"
204
+ mapping:
205
+ 1: master
206
+ 2: backup
207
+ 3: standalone
208
# CPU usage of the virtual domain (percentage).
209
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.5
210
name: fgVdEntCpuUsage
197
- description: CPU usage of the virtual domain (percentage)
211
+ description: CPU usage of the virtual domain
212
+ family: Fortinet/Fortigate/Virtual Domains/CPU
213
unit: "%"
214
# Memory usage of the virtual domain (percentage).
215
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.6
216
name: fgVdEntMemUsage
202
- description: Memory usage of the virtual domain (percentage)
217
+ description: Memory usage of the virtual domain
218
+ family: Fortinet/Fortigate/Virtual Domains/Memory
219
unit: "%"
220
# Number of active sessions on the virtual domain.
221
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.7
222
name: fgVdEntSesCount
223
description: Number of active sessions on the virtual domain
224
+ family: Fortinet/Fortigate/Virtual Domains/Sessions
225
unit: "{session}"
226
# The session setup rate on the virtual domain.
227
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.8
228
name: fgVdEntSesRate
229
description: Session setup rate on the virtual domain
230
+ family: Fortinet/Fortigate/Virtual Domains/Sessions
231
unit: "1.s"
232
metric_tags:
233
- tag: virtualdomain_index
@@ -226,9 +244,15 @@ metrics:
244
OID: 1.3.6.1.4.1.12356.101.3.2.1
245
name: fgVdTable
246
symbols:
229
- - name: fgVirtualDomain
230
- constant_value_one: true
231
- # TODO: Check out metric_tags with symbols having mappings and/or expressing states/statuses. Need to convert to metrics.
247
+ - OID: 1.3.6.1.4.1.12356.101.3.2.1.1.4
248
+ name: fgVdEntHaState
249
+ description: HA cluster member state of the virtual domain on this device
250
+ family: Fortinet/Fortigate/Virtual Domains/High Availability
251
+ unit: "{status}"
252
+ mapping:
253
+ 1: primary
254
+ 2: secondary
255
+ 3: standalone
256
metric_tags:
257
- tag: virtualdomain_index
258
symbol:
@@ -238,14 +262,6 @@ metrics:
262
symbol:
263
OID: 1.3.6.1.4.1.12356.101.3.2.1.1.2
264
name: fgVdEntName
241
- - tag: virtualdomain_state
242
- symbol:
243
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.4
244
- name: fgVdEntHaState
245
- mapping:
246
- 1: primary
247
- 2: secondary
248
- 3: standalone
265
266
- MIB: FORTINET-FORTIGATE-MIB
267
symbol:
@@ -253,38 +269,39 @@ metrics:
269
OID: 1.3.6.1.4.1.12356.101.3.1.1.0
270
name: fgVdNumber
271
description: Number of virtual domains in vdTable
256
- unit: "{virtual_domain}"
272
+ family: Fortinet/Fortigate/Virtual Domains
273
+ unit: "{domain}"
274
- MIB: FORTINET-FORTIGATE-MIB
275
symbol:
276
# The maximum number of virtual domains allowed on the device as allowed by hardware and/or licensing.
277
OID: 1.3.6.1.4.1.12356.101.3.1.2.0
278
name: fgVdMaxVdoms
279
description: Maximum number of virtual domains allowed on the device
263
- unit: "{virtual_domain}"
280
+ family: Fortinet/Fortigate/Virtual Domains
281
+ unit: "{domain}"
282
283
### Interfaces
284
# Fortinet specific extensions to MIB-2 ifTable.
267
- - MIB: FORTINET-FORTIGATE-MIB
268
- table:
269
- OID: 1.3.6.1.4.1.12356.101.7.2.1
270
- name: fgIntfTable
271
- symbols:
272
- - OID: 1.3.6.1.4.1.12356.101.7.2.1.1.1
273
- name: fgIntfEntVdom
274
- # TODO: Check out metric_tags with symbols having mappings and/or expressing states/statuses. Need to convert to metrics.
275
- metric_tags:
276
- # The virtual domain the interface belongs to. This index corresponds to the index used by fgVdTable.
277
- - tag: virtualdomain_index
278
- symbol:
279
- OID: 1.3.6.1.4.1.12356.101.3.2.1.1.1
280
- name: fgVdEntIndex
281
- - MIB: IF-MIB
282
- symbol:
283
- OID: 1.3.6.1.2.1.31.1.1.1.1
284
- name: ifName
285
- table: ifXTable
286
- tag: interface
287
-
285
+ # - MIB: FORTINET-FORTIGATE-MIB
286
+ # table:
287
+ # OID: 1.3.6.1.4.1.12356.101.7.2.1
288
+ # name: fgIntfTable
289
+ # symbols:
290
+ # - OID: 1.3.6.1.4.1.12356.101.7.2.1.1.1
291
+ # name: fgIntfEntVdom
292
+ # description: The virtual domain the interface belongs to. This index corresponds to the index used by fgVdTable.
293
+ # unit: "1"
294
+ # metric_tags:
295
+ # - tag: virtualdomain_index
296
+ # symbol:
297
+ # OID: 1.3.6.1.4.1.12356.101.3.2.1.1.1
298
+ # name: fgVdEntIndex
299
+ # - MIB: IF-MIB
300
+ # symbol:
301
+ # OID: 1.3.6.1.2.1.31.1.1.1.1
302
+ # name: ifName
303
+ # table: ifXTable
304
+ # tag: interface
305
306
### Sessions
307
- MIB: FORTINET-FORTIGATE-MIB
@@ -293,6 +310,7 @@ metrics:
310
OID: 1.3.6.1.4.1.12356.101.4.1.8.0
311
name: fgSysSesCount
312
description: Number of active sessions on the device
313
+ family: Fortinet/Fortigate/Sessions
314
unit: "{session}"
315
- MIB: FORTINET-FORTIGATE-MIB
316
symbol:
@@ -300,6 +318,7 @@ metrics:
318
OID: 1.3.6.1.4.1.12356.101.4.1.11.0
319
name: fgSysSesRate1
320
description: Average session setup rate over the past minute
321
+ family: Fortinet/Fortigate/Sessions
322
unit: "1.s"
323
- MIB: FORTINET-FORTIGATE-MIB
324
symbol:
@@ -307,6 +326,7 @@ metrics:
326
OID: 1.3.6.1.4.1.12356.101.4.1.15.0
327
name: fgSysSes6Count
328
description: Number of active IPv6 sessions on the device
329
+ family: Fortinet/Fortigate/Sessions
330
unit: "{session}"
331
- MIB: FORTINET-FORTIGATE-MIB
332
symbol:
@@ -314,6 +334,7 @@ metrics:
334
OID: 1.3.6.1.4.1.12356.101.4.1.16.0
335
name: fgSysSes6Rate1
336
description: Average IPv6 session setup rate over the past minute
337
+ family: Fortinet/Fortigate/Sessions
338
unit: "1.s"
339
- MIB: FORTINET-FORTIGATE-MIB
340
symbol:
@@ -321,6 +342,7 @@ metrics:
342
OID: 1.3.6.1.4.1.12356.101.10.100.4.0
343
name: fgApHTTPConnections
344
description: Current number of HTTP proxy connections
345
+ family: Fortinet/Fortigate/HTTPProxy/Connections
346
unit: "{connection}"
347
- MIB: FORTINET-FORTIGATE-MIB
348
symbol:
@@ -328,6 +350,7 @@ metrics:
350
OID: 1.3.6.1.4.1.12356.101.10.100.5.0
351
name: fgApHTTPMaxConnections
352
description: Maximum number of connections supported by HTTP proxy
353
+ family: Fortinet/Fortigate/HTTP/Proxy/Connections
354
unit: "{connection}"
355
356
### Firewall
@@ -342,11 +365,13 @@ metrics:
365
- OID: 1.3.6.1.4.1.12356.101.5.1.2.1.1.2
366
name: fgFwPolPktCount
367
description: Number of packets matched to firewall policy
368
+ family: Fortinet/Fortigate/Firewall/Policy/Packets
369
unit: "{packet}"
370
# Number of bytes in packets matching the policy.
371
- OID: 1.3.6.1.4.1.12356.101.5.1.2.1.1.3
372
name: fgFwPolByteCount
373
description: Number of bytes in packets matching firewall policy
374
+ family: Fortinet/Fortigate/Firewall/Policy/Packets
375
unit: "By"
376
metric_tags:
377
# Internal virtual domain index used to uniquely identify rows in this table. This index is also used by other tables referencing a virtual domain.
@@ -366,11 +391,13 @@ metrics:
391
- OID: 1.3.6.1.4.1.12356.101.5.1.2.2.1.2
392
name: fgFwPol6PktCount
393
description: Number of packets matched to firewall policy6
394
+ family: Fortinet/Fortigate/Firewall/Policy6/Packets
395
unit: "{packet}"
396
# Number of bytes in packets matching the policy. See fgFwPol6PktCount.
397
- OID: 1.3.6.1.4.1.12356.101.5.1.2.2.1.3
398
name: fgFwPol6ByteCount
399
description: Number of bytes in packets matching firewall policy6
400
+ family: Fortinet/Fortigate/Firewall/Policy6/Packets
401
unit: "By"
402
metric_tags:
403
# Internal virtual domain index used to uniquely identify rows in this table. This index is also used by other tables referencing a virtual domain.