ipmctl_exporter

DISCONTINUATION OF PROJECT

This project will no longer be maintained by Intel.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project.

If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the open source software community, please create your own fork of this project.

Contact: webadmin@linux.intel.com

Intel® Optane™ Persistent Memory Controller Exporter

Intel® Optane™ PMCE is a utility for exposing health and performance metrics from Intel Optane DC Persistent memory modules (DCPMM) for Prometheus (an open source monitoring system). Exporter is linking to libipmctl and consume its API. Library is a part of IPMCTL project.

Exported Metrics

basic set: # sudo ./ipmctl_exporter

If you would like to add some alerts in Prometheus to get notification after reaching some configured thresholds, you may enable it as well (these are disabled by default) to do it try: # sudo ./ipmctl_exporter --enable-thresholds

Labels returned by ipmctl_device_discovery_info

Labels returned by ipmctl_device_security_capabilities_info

Build

As far as IPMCTL exporter utilize libipmctl as well as libndctl (both are external libraries) supported systems depends on availability of these libraries under different Operating Systems.

For Linux we highly recommend:

Fedora greater than 29 (Workstation Edition) x64 with installed latest golang compiler, latest pkg-config, latest GCC, latest cmake, and latest ipmctl + ndctl libraries, follow the steps below to prepare your environment for builds:

dnf install -y git cmake pkg-config gcc golang ndctl-libs libipmctl
git clone https://github.com/intel/ipmctl-exporter
cd ./ipmctl-exporter
cmake -S . -B output

To proceed with build:

export PKG_CONFIG_PATH=`pwd`/output/
make -C output

For Windows we highly recommend:

Windows Server 2016 Standard or Windows 7/8/8.1/10 x64 with installed latest golang compiler, latest pkg-config, latest TDM64-GCC, latest cmake, and latest ipmctl library, follow the steps below to prepare your environment for builds:

• Install golang from here to C:\Go directory
• Install tdm64-gcc from here to C:\TDM-GCC-64 directory
• Install pkgconfiglite from here to C:\TDM-GCC-64\bin directory
• Install cmake from here to C:\Program Files\CMake directory
• Install ipmctl library from here choose latest build for Windows OS
• From cmd.exe:

Attention: Please avoid whitespaces for git repository directory, some Windows OSes may face issues with parsing such paths.

git clone https://github.com/intel/ipmctl-exporter
cd ipmctl-exporter
cmake -S . -B output -G "MinGW Makefiles"

To proceed with build:

set PKG_CONFIG_PATH=%cd%\output\
mingw32-make -C output

Run

Referring to the list of default ports by default ipmctl-exporter serves on port 0.0.0.0:9757 at endpoint /metrics, for more details about the usage type:

sudo ./ipmctl_exporter --help

ipmctl_exporter as well as ipmctl tool has to be run as root user, otherwise you should receive error code 268 (INVALID PERMISSIONS) trying to collect some data.

Code of Conduct

We are following rules defined by Contributor Covenant Code of Coduct version 2.0