From dded21469f0dd1708700598f53ec67d71bc35458 Mon Sep 17 00:00:00 2001 From: Alexander Gorelyshev Date: Fri, 19 Dec 2025 16:34:15 +0400 Subject: [PATCH] Update the `README.md` --- roles/ipmi_exporter/README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/roles/ipmi_exporter/README.md b/roles/ipmi_exporter/README.md index 7e1a6f1..99774c7 100644 --- a/roles/ipmi_exporter/README.md +++ b/roles/ipmi_exporter/README.md @@ -14,7 +14,7 @@ Target node: Role Variables -------------- -Configuration files must have names `web_conf.yaml` and `ipmi_local.conf`. If ipmi_exp_source_dir is specified, the role searches for `web_conf.yaml` and `ipmi_local.conf` in that directory and copy to target host in `ipmi_exp_config_dir`. If the source directory is not specified, the role skips this step. In ipmi_local.conf user can describe what modules to use for metric collection. +Configuration files must have names `web_conf.yaml` and `ipmi_local.conf`. If `ipmi_exporter_local_conf` is specified, the role searches for `web_conf.yaml` and `ipmi_local.conf` in that directory and copy to target host in `ipmi_exporter_config_dir`. If the source directory is not specified, the role skips this step. In ipmi_local.conf user can describe what modules to use for metric collection. ipmi_up{collector=""} is 1 if the data for this collector could successfully be retrieved from the remote host, 0 otherwise. @@ -28,17 +28,18 @@ The following collectors are available and can be enabled or disabled in the con - sel-events: collects metrics for user-defined events in system event log (SEL). If it fails, SEL entries metrics (see below) will not be available - sm-lan-mode: collects the "LAN mode" setting in the current BMC config. If it fails, the LAN mode metric (see below) will not be available -```yaml -ipmi_exporter_version: 1.10.1 -ipmi_exporter_dir: "/etc/exporters" -ipmi_exporter_config_dir: "/etc/exporters/config" -ipmi_exporter_args: "" # --[no-]native-ipmi Use native IPMI implementation instead of FreeIPMI (EXPERIMENTAL) - # --[no-]web.systemd-socket Use systemd socket activation listeners instead of port listeners (Linux only). -ipmi_exporter_log_level: "info" # Only log messages with the given severity or above. One of: [debug, info, warn, error] -ipmi_exporter_log_format: "logfmt" # Output format of log messages. One of: [logfmt, json] -ipmi_exporter_web_listen_address: "localhost:9290" # Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. Examples: `:9100` or `[::1]:9100` for http, vsock://:9100` for vsock -ipmi_exporter_source_dir: ipmi_local.conf # Path to configuration file. See: https://github.com/prometheus-community/ipmi_exporter/blob/master/docs/configuration.md -ipmi_exporter_web_source_dir: web_conf.yaml # Path to configuration file that can enable TLS or authentication. See: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md +- `ipmi_exporter_version`: release version of the exporter +- `ipmi_exporter_config_dir`: where to put configuration files +- `ipmi_exporter_args`: + - `--[no-]native-ipmi`: Use native IPMI implementation instead of FreeIPMI (EXPERIMENTAL) + - `--[no-]web.systemd-socket`: Use systemd socket activation listeners instead of port listeners (Linux only). +- `ipmi_exporter_log_level`: "info" # Only log messages with the given severity or above. One of: [debug, info, warn, error] +- `ipmi_exporter_log_format`: "logfmt" # Output format of log messages. One of: [logfmt, json] +- `ipmi_exporter_web_listen_address`: Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. + - `:9100` or `[::1]:9100` for HTTP + - `vsock://:9100` for vsock +- `ipmi_exporter_local_conf`: (optional) Path to local configuration file. See: https://github.com/prometheus-community/ipmi_exporter/blob/master/docs/configuration.md +- `ipmi_exporter_web_conf`: (optional) Path to web configuration file that can enable TLS or authentication. See: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md ``` Dependencies