User Tools

Site Tools


products:promonitor:latest:userguide:administration:os-agent

OS Agent

The OS Agent feature lets the Collector receive operating-system metrics (CPU, memory, disk, network, processes…) from any Linux or Windows host Metrics are pushed by a Telegraf agent and processed by the same pipeline as the other monitors (alarms, plugins, dashboards)

Works with any host: SAP, HANA, Oracle, standalone Linux/Windows, Docker containers…

How it works

  1. A Telegraf agent runs on the target host and collects OS metrics every 15 seconds
  2. Telegraf pushes the metrics over HTTP to the Collector endpoint /api/v1/os-agent/push
  3. The Collector authenticates the push with an API key
  4. Each unknown hostname is auto-discovered and stored in the Collector database

Quick start

The fastest way to deploy:

  1. Open the OS Agent modal in the Collector or in the Cockpit (under Edit Collector → OS Agent)
  2. In API Keys tab: tick Active and click Regenerate to create the global API key
  3. In Configuration tab: pick the inputs you want (default is fine for most cases)
  4. Copy the wget command shown at the bottom
  5. Paste it on the target Linux host (as root) - it installs Telegraf, writes the config file and starts the service in one shot
  6. Wait ~30 seconds, then open the Hosts tab - the host should appear with status OK

For Windows, click setup.ps1 instead of using wget, then run the file in an Administrator PowerShell.

The OS Agent modal has 4 tabs:

  • API Keys - manage the global key and per-system overrides. See API Keys.
  • Configuration - choose Telegraf inputs and download the setup script. See Configuration.
  • Monitor (Hosts in Cockpit) - list of pushing hosts, with status, last push, and per-host detail. See Monitor.
  • Statistics - push counters and recent errors for diagnosis. See Statistics.

Detailed pages

Requirements

  • Telegraf 1.30 or above on each target host
  • Network access from the host to the Collector (HTTP or HTTPS)
  • On Windows: Administrator privileges to install Telegraf as a service
  • On Linux: root or sudo to install Telegraf and write /etc/telegraf/telegraf.conf
products/promonitor/latest/userguide/administration/os-agent.txt · Last modified: by jtbeduchaud