Prometheus Exporters Build System

This repository contains scripts for building various Prometheus exporters, compatible with BlueBanquise infrastructure management. The system is designed to build RPMs using Docker containers to ensure compatibility and reproducibility.

Overview

• Makefile: Orchestrates the building of multiple exporters using Docker containers.
• build.sh: Provides the functionality to build individual exporters either through standard or custom build procedures.
• exporter/: Directory containing custom build scripts and RPM spec files for each exporter.

Prerequisites

• Docker and Docker Compose
• jq for parsing JSON in shell scripts
• Go, if building Go-based exporters from source
• Access to the internet to pull base images and clone repositories

Setup

1. Clone the repository:

   git clone <repository-url>
   cd <repository-folder>

2. Ensure Docker and Docker Compose are installed:

   Check Docker:

   docker --version

   Check Docker Compose:

   docker compose --version

3. Prepare your environment:

   It's recommended to ensure your Docker environment is clean by removing unused images and containers if necessary.

Usage

Makefile

The Makefile contains several targets corresponding to different exporters and includes debugging and logging capabilities:

• Build All Exporters:

  make all

• Clean Build Artifacts:

  This target cleans up all build artifacts, ensuring a fresh start.

  make clean

• Build Specific Exporter:

  Replace <exporter_name> with the actual name of the exporter.

  make <exporter_name>

  For example, to build the Node Exporter:

  make node_exporter

• Debugging Builds:

  Run builds in debug mode for detailed logging.

  make debug <exporter_name>

• Build an exporter for a specific RedHat version:

  The default operating system version is RedHat 8. To create RedHat 9 RPMs, you must declare it:

  RPM_DIST=rockylinux9 make <exporter_name>

build.sh

This script handles the building of each exporter based on the latest release information fetched from GitHub and supports downloading, renaming, and building RPMs. It checks for custom build scripts in the exporter's directory. If a custom build script is present, it executes that; otherwise, it proceeds with a standard build process.

Adding a New Exporter

1. Add a spec file in the directory:

   /workspace/exporter/<exporter_name>/<exporter_name>.spec

2. Add any custom build logic:

   /workspace/exporter/<exporter_name>/custom_build.sh

3. Register the exporter in the Makefile and build.sh.

Custom Builds

Some exporters require specific build steps, which are handled by custom scripts located in:

/workspace/exporter/<exporter_name>/custom_build.sh

Available Commands

You can list all available exporters and their corresponding commands using:

make list

Debugging

To facilitate debugging of the build process for each exporter, the Makefile includes a debug target. This target enables detailed logging that can help identify issues during the build. Here's how to use it:

Debugging a Specific Exporter

To run a build in debug mode for a specific exporter, use the following command:

make debug <exporter_name>

Replace <exporter_name> with the actual name of the exporter you want to debug. This will execute the build process with verbose output, helping to pinpoint any potential issues.

Viewing Debug Logs

The debug logs are stored in the logs directory specified in the Makefile. These logs include detailed information about the commands executed and their outputs, providing a comprehensive view of the build process.

Displaying Debug Information to the Console

For real-time debug output directly to the console, you can set the DEBUG environment variable to 1 before running the make command. This will output all debug information to your terminal, which can be useful for immediate troubleshooting. Use the following command pattern:

DEBUG=1 make <exporter_name>

or for all exporters:

DEBUG=1 make all

This command will build the specified exporter or all exporters with debug mode enabled, allowing you to see each step of the process.

Contributors

• Thomas Bourcey thomas.bourcey@eviden.com

License

This project is licensed under the Apache License 2.0. For the full license text, see the LICENSE file in the repository or visit Apache License 2.0.