Installing the OpenMetrics Agent

OpenAgent is an agent that collects metrics from Prometheus endpoints and sends them to the WhaTap server. To use the OpenMetrics Explorer and templates in a SingleStore project, you must install OpenAgent first.

OpenAgent requires the following three files in the same directory to operate.

File	Description
openagent	Executable file for collecting and sending metrics
whatap.conf	Basic settings such as license and collection server address
scrape_config.yaml	Definition of scraping targets (endpoints)

Installation Steps Overview

1. Create the installation directory, then download the binary for your architecture (AMD64/ARM64).

   mkdir -p /opt/whatap/openagent
   cd /opt/whatap/openagent
   wget https://repo.whatap.io/openagent/latest/amd/openagent
   chmod +x openagent

2. Enter the license, server address, and port in whatap.conf.

   echo "WHATAP_LICENSE=your-whatap-license" >> whatap.conf
   echo "WHATAP_HOST=your-whatap-host"       >> whatap.conf
   echo "WHATAP_PORT=your-whatap-port"       >> whatap.conf

3. Define the collection target endpoints in scrape_config.yaml (automatically reloaded when modified; no restart required).

4. Run in standalone mode.

   ./openagent standalone

Note

For the full installation steps, execution modes, detailed scrape_config.yaml options (StaticEndpoints, params, metricRelabelConfigs), and configuration items, refer to the OpenAgent Installation and OpenAgent Configuration documents. For Kubernetes environments, follow OpenAgent Kubernetes Configuration.

Note

macOS Apple Silicon is not supported. It works only on Linux AMD64 or ARM64.