====== 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 [[https://www.influxdata.com/time-series-platform/telegraf/|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 =====

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

===== Quick start =====

The fastest way to deploy:

  - Open the **OS Agent** modal in the Collector or in the Cockpit (under //Edit Collector → OS Agent//)
  - In **API Keys** tab: tick **Active** and click **Regenerate** to create the global API key
  - In **Configuration** tab: pick the inputs you want (default is fine for most cases)
  - Copy the **wget** command shown at the bottom
  - Paste it on the target Linux host (as root) - it installs Telegraf, writes the config file and starts the service in one shot
  - 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**.

===== Modal layout =====

The OS Agent modal has 4 tabs:

  * **API Keys** - manage the global key and per-system overrides. See [[products:promonitor:latest:userguide:administration:os-agent:api-keys|API Keys]].
  * **Configuration** - choose Telegraf inputs and download the setup script. See [[products:promonitor:latest:userguide:administration:os-agent:configuration|Configuration]].
  * **Monitor** (Hosts in Cockpit) - list of pushing hosts, with status, last push, and per-host detail. See [[products:promonitor:latest:userguide:administration:os-agent:monitor|Monitor]].
  * **Statistics** - push counters and recent errors for diagnosis. See [[products:promonitor:latest:userguide:administration:os-agent:statistics|Statistics]].

===== Detailed pages =====

  * [[products:promonitor:latest:userguide:administration:os-agent:install|Install Telegraf step by step]] - manual install for Linux and Windows, with troubleshooting
  * [[products:promonitor:latest:userguide:administration:os-agent:api-keys|API Keys]] - global key, per-system overrides
  * [[products:promonitor:latest:userguide:administration:os-agent:configuration|Configuration]] - inputs, processes, generated setup files
  * [[products:promonitor:latest:userguide:administration:os-agent:monitor|Monitor]] - host list, detail view, link to a System
  * [[products:promonitor:latest:userguide:administration:os-agent:statistics|Statistics]] - push counters, error log

===== 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''