feat: add receiver for redfish

.chloggen/add-receiver-for-redfish.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: "new_component"
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: "receiver/redfish"
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "adds a redfish receiver"
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [33724]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

.chloggen/config.yaml

@@ -296,6 +296,7 @@ components:
     - receiver/purefb
     - receiver/rabbitmq
     - receiver/receiver_creator
+    - receiver/redfish
     - receiver/redis
     - receiver/riak
     - receiver/saphana

.codecov.yml

@@ -864,6 +864,10 @@ component_management:
     name: receiver_receivercreator
     paths:
     - receiver/receivercreator/**
+  - component_id: receiver_redfish
+    name: receiver_redfish
+    paths:
+    - receiver/redfishreceiver/**
   - component_id: receiver_redis
     name: receiver_redis
     paths:

.github/CODEOWNERS

@@ -312,6 +312,7 @@ receiver/purefareceiver/                                         @open-telemetry
 receiver/purefbreceiver/                                         @open-telemetry/collector-contrib-approvers @dgoscn @chrroberts-pure
 receiver/rabbitmqreceiver/                                       @open-telemetry/collector-contrib-approvers @VenuEmmadi
 receiver/receivercreator/                                        @open-telemetry/collector-contrib-approvers @dmitryax @ChrsMark
+receiver/redfishreceiver/                                        @open-telemetry/collector-contrib-approvers @steven-freed
 receiver/redisreceiver/                                          @open-telemetry/collector-contrib-approvers @dmitryax @hughesjj
 receiver/riakreceiver/                                           @open-telemetry/collector-contrib-approvers @armstrmi
 receiver/saphanareceiver/                                        @open-telemetry/collector-contrib-approvers @dehaansa

.github/ISSUE_TEMPLATE/beta_stability.yaml

@@ -313,6 +313,7 @@ body:
       - receiver/purefb
       - receiver/rabbitmq
       - receiver/receivercreator
+      - receiver/redfish
       - receiver/redis
       - receiver/riak
       - receiver/saphana

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -316,6 +316,7 @@ body:
       - receiver/purefb
       - receiver/rabbitmq
       - receiver/receivercreator
+      - receiver/redfish
       - receiver/redis
       - receiver/riak
       - receiver/saphana

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -310,6 +310,7 @@ body:
       - receiver/purefb
       - receiver/rabbitmq
       - receiver/receivercreator
+      - receiver/redfish
       - receiver/redis
       - receiver/riak
       - receiver/saphana

.github/ISSUE_TEMPLATE/other.yaml

@@ -310,6 +310,7 @@ body:
       - receiver/purefb
       - receiver/rabbitmq
       - receiver/receivercreator
+      - receiver/redfish
       - receiver/redis
       - receiver/riak
       - receiver/saphana

.github/ISSUE_TEMPLATE/unmaintained.yaml

@@ -315,6 +315,7 @@ body:
       - receiver/purefb
       - receiver/rabbitmq
       - receiver/receivercreator
+      - receiver/redfish
       - receiver/redis
       - receiver/riak
       - receiver/saphana

.github/component_labels.txt

@@ -293,6 +293,7 @@ receiver/purefareceiver receiver/purefa
 receiver/purefbreceiver receiver/purefb
 receiver/rabbitmqreceiver receiver/rabbitmq
 receiver/receivercreator receiver/receivercreator
+receiver/redfishreceiver receiver/redfish
 receiver/redisreceiver receiver/redis
 receiver/riakreceiver receiver/riak
 receiver/saphanareceiver receiver/saphana

cmd/githubgen/allowlist.txt

@@ -1,2 +1,3 @@
 KiranmayiB
-jkoronaAtCisco
+steven-freed
+jkoronaAtCisco

cmd/otelcontribcol/builder-config.yaml

@@ -220,6 +220,7 @@ receivers:
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/purefbreceiver v0.137.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/rabbitmqreceiver v0.137.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/receivercreator v0.137.0
+  - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver v0.137.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redisreceiver v0.137.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/riakreceiver v0.137.0
   - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/saphanareceiver v0.137.0

internal/tidylist/tidylist.txt

@@ -297,6 +297,7 @@ receiver/purefareceiver
 receiver/purefbreceiver
 receiver/rabbitmqreceiver
 receiver/receivercreator
+receiver/redfishreceiver
 receiver/redisreceiver
 receiver/riakreceiver
 receiver/saphanareceiver

receiver/redfishreceiver/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

receiver/redfishreceiver/README.md

@@ -0,0 +1,79 @@
+# Redfish Receiver
+
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [development]: metrics   |
+| Distributions | [] |
+| Issues        | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Fredfish%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Fredfish) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Fredfish%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Fredfish) |
+| Code coverage | [![codecov](https://codecov.io/github/open-telemetry/opentelemetry-collector-contrib/graph/main/badge.svg?component=receiver_redfish)](https://app.codecov.io/gh/open-telemetry/opentelemetry-collector-contrib/tree/main/?components%5B0%5D=receiver_redfish&displayType=list) |
+| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner)    | [@steven-freed](https://www.github.com/steven-freed) |
+
+[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
+<!-- end autogenerated section -->
+
+This receiver fetches metrics for a server running a Redfish API.
+
+## Purpose
+
+The purpose of this component is to monitor devices running a Redfish API which is quite often a BMC (Baseboard Management Controller) such as; Dell iDRAC, HPE iLO, etc.
+
+## Prerequisites
+
+This receiver supports Redfish versions:
+
+- v1
+
+## Configuration
+
+These configuration options are for connecting to Redfish API servers.
+
+The following settings are optional:
+
+- `collection_interval`: (default = `60s`): This receiver collects metrics on an interval. This value must be a string readable by Golang's [time.ParseDuration](https://pkg.go.dev/time#ParseDuration). Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
+- `initial_delay` (default = `0s`): defines how long this receiver waits before starting.
+- `servers`: The list of redfish servers to be monitored.
+
+Each server has the following properties:
+- `host` (required): Host name to monitor in the form [https][://][host]:[port].
+- `username` (required): Redfish username.
+- `password` (required): Redfish password.
+- `insecure` (optional, default: `false`): Sets the protocol security.
+- `timeout` (optional, default: `60s`): Sets the Redfish client timeout.
+- `redfish` (optional): Redfish configuration.
+- `computer_system_id` (required): Redfish computer system id to monitor.
+- `resources` (required): The list of Redfish resources to monitor.
+
+The redfish configuration has the following properties:
+- `version` (optional, default: `v1`): Redfish API version.
+
+The redfish resource options include the below:
+- ComputerSystem
+- Chassis
+- Fans
+- Temperatures
+
+### Example Configuration
+
+```yaml
+receivers:
+  collection_interval: 60s
+  redfish:
+    servers:
+    - host: https://16.1.15.1
+      username: "${BMC_USER}"
+      password: "${BMC_PASSWORD}"
+      insecure: true
+      computer_system_id: "1"
+      redfish:
+        version: v1
+      resources:
+      - ComputerSystem
+      - Fans
+```
+
+The full list of settings exposed for this receiver are documented in [config.go](./config.go).
+
+## Metrics
+
+Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml)

receiver/redfishreceiver/config.go

@@ -0,0 +1,57 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package redfishreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver"
+
+import (
+	"errors"
+	"time"
+
+	"go.opentelemetry.io/collector/config/configopaque"
+	"go.opentelemetry.io/collector/scraper/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver/internal/metadata"
+)
+
+type redfishConfig struct {
+	Version string `mapstructure:"version"`
+}
+
+type Server struct {
+	Host             string              `mapstructure:"host"`
+	User             string              `mapstructure:"username"`
+	Pwd              configopaque.String `mapstructure:"password"`
+	Insecure         bool                `mapstructure:"insecure"`
+	Timeout          string              `mapstructure:"timeout"`
+	Redfish          redfishConfig       `mapstructure:"redfish"`
+	ComputerSystemID string              `mapstructure:"computer_system_id"`
+	Resources        []Resource          `mapstructure:"resources"`
+}
+
+type Config struct {
+	scraperhelper.ControllerConfig `mapstructure:",squash"`
+	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
+	Servers                        []Server `mapstructure:"servers"`
+
+	// prevent unkeyed literal initialization
+	_ struct{}
+}
+
+func (cfg *Config) Validate() error {
+	if len(cfg.Servers) == 0 {
+		return errors.New("servers must not be empty")
+	}
+
+	for i := range cfg.Servers {
+		if cfg.Servers[i].Redfish.Version != "v1" {
+			return errors.New("redfish version must be once of the following values: 'v1'")
+		}
+		if len(cfg.Servers[i].Resources) == 0 {
+			return errors.New("resources must not be empty")
+		}
+		if _, err := time.ParseDuration(cfg.Servers[i].Timeout); err != nil && cfg.Servers[i].Timeout != "" {
+			return errors.New("invalid server timeout")
+		}
+	}
+	return nil
+}

receiver/redfishreceiver/doc.go

@@ -0,0 +1,6 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate mdatagen metadata.yaml
+
+package redfishreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/redfishreceiver"