feat add ipmi component #4808
Open
feat add ipmi component #4808
+1,327
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Comment on lines
+3
to
+5
| aliases: | ||
| - ../prometheus.exporter.ipmi/ # /docs/alloy/latest/reference/components/prometheus.exporter.ipmi/ | ||
| description: Learn about prometheus.exporter.ipmi |
Contributor
There was a problem hiding this comment.
Suggested change
| aliases: | |
| - ../prometheus.exporter.ipmi/ # /docs/alloy/latest/reference/components/prometheus.exporter.ipmi/ | |
| description: Learn about prometheus.exporter.ipmi | |
| description: Learn about prometheus.exporter.ipmi |
We can drop this alias. The topic is new. Aliases are required if we change the filename or move the fire to a different location.
Comment on lines
+8
to
+10
| products: | ||
| - oss | ||
| title: prometheus.exporter.ipmi |
Contributor
There was a problem hiding this comment.
Suggested change
| products: | |
| - oss | |
| title: prometheus.exporter.ipmi | |
| products: | |
| - oss | |
| tags: | |
| - text: Community | |
| tooltip: This component is developed, maintained, and supported by the Alloy user community. | |
| title: prometheus.exporter.ipmi |
We should add the community badge since this appears to be a community contribution to Alloy.
Comment on lines
+13
to
+15
| # `prometheus.exporter.ipmi` | ||
|
|
||
| The `prometheus.exporter.ipmi` component collects hardware metrics from IPMI-enabled devices. |
Contributor
There was a problem hiding this comment.
Suggested change
| # `prometheus.exporter.ipmi` | |
| The `prometheus.exporter.ipmi` component collects hardware metrics from IPMI-enabled devices. | |
| # `prometheus.exporter.ipmi` | |
| {{< docs/shared lookup="stability/community.md" source="alloy" version="<ALLOY_VERSION>" >}} | |
| The `prometheus.exporter.ipmi` component collects hardware metrics from IPMI-enabled devices. |
| | `config_file` | `string` | Path to IPMI exporter configuration file. | | no | | ||
| | `ipmi_config` | `string` | IPMI exporter configuration as inline YAML string. | | no | | ||
|
|
||
| The `timeout` should be set high enough to allow IPMI sensor collection to complete. |
Contributor
There was a problem hiding this comment.
Suggested change
| The `timeout` should be set high enough to allow IPMI sensor collection to complete. | |
| Set the `timeout` high enough to allow IPMI sensor collection to complete. |
| A timeout of 30 seconds or more is recommended for most hardware. | ||
|
|
||
| The `config_file` and `ipmi_config` arguments are mutually exclusive. | ||
| They allow advanced configuration of IPMI collection modules and command overrides. |
Contributor
There was a problem hiding this comment.
Suggested change
| They allow advanced configuration of IPMI collection modules and command overrides. | |
| These arguments enable advanced configuration of IPMI collection modules and command overrides. |
Comment on lines
+338
to
+339
| Example with environment variables: | ||
| ```alloy |
Contributor
There was a problem hiding this comment.
Suggested change
| Example with environment variables: | |
| ```alloy | |
| Example with environment variables: | |
| ```alloy |
| - **Use dedicated monitoring users** with minimal required privileges | ||
| - **Store passwords securely** using `env()` or secrets management | ||
| - **Never commit passwords** to version control | ||
| - **Consider network isolation** for IPMI interfaces (dedicated management network) |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Consider network isolation** for IPMI interfaces (dedicated management network) | |
| - **Consider network isolation** for IPMI interfaces on dedicated management networks |
|
|
||
| ### Local IPMI requirements | ||
|
|
||
| For local IPMI collection, ensure: |
Contributor
There was a problem hiding this comment.
Suggested change
| For local IPMI collection, ensure: | |
| For local IPMI collection, ensure the following minimum requirements are met: |
Comment on lines
+308
to
+326
| 1. **Hardware support**: Server has BMC/IPMI hardware | ||
| 2. **Kernel modules** (Linux): | ||
| ```bash | ||
| modprobe ipmi_devintf | ||
| modprobe ipmi_si | ||
| ``` | ||
| 3. **Device permissions**: | ||
| ```bash | ||
| ls -l /dev/ipmi* /dev/ipmi0 | ||
| # Should be accessible by the user running Alloy | ||
| ``` | ||
| 4. **FreeIPMI tools** (optional but recommended): | ||
| ```bash | ||
| # Debian/Ubuntu | ||
| apt-get install freeipmi-tools | ||
|
|
||
| # RHEL/CentOS | ||
| yum install freeipmi | ||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. **Hardware support**: Server has BMC/IPMI hardware | |
| 2. **Kernel modules** (Linux): | |
| ```bash | |
| modprobe ipmi_devintf | |
| modprobe ipmi_si | |
| ``` | |
| 3. **Device permissions**: | |
| ```bash | |
| ls -l /dev/ipmi* /dev/ipmi0 | |
| # Should be accessible by the user running Alloy | |
| ``` | |
| 4. **FreeIPMI tools** (optional but recommended): | |
| ```bash | |
| # Debian/Ubuntu | |
| apt-get install freeipmi-tools | |
| # RHEL/CentOS | |
| yum install freeipmi | |
| ``` | |
| - **Hardware support**: Server has BMC/IPMI hardware | |
| - **Kernel modules**: `ipmi_devintf` and `ipmi_si` | |
| - **Device permissions**: `/dev/ipmi0` is accessible by the user running {{< param "PRODUCT_NAME" >}}. | |
| - **FreeIPMI tools**: Optional but recommended. |
Removed Linux from second point. Simplified the steps to bullet points and a list of things vs giving Linux commands to load kernel modules etc. We should only provide the OS-specific steps when they directly relate to Alloy, or if they are specific/custom in some way that is outside the typical use, or if we are building a tutorial.
Question: What about MacOS and Windows? Are there pre-reqs for other OSes? or is this a Linux-only thing?
| # `prometheus.exporter.ipmi` | ||
|
|
||
| The `prometheus.exporter.ipmi` component collects hardware metrics from IPMI-enabled devices. | ||
| It supports both local IPMI collection (from the machine running Alloy) and remote IPMI collection from network-accessible devices. |
Contributor
There was a problem hiding this comment.
Suggested change
| It supports both local IPMI collection (from the machine running Alloy) and remote IPMI collection from network-accessible devices. | |
| It supports both local IPMI collection from the machine running {{< param "PRODUCT_NAME" >}}, and remote IPMI collection from network-accessible devices. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
This PR adds a new
prometheus.exporter.ipmicomponent to Grafana Alloy for collecting hardware metrics from IPMI-enabled devices.Key Features:
Implementation Details:
internal/component/prometheus/exporter/ipmi/internal/static/integrations/ipmi_exporter/github.com/bougou/go-ipmifor IPMI operationsWhich issue(s) this PR fixes
Fixes #731
Notes to the Reviewer
PR Checklist