IPMI Sensor and Graylog Integration

Input and output integration overview

The IPMI Sensor Plugin facilitates the collection of server health metrics directly from hardware via the IPMI protocol, querying sensor data from either local or remote systems.

The Graylog plugin allows you to send Telegraf metrics to a Graylog server, utilizing the GELF format for structured logging.

Integration details

IPMI Sensor

The IPMI Sensor plugin is designed to gather bare metal metrics via the command line utility ipmitool, which interfaces with the Intelligent Platform Management Interface (IPMI). This protocol provides management and monitoring capabilities for hardware components in server systems, allowing for the retrieval of critical system health metrics such as temperature, fan speeds, and power supply status from both local and remote servers. When configured without specified servers, the plugin defaults to querying the local machine’s sensor statistics using the ipmitool sdr command. In scenarios covering remote hosts, authentication is supported through username and password using the command format ipmitool -I lan -H SERVER -U USERID -P PASSW0RD sdr. This flexibility allows users to monitor systems effectively across various environments. The plugin also supports multiple sensor types, including chassis power status and DCMI power readings, catering to administrators needing real-time insight into server operations.

Graylog

The Graylog plugin is designed for sending metrics to a Graylog instance using the GELF (Graylog Extended Log Format) format. GELF helps standardize the logging data, making it easier for systems to send and analyze logs. The plugin adheres to the GELF specification, which lays out requirements for specific fields within the payload. Notably, the timestamp must be in UNIX format, and if present, the plugin sends the timestamp as-is to Graylog without alterations. If omitted, it automatically generates a timestamp. Additionally, any extra fields not explicitly defined by the spec will be prefixed with an underscore, helping to keep the data organized and compliant with GELF’s requirements. This capability is particularly valuable for users monitoring applications and infrastructure in real-time, as it allows for seamless integration and improved visibility across multiple systems.

Configuration

IPMI Sensor

[[inputs.ipmi_sensor]]
  ## Specify the path to the ipmitool executable
  # path = "/usr/bin/ipmitool"

  ## Use sudo
  ## Setting 'use_sudo' to true will make use of sudo to run ipmitool.
  ## Sudo must be configured to allow the telegraf user to run ipmitool
  ## without a password.
  # use_sudo = false

  ## Servers
  ## Specify one or more servers via a url. If no servers are specified, local
  ## machine sensor stats will be queried. Uses the format:
  ##  [username[:password]@][protocol[(address)]]
  ##  e.g. root:passwd@lan(127.0.0.1)
  # servers = ["USERID:PASSW0RD@lan(192.168.1.1)"]

  ## Session privilege level
  ## Choose from: CALLBACK, USER, OPERATOR, ADMINISTRATOR
  # privilege = "ADMINISTRATOR"

  ## Timeout
  ## Timeout for the ipmitool command to complete.
  # timeout = "20s"

  ## Metric schema version
  ## See the plugin readme for more information on schema versioning.
  # metric_version = 1

  ## Sensors to collect
  ## Choose from:
  ##   * sdr: default, collects sensor data records
  ##   * chassis_power_status: collects the power status of the chassis
  ##   * dcmi_power_reading: collects the power readings from the Data Center Management Interface
  # sensors = ["sdr"]

  ## Hex key
  ## Optionally provide the hex key for the IMPI connection.
  # hex_key = ""

  ## Cache
  ## If ipmitool should use a cache
  ## Using a cache can speed up collection times depending on your device.
  # use_cache = false

  ## Path to the ipmitools cache file (defaults to OS temp dir)
  ## The provided path must exist and must be writable
  # cache_path = ""

Graylog

[[outputs.graylog]]
  ## Endpoints for your graylog instances.
  servers = ["udp://127.0.0.1:12201"]

  ## Connection timeout.
  # timeout = "5s"

  ## The field to use as the GELF short_message, if unset the static string
  ## "telegraf" will be used.
  ##   example: short_message_field = "message"
  # short_message_field = ""

  ## According to GELF payload specification, additional fields names must be prefixed
  ## with an underscore. Previous versions did not prefix custom field 'name' with underscore.
  ## Set to true for backward compatibility.
  # name_field_no_prefix = false

  ## Connection retry options
  ## Attempt to connect to the endpoints if the initial connection fails.
  ## If 'false', Telegraf will give up after 3 connection attempt and will
  ## exit with an error. If set to 'true', the plugin will retry to connect
  ## to the unconnected endpoints infinitely.
  # connection_retry = false
  ## Time to wait between connection retry attempts.
  # connection_retry_wait_time = "15s"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

Input and output integration examples

IPMI Sensor

1. Centralized Monitoring Dashboard: Utilize the IPMI Sensor plugin to gather metrics from multiple servers and compile them into a centralized monitoring dashboard. This enables real-time visibility into server health across data centers. Administrators can track metrics like temperature and power usage, helping them make data-driven decisions about resource allocation, potential failures, and maintenance schedules.

2. Automated Power Alerts: Incorporate the plugin into an alerting system that monitors chassis power status and triggers alerts when anomalies are detected. For instance, if the power status indicates a failure or if watt values exceed expected thresholds, automated notifications can be sent to operations teams, ensuring prompt attention to hardware issues.

3. Energy Consumption Analysis: Leverage the DCMI power readings collected via the plugin to analyze energy consumption patterns of hardware over time. By integrating these readings with analytics platforms, organizations can identify opportunities to reduce power usage, optimize efficiency, and potentially decrease operational costs in large server farms or cloud infrastructures.

4. Health Check Automation: Schedule regular health checks by using the IPMI Sensor Plugin to collect data from a fleet of servers. This data can be logged and compared against historical performance metrics to identify trends, outliers, or signs of impending hardware failure, allowing IT teams to take proactive measures and reduce downtime.

Graylog

1. Enhanced Log Management for Cloud Applications: Use the Graylog Telegraf plugin to aggregate logs from cloud-deployed applications across multiple servers. By integrating this plugin, teams can centralize logging data, making it easier to troubleshoot issues, monitor application performance, and maintain compliance with logging standards.

2. Real-Time Security Monitoring: Leverage the Graylog plugin to collect and send security-related metrics and logs to a Graylog server for real-time analysis. This allows security teams to quickly identify anomalies, track potential breaches, and respond to incidents promptly by correlating logs from various sources within the infrastructure.

3. Dynamic Alerting and Notification System: Implement the Graylog plugin to enhance alerting mechanisms in your infrastructure. By sending metrics to Graylog, teams can set up dynamic alerts based on log patterns or unexpected behavior, enabling proactive monitoring and rapid incident response strategies.

4. Cross-Platform Log Consolidation: Use the Graylog plugin to facilitate cross-platform log consolidation across diverse environments such as on-premises, hybrid, and cloud. By standardizing logging in the GELF format, organizations can ensure consistent monitoring and troubleshooting practices, regardless of where their services are hosted.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.