diff --git a/README.md b/README.md index 096a4420..2af376c5 100755 --- a/README.md +++ b/README.md @@ -45,6 +45,8 @@ Global: * `fortigate_sensor_thresholds` * _System/Status_ * `fortigate_version_info` + * _System/Transceivers_ + * `fortigate_interface_transceivers` * _System/Time/Clock_ * `fortigate_time_seconds` * _System/Resource/Usage_ @@ -99,6 +101,8 @@ Per-VDOM: * `fortigate_interface_receive_bytes_total` * `fortigate_interface_transmit_errors_total` * `fortigate_interface_receive_errors_total` + * _System/Interface/Transceivers_ + * `fortigate_inteface_transceivers_info` * _System/SDNConnector_ * `fortigate_system_sdn_connector_status` * `fortigate_system_sdn_connector_last_update_seconds` @@ -425,6 +429,7 @@ To improve security, limit permissions to required ones only (least privilege pr |System/Fortimanager/Status | sysgrp.cfg |api/v2/monitor/system/fortimanager/status | |System/HAStatistics | sysgrp.cfg |api/v2/monitor/system/ha-statistics
api/v2/cmdb/system/ha | |System/Interface | netgrp.cfg |api/v2/monitor/system/interface/select | +|System/Interface/Transceivers| *any* |api/v2/monitor/system/interface/transceivers | |System/LinkMonitor | sysgrp.cfg |api/v2/monitor/system/link-monitor | |System/Ntp/Status | netgrp.cfg |api/v2/monitor/system/ntp/status | |System/Resource/Usage | sysgrp.cfg |api/v2/monitor/system/resource/usage | diff --git a/pkg/probe/probe.go b/pkg/probe/probe.go index e84ee2fb..83259555 100644 --- a/pkg/probe/probe.go +++ b/pkg/probe/probe.go @@ -144,6 +144,7 @@ func (p *ProbeCollector) Probe(ctx context.Context, target map[string]string, hc {"System/Fortimanager/Status", probeSystemFortimanagerStatus}, {"System/HAStatistics", probeSystemHAStatistics}, {"System/Interface", probeSystemInterface}, + {"System/Interface/Transceivers", probeSystemInterfaceTransceivers}, {"System/LinkMonitor", probeSystemLinkMonitor}, {"System/Ntp/Status", probeSystemNtpStatus}, {"System/Resource/Usage", probeSystemResourceUsage}, diff --git a/pkg/probe/system_interface_transceivers.go b/pkg/probe/system_interface_transceivers.go new file mode 100644 index 00000000..11a1729c --- /dev/null +++ b/pkg/probe/system_interface_transceivers.go @@ -0,0 +1,56 @@ +// Copyright 2025 The Prometheus Authors +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package probe + +import ( + "log" + + "github.com/prometheus-community/fortigate_exporter/pkg/http" + "github.com/prometheus/client_golang/prometheus" +) + +func probeSystemInterfaceTransceivers(c http.FortiHTTP, meta *TargetMetadata) ([]prometheus.Metric, bool) { + var ( + interfaceTransceivers = prometheus.NewDesc( + "fortigate_inteface_transceivers_info", + "Interface transceivers information", + []string{"interface", "type", "vendor", "vendorpartnumber", "vendorserialnumber"}, nil, + ) + ) + + type SystemInterfaceTransceiversResult struct { + Interface string `json:"interface"` + Type string `json:"type"` + Vendor string `json:"vendor"` + VendorPartNumber string `json:"vendor_part_number"` + VendorSerialNumber string `json:"vendor_serial_number"` + } + + type SystemInterfaceTransceivers struct { + Results []SystemInterfaceTransceiversResult `json:"results"` + } + + var res SystemInterfaceTransceivers + if err := c.Get("api/v2/monitor/system/interface/transceivers", "scope=global", &res); err != nil { + log.Printf("Warning: %v", err) + return nil, false + } + + m := []prometheus.Metric{} + for _, r := range res.Results { + m = append(m, prometheus.MustNewConstMetric(interfaceTransceivers, prometheus.GaugeValue, 1.0, r.Interface, r.Type, r.Vendor, r.VendorPartNumber, r.VendorSerialNumber)) + } + + return m, true +} \ No newline at end of file diff --git a/pkg/probe/system_interface_transceivers_test.go b/pkg/probe/system_interface_transceivers_test.go new file mode 100755 index 00000000..52e28db7 --- /dev/null +++ b/pkg/probe/system_interface_transceivers_test.go @@ -0,0 +1,31 @@ +package probe + +import ( + "strings" + "testing" + + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/testutil" +) + +func TestSystemInterfaceTransceivers(t *testing.T) { + c := newFakeClient() + c.prepare("api/v2/monitor/system/interface/transceivers", "testdata/interface-transceivers.jsonnet") + r := prometheus.NewPedanticRegistry() + if !testProbe(probeSystemInterfaceTransceivers, c, r) { + t.Errorf("probeSystemInterfaceTransceivers() returned non-success") + } + + em := ` + # HELP fortigate_inteface_transceivers_info Interface transceivers information + # TYPE fortigate_inteface_transceivers_info gauge + fortigate_inteface_transceivers_info{interface="ha1",type="SFP/SFP+/SFP28",vendor="FORTINET",vendorpartnumber="FTL",vendorserialnumber="U00000"} 1 + fortigate_inteface_transceivers_info{interface="ha2",type="SFP/SFP+/SFP28",vendor="FORTINET",vendorpartnumber="FTL",vendorserialnumber="U00000"} 1 + fortigate_inteface_transceivers_info{interface="port33",type="QSFP/QSFP+",vendor="FORTINET",vendorpartnumber="FTL",vendorserialnumber="U00000"} 1 + fortigate_inteface_transceivers_info{interface="port34",type="QSFP/QSFP+",vendor="FORTINET",vendorpartnumber="FTL",vendorserialnumber="U00000"} 1 + ` + + if err := testutil.GatherAndCompare(r, strings.NewReader(em)); err != nil { + t.Fatalf("metric compare: err %v", err) + } +} diff --git a/pkg/probe/testdata/interface-transceivers.jsonnet b/pkg/probe/testdata/interface-transceivers.jsonnet new file mode 100644 index 00000000..aae513c9 --- /dev/null +++ b/pkg/probe/testdata/interface-transceivers.jsonnet @@ -0,0 +1,42 @@ +# api/v2/monitor/system/interface/transceivers?scope=global +{ + "http_method":"GET", + "results":[ + { + "type":"QSFP\/QSFP+", + "vendor":"FORTINET", + "vendor_part_number":"FTL", + "vendor_serial_number":"U00000", + "interface":"port33" + }, + { + "type":"QSFP\/QSFP+", + "vendor":"FORTINET", + "vendor_part_number":"FTL", + "vendor_serial_number":"U00000", + "interface":"port34" + }, + { + "type":"SFP\/SFP+\/SFP28", + "vendor":"FORTINET", + "vendor_part_number":"FTL", + "vendor_serial_number":"U00000", + "interface":"ha1" + }, + { + "type":"SFP\/SFP+\/SFP28", + "vendor":"FORTINET", + "vendor_part_number":"FTL", + "vendor_serial_number":"U00000", + "interface":"ha2" + } + ], + "vdom":"root", + "path":"system", + "name":"interface", + "action":"transceivers", + "status":"success", + "serial":"F2", + "version":"v7.4.5", + "build":2702 +}