Linux

Agentless

Synopsis

Creates a collector that connects to Linux servers via SSH to gather system metrics and performance data. Supports both password and private key authentication methods, with configurable connection parameters and debug options.

Schema

- id: <numeric>
  name: <string>
  description: <string>
  type: linux
  tags: <string[]>
  pipelines: <pipeline[]>
  status: <boolean>
  properties:
    protocol: <string>
    address: <string>
    port: <numeric>
    username: <string>
    password: <string>
    private_key: <string>
    passphrase: <string>
    timeout: <numeric>

Configuration

The following fields are used to define the device:

Device

Field	Required	Default	Description
id	Y		Unique identifier
name	Y		Device name
description	N	-	Optional description
type	Y		Must be linux
tags	N	-	Optional tags
pipelines	N	-	Optional pre-processor pipelines
status	N	true	Enable/disable the device

Connection

Field	Required	Default	Description
protocol	N	"ssh"	Connection protocol (only ssh supported)
address	Y		Target server address
port	N	22	SSH port number
username	N	<SSH-username>	Must be specified if use_ssh_credentials is false
password	N	<SSH-password>	Must be specified if use_ssh_credentials is false
private_key	N	-	Path to SSH private key file
passphrase	N	-	Private key passphrase (if private key is used)

Advanced Configuration

The following settings can be used to fine tune the collector's behavior.

Performance

Field	Required	Default	Description
timeout	N	30	SSH connection timeout in seconds

Examples

The following are commonly used configuration types.

Private Keys

SSH keys can be used for authentication:

devices:
  - id: 2
    name: secure_linux
    type: linux
    properties:
      address: "10.0.0.50"
      port: 2222
      username: "monitor"
      private_key: "/path/to/private_key"
      passphrase: "private_key_passphrase"

Passwords

If SSH credentials are not used, passwords can be specified:

devices:
  - id: 1
    name: linux_server
    type: linux
    properties:
      address: "192.168.1.100"
      username: "admin"
      password: "secret"

warning

The private key file must be readable by the service user, and have the appropriate permissions (600 or more restrictive).