Merge branch 'main' into feature/sdn-connector-v7.6

Author: bastischubert

.github/workflows/golangci-lint.yml

@@ -28,7 +28,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Install Go
-        uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0
+        uses: actions/setup-go@4b73464bb391d4059bd26b0524d20df3927bd417 # v6.3.0
         with:
           go-version: 1.25.x
       - name: Install snmp_exporter/generator dependencies

README.md

@@ -182,6 +182,7 @@ To improve security, limit permissions to required ones only (least privilege pr
 |System/AvailableCertificates | *any*              |api/v2/monitor/system/available-certificates |
 |System/Central-management/Status | sysgrp.cfg         |api/v2/monitor/system/central-management/status|
 |System/Fortimanager/Status   | sysgrp.cfg         |api/v2/monitor/system/fortimanager/status |
+|System/Global/Location       | sysgrp.cfg         |api/v2/cmdb/system/global |
 |System/HAStatistics          | sysgrp.cfg         |api/v2/monitor/system/ha-statistics<br>api/v2/cmdb/system/ha |
 |System/Ha-peer               | sysgrp.cfg         |api/v2/monitor/system/ha-peer |
 |System/Interface             | netgrp.cfg         |api/v2/monitor/system/interface/select |

metrics.md

@@ -4,6 +4,8 @@ Global:
 
  * _Network/Dns/Latency_
    * `fortigate_network_dns_latency_`
+ * _System/Global/Location_
+   * `fortigate_location_info`
  * _System/SensorInfo_
    * `fortigate_sensor_alarm_status`
    * `fortigate_sensor_fan_rpm`
@@ -12,6 +14,7 @@ Global:
    * `fortigate_sensor_thresholds`
  * _System/Status_
    * `fortigate_version_info`
+   * `fortigate_system_status_log_disk_state`
  * _System/Transceivers_
    * `fortigate_interface_transceivers`
  * _System/Time/Clock_

pkg/probe/probe.go

@@ -147,6 +147,7 @@ func (p *Collector) Probe(ctx context.Context, target map[string]string, hc *htt
 		{"System/AvailableCertificates", probeSystemAvailableCertificates},
 		{"System/Central-Management/Status", probeSystemCentralManagementStatus},
 		{"System/Fortimanager/Status", probeSystemFortimanagerStatus},
+		{"System/Global/Location", probeSystemGlobalLocation},
 		{"System/HAStatistics", probeSystemHAStatistics},
 		{"System/Ha-peer", probeSystemHaPeer},
 		{"System/Interface", probeSystemInterface},

pkg/probe/system_global_location.go

@@ -0,0 +1,75 @@
+// Copyright 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 (
+	"encoding/json"
+	"log"
+
+	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/fortigate_exporter/pkg/http"
+)
+
+func probeSystemGlobalLocation(c http.FortiHTTP, _ *TargetMetadata) ([]prometheus.Metric, bool) {
+	location := prometheus.NewDesc(
+		"fortigate_location_info",
+		"System geographic location (static metadata)",
+		[]string{"latitude", "longitude"},
+		nil,
+	)
+
+	type SystemGlobalLocation struct {
+		Latitude  string `json:"gui-device-latitude"`
+		Longitude string `json:"gui-device-longitude"`
+	}
+
+	type systemGlobalLocationResponse struct {
+		Results json.RawMessage `json:"results"`
+	}
+
+	var resp systemGlobalLocationResponse
+
+	if err := c.Get("api/v2/cmdb/system/global", "vdom=root", &resp); err != nil {
+		log.Printf("Error: %v", err)
+		return nil, false
+	}
+
+	var loc SystemGlobalLocation
+
+	// Try object first
+	if err := json.Unmarshal(resp.Results, &loc); err != nil {
+		// Fallback to array
+		var arr []SystemGlobalLocation
+		if err := json.Unmarshal(resp.Results, &arr); err != nil || len(arr) == 0 {
+			return nil, true
+		}
+		loc = arr[0]
+	}
+
+	if loc.Latitude == "" || loc.Longitude == "" {
+		return nil, true
+	}
+
+	m := []prometheus.Metric{
+		prometheus.MustNewConstMetric(
+			location,
+			prometheus.GaugeValue,
+			1,
+			loc.Latitude,
+			loc.Longitude,
+		),
+	}
+	return m, true
+}

pkg/probe/system_global_location_test.go

@@ -0,0 +1,41 @@
+// Copyright 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 (
+	"strings"
+	"testing"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/testutil"
+)
+
+func TestSystemGlobalLocation(t *testing.T) {
+	c := newFakeClient()
+	c.prepare("api/v2/cmdb/system/global", "testdata/system-global-location.jsonnet")
+	r := prometheus.NewPedanticRegistry()
+	if !testProbe(probeSystemGlobalLocation, c, r) {
+		t.Errorf("probeSystemGlobalLocation() returned non-success")
+	}
+
+	em := `
+	# HELP fortigate_location_info System geographic location (static metadata)
+	# TYPE fortigate_location_info gauge
+	fortigate_location_info{latitude="66.543508", longitude="25.8467468"} 1
+	`
+
+	if err := testutil.GatherAndCompare(r, strings.NewReader(em)); err != nil {
+		t.Fatalf("metric compare: err %v", err)
+	}
+}

