Add support to read thermal metrics

receivers/redfishReceiver.go

@@ -14,6 +14,8 @@ import (
 
 	// See: https://pkg.go.dev/github.com/stmcginnis/gofish
 	"github.com/stmcginnis/gofish"
+	"github.com/stmcginnis/gofish/common"
+	"github.com/stmcginnis/gofish/redfish"
 )
 
 // RedfishReceiver configuration:
@@ -34,12 +36,19 @@ type RedfishReceiver struct {
 		HttpTimeoutString string `json:"http_timeout,omitempty"`
 		HttpTimeout       time.Duration
 
+		// Globally disable collection of power or thermal metrics
+		DisablePowerMetrics   bool `json:"disable_power_metrics"`
+		DisableThermalMetrics bool `json:"disable_thermal_metrics"`
+
 		// Client config for each redfish service
 		ClientConfigs []struct {
 			Hostname *string `json:"hostname"`
 			Username *string `json:"username"`
 			Password *string `json:"password"`
 			Endpoint *string `json:"endpoint"`
+			// Per client disable collection of power or thermal metrics
+			DisablePowerMetrics   bool     `json:"disable_power_metrics"`
+			DisableThermalMetrics bool     `json:"disable_thermal_metrics"`
 			ExcludeMetrics        []string `json:"exclude_metrics,omitempty"`
 			gofish                gofish.ClientConfig
 		} `json:"client_config"`
@@ -53,43 +62,107 @@ type RedfishReceiver struct {
 func (r *RedfishReceiver) Start() {
 	cclog.ComponentDebug(r.name, "START")
 
-	// readPowerMetric reads redfish power metric from the endpoint configured in conf
+	// Read redfish thermal metrics
-	readPowerMetric := func(clientConfigIndex int) error {
+	readThermalMetrics := func(clientConfigIndex int, chassis *redfish.Chassis) error {
-
 		clientConfig := &r.config.ClientConfigs[clientConfigIndex]
 
-		// Connect to redfish service
+		// Skip collection off thermal metrics when disabled by config
-		c, err := gofish.Connect(clientConfig.gofish)
+		if r.config.DisableThermalMetrics || clientConfig.DisableThermalMetrics {
-		if err != nil {
+			return nil
-			return fmt.Errorf(
+		}
-				"readPowerMetric: gofish.Connect({Username: %v, Endpoint: %v, BasicAuth: %v, HttpTimeout: %v, HttpInsecure: %v}) failed: %v",
+
-				clientConfig.gofish.Username,
+		// Get thermal information for each chassis
-				clientConfig.gofish.Endpoint,
+		thermal, err := chassis.Thermal()
-				clientConfig.gofish.BasicAuth,
+		if err != nil {
-				clientConfig.gofish.HTTPClient.Timeout,
+			return fmt.Errorf("readMetrics: chassis.Thermal() failed: %v", err)
-				clientConfig.gofish.HTTPClient.Transport.(*http.Transport).TLSClientConfig.InsecureSkipVerify,
+		}
-				err)
+
-		}
+		// Skip empty thermal information
-		defer c.Logout()
+		if thermal == nil {
-
+			return nil
-		// Get all chassis managed by this service
-		chassis_list, err := c.Service.Chassis()
-		if err != nil {
-			return fmt.Errorf("readPowerMetric: c.Service.Chassis() failed: %v", err)
 		}
 
-		for _, chassis := range chassis_list {
 		timestamp := time.Now()
 
+		for _, temperature := range thermal.Temperatures {
+
+			// Skip all temperatures which ar not in enabled state
+			if temperature.Status.State != common.EnabledState {
+				continue
+			}
+
+			tags := map[string]string{
+				"hostname": *clientConfig.Hostname,
+				"type":     "node",
+				// ChassisType shall indicate the physical form factor for the type of chassis
+				"chassis_typ": string(chassis.ChassisType),
+				// Chassis name
+				"chassis_name": chassis.Name,
+				// ID uniquely identifies the resource
+				"temperature_id": temperature.ID,
+				// MemberID shall uniquely identify the member within the collection. For
+				// services supporting Redfish v1.6 or higher, this value shall be the
+				// zero-based array index.
+				"temperature_member_id": temperature.MemberID,
+				// PhysicalContext shall be a description of the affected device(s) or region
+				// within the chassis to which this power control applies.
+				"temperature_physical_context": string(temperature.PhysicalContext),
+				// Name
+				"temperature_name": temperature.Name,
+			}
+
+			// Delete empty tags
+			for key, value := range tags {
+				if value == "" {
+					delete(tags, key)
+				}
+			}
+
+			// Set meta data tags
+			meta := map[string]string{
+				"source": r.name,
+				"group":  "Temperature",
+				"unit":   "degC",
+			}
+
+			// ReadingCelsius shall be the current value of the temperature sensor's reading.
+			value := temperature.ReadingCelsius
+
+			y, err := lp.New("temperature", tags, meta,
+				map[string]interface{}{
+					"value": value,
+				},
+				timestamp)
+			if err == nil {
+				r.sink <- y
+			}
+		}
+
+		return nil
+	}
+
+	// Read redfish power metrics
+	readPowerMetrics := func(clientConfigIndex int, chassis *redfish.Chassis) error {
+		clientConfig := &r.config.ClientConfigs[clientConfigIndex]
+
+		// Skip collection off thermal metrics when disabled by config
+		if r.config.DisablePowerMetrics || clientConfig.DisablePowerMetrics {
+			return nil
+		}
+
 		// Get power information for each chassis
 		power, err := chassis.Power()
 		if err != nil {
-				return fmt.Errorf("readPowerMetric: chassis.Power() failed: %v", err)
+			return fmt.Errorf("readMetrics: chassis.Power() failed: %v", err)
 		}
+
+		// Skip empty power information
 		if power == nil {
-				continue
+			return nil
 		}
 
+		timestamp := time.Now()
+
 		// Read min, max and average consumed watts for each power control
 		for _, pc := range power.PowerControl {
 
@@ -173,14 +246,55 @@ func (r *RedfishReceiver) Start() {
 				}
 			}
 		}
+
+		return nil
+	}
+
+	// readMetrics reads redfish temperature and power metrics from the endpoint configured in conf
+	readMetrics := func(clientConfigIndex int) error {
+
+		// access client config
+		clientConfig := &r.config.ClientConfigs[clientConfigIndex]
+
+		// Connect to redfish service
+		c, err := gofish.Connect(clientConfig.gofish)
+		if err != nil {
+			return fmt.Errorf(
+				"readMetrics: gofish.Connect({Username: %v, Endpoint: %v, BasicAuth: %v, HttpTimeout: %v, HttpInsecure: %v}) failed: %v",
+				clientConfig.gofish.Username,
+				clientConfig.gofish.Endpoint,
+				clientConfig.gofish.BasicAuth,
+				clientConfig.gofish.HTTPClient.Timeout,
+				clientConfig.gofish.HTTPClient.Transport.(*http.Transport).TLSClientConfig.InsecureSkipVerify,
+				err)
+		}
+		defer c.Logout()
+
+		// Get all chassis managed by this service
+		chassis_list, err := c.Service.Chassis()
+		if err != nil {
+			return fmt.Errorf("readMetrics: c.Service.Chassis() failed: %v", err)
+		}
+
+		for _, chassis := range chassis_list {
+
+			err := readThermalMetrics(clientConfigIndex, chassis)
+			if err != nil {
+				return err
+			}
+
+			err = readPowerMetrics(clientConfigIndex, chassis)
+			if err != nil {
+				return err
+			}
 		}
 
 		return nil
 	}
 
-	// doReadPowerMetric read power metrics for all configure redfish services.
+	// doReadMetrics read power and temperature metrics for all configure redfish services.
 	// To compensate latencies of the Redfish services a fanout is used.
-	doReadPowerMetric := func() {
+	doReadMetric := func() {
 
 		// Compute fanout to use
 		realFanout := r.config.Fanout
@@ -202,7 +316,7 @@ func (r *RedfishReceiver) Start() {
 
 				// Read power metrics for each client config
 				for clientConfigIndex := range workerInput {
-					err := readPowerMetric(clientConfigIndex)
+					err := readMetrics(clientConfigIndex)
 					if err != nil {
 						cclog.ComponentError(r.name, err)
 					}
@@ -241,7 +355,7 @@ func (r *RedfishReceiver) Start() {
 		defer ticker.Stop()
 
 		for {
-			doReadPowerMetric()
+			doReadMetric()
 
 			select {
 			case <-ticker.C: