Adding support for the collection of Component Firmware Version and other details

exporter/exporter.go

@@ -64,6 +64,8 @@ const (
 	STORAGEBATTERY = "StorBatteryMetrics"
 	// ILOSELFTEST represents the processor metric endpoints
 	ILOSELFTEST = "iloSelfTestMetrics"
+	// FIRMWAREINVENTORY represents the component firmware metric endpoints
+	FIRMWAREINVENTORY = "FirmwareInventoryMetrics"
 	// OK is a string representation of the float 1.0 for device status
 	OK = 1.0
 	// BAD is a string representation of the float 0.0 for device status
@@ -360,6 +362,24 @@ func NewExporter(ctx context.Context, target, uri, profile, model string, exclud
 		zap.Strings("physical_drive_endpoints", driveEndpointsResp.physicalDriveURLs),
 		zap.Any("trace_id", ctx.Value("traceID")))
 
+	// Call /redfish/v1/Managers/XXXX/UpdateService/FirmwareInventory/ for firmware inventory
+	firmwareInventoryEndpoints, err := getMemberUrls(exp.url+uri+"/UpdateService/FirmwareInventory/", target, retryClient)
+	if err != nil {
+		// Try the iLo 4 firmware inventory endpoint
+		// Use the collected sysEndpoints.systems to build url(s)
+		if len(sysEndpoints.systems) > 0 {
+			// call /redfish/v1/Systems/XXXX/FirmwareInventory/
+			for _, system := range sysEndpoints.systems {
+				firmwareInventoryEndpoints = append(firmwareInventoryEndpoints, system+"FirmwareInventory/")
+			}
+			// Ensure we have at least one firmware inventory endpoint
+			if len(firmwareInventoryEndpoints) == 0 {
+				log.Error("error when getting FirmwareInventory url", zap.Error(err), zap.Any("trace_id", ctx.Value("traceID")))
+				return nil, err
+			}
+		}
+	}
+
 	// Loop through arrayControllerURLs, logicalDriveURLs, physicalDriveURLs, and nvmeDriveURLs and append each URL to the tasks pool
 	for _, url := range driveEndpointsResp.arrayControllerURLs {
 		tasks = append(tasks, pool.NewTask(common.Fetch(exp.url+url, target, profile, retryClient), exp.url+url, handle(&exp, STORAGE_CONTROLLER)))
@@ -404,6 +424,11 @@ func NewExporter(ctx context.Context, target, uri, profile, model string, exclud
 			pool.NewTask(common.Fetch(exp.url+dimm.URL, target, profile, retryClient), exp.url+dimm.URL, handle(&exp, MEMORY)))
 	}
 
+	// Firmware Inventory
+	for _, url := range firmwareInventoryEndpoints {
+		tasks = append(tasks, pool.NewTask(common.Fetch(exp.url+url, target, profile, retryClient), exp.url+url, handle(&exp, FIRMWAREINVENTORY)))
+	}
+
 	// call /redfish/v1/Managers/XXX/ for firmware version and ilo self test metrics
 	tasks = append(tasks,
 		pool.NewTask(common.Fetch(exp.url+mgrEndpointFinal, target, profile, retryClient),

exporter/handlers.go

@@ -56,7 +56,10 @@ func handle(exp *Exporter, metricType ...string) []common.Handler {
 			handlers = append(handlers, exp.exportStorageBattery)
 		} else if m == ILOSELFTEST {
 			handlers = append(handlers, exp.exportIloSelfTest)
+		} else if m == FIRMWAREINVENTORY {
+			handlers = append(handlers, exp.exportFirmwareInventoryMetrics)
 		}
+
 	}
 
 	return handlers
@@ -635,6 +638,33 @@ func (e *Exporter) exportProcessorMetrics(body []byte) error {
 	return nil
 }
 
+// exportFirmwareInventoryMetrics collects the inventory component's firmware metrics in json format and sets the prometheus guages
+func (e *Exporter) exportFirmwareInventoryMetrics(body []byte) error {
+	var fwcomponent oem.ILO4Firmware
+	var component = (*e.DeviceMetrics)["firmwareInventoryMetrics"]
+
+	err := json.Unmarshal(body, &fwcomponent)
+	if err != nil {
+		return fmt.Errorf("Error Unmarshalling FirmwareInventoryMetrics - " + err.Error())
+	}
+	// Export for iLO4 since it has a different structure
+	if len(fwcomponent.Current.Firmware) > 0 {
+		for _, firmware := range fwcomponent.Current.Firmware {
+			(*component)["componentFirmware"].WithLabelValues(firmware.Id, firmware.Name, firmware.Location, firmware.VersionString).Set(1.0)
+		}
+	} else {
+		// Export for iLO5, since it's structure matches the GenericFirmware struct
+		var fwcomponent oem.GenericFirmware
+		err := json.Unmarshal(body, &fwcomponent)
+		if err != nil {
+			return fmt.Errorf("Error Unmarshalling FirmwareInventoryMetrics - " + err.Error())
+		}
+
+		(*component)["componentFirmware"].WithLabelValues(fwcomponent.Id, fwcomponent.Name, fwcomponent.Description, fwcomponent.Version).Set(1.0)
+	}
+	return nil
+}
+
 // exportIloSelfTest collects the iLO Self Test Results metrics in json format and sets the prometheus guage
 func (e *Exporter) exportIloSelfTest(body []byte) error {
 

exporter/helpers.go

@@ -475,6 +475,51 @@ func getProcessorEndpoints(url, host string, client *retryablehttp.Client) (oem.
 	return processors, nil
 }
 
+// Getting firmware components for iLO 4 hosts
+func getFirmwareComponents(url, host string, client *retryablehttp.Client) (oem.SystemFirmwareInventory, error) {
+	var fc oem.SystemFirmwareInventory
+	var resp *http.Response
+	var err error
+	retryCount := 0
+	req := common.BuildRequest(url, host)
+
+	resp, err = common.DoRequest(client, req)
+	if err != nil {
+		return fc, err
+	}
+	defer resp.Body.Close()
+	if !(resp.StatusCode >= http.StatusOK && resp.StatusCode < http.StatusMultipleChoices) {
+		if resp.StatusCode == http.StatusNotFound {
+			for retryCount < 3 && resp.StatusCode == http.StatusNotFound {
+				time.Sleep(client.RetryWaitMin)
+				resp, err = common.DoRequest(client, req)
+				retryCount = retryCount + 1
+			}
+			if err != nil {
+				return fc, err
+			} else if !(resp.StatusCode >= http.StatusOK && resp.StatusCode < http.StatusMultipleChoices) {
+				return fc, fmt.Errorf("HTTP status %d", resp.StatusCode)
+			}
+		} else if resp.StatusCode == http.StatusUnauthorized {
+			return fc, common.ErrInvalidCredential
+		} else {
+			return fc, fmt.Errorf("HTTP status %d", resp.StatusCode)
+		}
+	}
+
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return fc, fmt.Errorf("Error reading Response Body - " + err.Error())
+	}
+
+	err = json.Unmarshal(body, &fc)
+	if err != nil {
+		return fc, fmt.Errorf("Error Unmarshalling SystemFirmwareInventory Collection struct - " + err.Error())
+	}
+
+	return fc, nil
+}
+
 // appendSlash appends a slash to the end of a URL if it does not already have one
 func appendSlash(url string) string {
 	if url[len(url)-1] != '/' {

exporter/metrics.go

@@ -73,7 +73,7 @@ func NewDeviceMetrics() *map[string]*metrics {
 			"nvmeDriveStatus": newServerMetric("redfish_nvme_drive_status", "Current NVME status 1 = OK, 0 = BAD, -1 = DISABLED", nil, []string{"chassisSerialNumber", "chassisModel", "protocol", "id", "serviceLabel"}),
 		}
 
-		// Phyiscal Storage Disk Drive Metrics
+		// Physical Storage Disk Drive Metrics
 		DiskDriveMetrics = &metrics{
 			"driveStatus": newServerMetric("redfish_disk_drive_status", "Current Disk Drive status 1 = OK, 0 = BAD, -1 = DISABLED", nil, []string{"name", "chassisSerialNumber", "chassisModel", "id", "location", "serialnumber", "capacityMiB"}),
 		}
@@ -92,23 +92,29 @@ func NewDeviceMetrics() *map[string]*metrics {
 			"memoryDimmStatus": newServerMetric("redfish_memory_dimm_status", "Current dimm status 1 = OK, 0 = BAD", nil, []string{"name", "chassisSerialNumber", "chassisModel", "capacityMiB", "manufacturer", "partNumber"}),
 		}
 
+		// Component Firmware Metrics
+		FirmwareInventoryMetrics = &metrics{
+			"componentFirmware": newServerMetric("redfish_component_firmware", "Current firmware component status 1 = OK, 0 = BAD", nil, []string{"id", "name", "description", "version"}),
+		}
+
 		DeviceMetrics = &metrics{
 			"deviceInfo": newServerMetric("redfish_device_info", "Current snapshot of device firmware information", nil, []string{"name", "chassisSerialNumber", "chassisModel", "firmwareVersion", "biosVersion"}),
 		}
 
 		Metrics = &map[string]*metrics{
-			"up":                  UpMetric,
-			"thermalMetrics":      ThermalMetrics,
-			"powerMetrics":        PowerMetrics,
-			"processorMetrics":    ProcessorMetrics,
-			"nvmeMetrics":         NVMeDriveMetrics,
-			"diskDriveMetrics":    DiskDriveMetrics,
-			"logicalDriveMetrics": LogicalDriveMetrics,
-			"storBatteryMetrics":  StorageBatteryMetrics,
-			"storageCtrlMetrics":  StorageControllerMetrics,
-			"iloSelfTestMetrics":  IloSelfTestMetrics,
-			"memoryMetrics":       MemoryMetrics,
-			"deviceInfo":          DeviceMetrics,
+			"up":                       UpMetric,
+			"thermalMetrics":           ThermalMetrics,
+			"powerMetrics":             PowerMetrics,
+			"processorMetrics":         ProcessorMetrics,
+			"nvmeMetrics":              NVMeDriveMetrics,
+			"diskDriveMetrics":         DiskDriveMetrics,
+			"logicalDriveMetrics":      LogicalDriveMetrics,
+			"storBatteryMetrics":       StorageBatteryMetrics,
+			"storageCtrlMetrics":       StorageControllerMetrics,
+			"iloSelfTestMetrics":       IloSelfTestMetrics,
+			"firmwareInventoryMetrics": FirmwareInventoryMetrics,
+			"memoryMetrics":            MemoryMetrics,
+			"deviceInfo":               DeviceMetrics,
 		}
 	)
 

oem/firmware.go

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2024 Comcast Cable Communications Management, LLC
+ *
+ * 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 oem
+
+import "encoding/json"
+
+// /redfish/v1/UpdateService/FirmwareInventory/XXXX/
+type GenericFirmware struct {
+	Id            string `json:"Id,omitempty"`
+	Name          string `json:"Name"`
+	Version       string `json:"Version,omitempty"`
+	VersionString string `json:"VersionString,omitempty"`
+	Location      string `json:"Location,omitempty"`
+	Description   string `json:"Description,omitempty"`
+	Status        Status `json:"Status,omitempty"`
+}
+
+// /redfish/v1/Systems/1/FirmwareInventory/
+type ILO4Firmware struct {
+	Current FirmwareWrapper `json:"Current"`
+}
+
+type FirmwareWrapper struct {
+	FirmwareSlice
+}
+
+type FirmwareSlice struct {
+	Firmware []GenericFirmware
+}
+
+// Function to unmarshal the FirmwareWrapper struct
+func (w *FirmwareWrapper) UnmarshalJSON(data []byte) error {
+	var fw GenericFirmware
+	var jsonData map[string]interface{}
+	err := json.Unmarshal(data, &jsonData)
+
+	if err == nil {
+		for _, items := range jsonData {
+			for _, item := range items.([]interface{}) {
+				component, _ := json.Marshal(item)
+				err = json.Unmarshal(component, &fw)
+				if err == nil {
+					w.Firmware = append(w.Firmware, fw)
+				}
+			}
+		}
+	} else {
+		return json.Unmarshal(data, &w.Firmware)
+	}
+
+	return nil
+}

oem/system.go

@@ -76,3 +76,19 @@ type MemorySummary struct {
 type StatusMemory struct {
 	HealthRollup string `json:"HealthRollup"`
 }
+
+// SystemFirmwareInventory is the json object for SystemFirwmareInventory metadata
+type SystemFirmwareInventory struct {
+	Current []struct {
+		Component []struct {
+			Details []struct {
+				Item []struct {
+					Name     string `json:"Name,omitempty"`
+					Key      string `json:"Key,omitempty"`
+					Location string `json:"Location,omitempty"`
+				}
+				VersionString string `json:"VersionString,omitempty"`
+			}
+		}
+	}
+}