pkg/probe/system_status.go

@@ -26,14 +26,28 @@ func probeSystemStatus(c http.FortiHTTP, _ *TargetMetadata) ([]prometheus.Metric
 	mVersion := prometheus.NewDesc(
 		"fortigate_version_info",
 		"System version and build information",
-		[]string{"serial", "version", "build"}, nil,
+		[]string{"serial", "version", "build", "model_name", "model_number", "model", "hostname"}, nil,
 	)
+	mLogDiskState := prometheus.NewDesc(
+		"fortigate_system_status_log_disk_state",
+		"System log disk availability state",
+		[]string{"state"}, nil,
+	)
+
+	type systemResult struct {
+		Name          string `json:"model_name"`
+		Number        string `json:"model_number"`
+		Model         string `json:"model"`
+		Hostname      string `json:"hostname"`
+		LogDiskStatus string `json:"log_disk_status"`
+	}
 
 	type systemStatus struct {
 		Status  string
 		Serial  string
 		Version string
 		Build   int64
+		Results systemResult
 	}
 	var st systemStatus
 
@@ -43,7 +57,18 @@ func probeSystemStatus(c http.FortiHTTP, _ *TargetMetadata) ([]prometheus.Metric
 	}
 
 	m := []prometheus.Metric{
-		prometheus.MustNewConstMetric(mVersion, prometheus.GaugeValue, 1.0, st.Serial, st.Version, fmt.Sprintf("%d", st.Build)),
+		prometheus.MustNewConstMetric(mLogDiskState, prometheus.GaugeValue, 0.0, "available"),
+		prometheus.MustNewConstMetric(mLogDiskState, prometheus.GaugeValue, 0.0, "need_format"),
+		prometheus.MustNewConstMetric(mLogDiskState, prometheus.GaugeValue, 0.0, "not_available"),
+	}
+	switch st.Results.LogDiskStatus {
+	case "available":
+		m[0] = prometheus.MustNewConstMetric(mLogDiskState, prometheus.GaugeValue, 1.0, st.Results.LogDiskStatus)
+	case "need_format":
+		m[1] = prometheus.MustNewConstMetric(mLogDiskState, prometheus.GaugeValue, 1.0, st.Results.LogDiskStatus)
+	case "not_available":
+		m[2] = prometheus.MustNewConstMetric(mLogDiskState, prometheus.GaugeValue, 1.0, st.Results.LogDiskStatus)
 	}
+	m = append(m, prometheus.MustNewConstMetric(mVersion, prometheus.GaugeValue, 1.0, st.Serial, st.Version, fmt.Sprintf("%d", st.Build), st.Results.Name, st.Results.Number, st.Results.Model, st.Results.Hostname))
 	return m, true
 }

pkg/probe/system_status_test.go

@@ -30,9 +30,14 @@ func TestSystemStatus(t *testing.T) {
 	}
 
 	em := `
+	# HELP fortigate_system_status_log_disk_state System log disk availability state
+	# TYPE fortigate_system_status_log_disk_state gauge
+	fortigate_system_status_log_disk_state{state="available"} 0
+	fortigate_system_status_log_disk_state{state="need_format"} 0
+	fortigate_system_status_log_disk_state{state="not_available"} 1
 	# HELP fortigate_version_info System version and build information
 	# TYPE fortigate_version_info gauge
-	fortigate_version_info{build="1112",serial="FGVMEVZFNTS3OAC8",version="v6.2.4"} 1
+	fortigate_version_info{build="1112",hostname="fgt-test-1",model="F2K60F",model_name="FortiGate",model_number="2600F",serial="FGVMEVZFNTS3OAC8",version="v6.2.4"} 1
 	`
 
 	if err := testutil.GatherAndCompare(r, strings.NewReader(em)); err != nil {

pkg/probe/testdata/status.jsonnet

@@ -2,6 +2,11 @@
 {
   "http_method":"GET",
   "results":{
+    "model_name":"FortiGate",
+    "model_number":"2600F",
+    "model":"F2K60F",
+    "hostname":"fgt-test-1",
+    "log_disk_status":"not_available"
   },
   "vdom":"root",
   "path":"system",
@@ -10,4 +15,4 @@
   "serial":"FGVMEVZFNTS3OAC8",
   "version":"v6.2.4",
   "build":1112
-}
+}