The agent is a single Python script. It connects out to KloudSentinel, so you don't need to open any inbound ports on the monitored host.
Before you start
- Linux or macOS with Python 3
- Outbound access to
kloudsentinel.comon port 443 - An agent token from Settings > Agent Tokens
Install and run
pip3 install psutil websockets
curl -o agent.py https://kloudsentinel.com/agent/download
python3 agent.py --backend kloudsentinel.com --tls --token YOUR_AGENT_TOKEN
To keep the agent running after you log out, follow the service steps on the Agent Fleet page.
Options
| Option | Environment variable | Default | What it does |
|---|---|---|---|
--backend |
KLOUDSENTINEL_BACKEND |
localhost:8000 |
KloudSentinel address |
--tls |
KLOUDSENTINEL_TLS |
Off | Connects securely. Required for kloudsentinel.com |
--token |
KLOUDSENTINEL_AGENT_TOKEN |
None | Your agent token. Required |
--id |
KLOUDSENTINEL_AGENT_ID |
Hostname | Name shown in Agent Fleet |
--role |
KLOUDSENTINEL_ROLE |
Server |
Role label |
--env |
KLOUDSENTINEL_ENV |
Production |
Environment label |
--interval |
KLOUDSENTINEL_INTERVAL |
2 |
Seconds between metric updates |
Private cloud platforms
The agent detects whether it runs on VMware, Proxmox, OpenStack or Nutanix, and shows that on Agent Fleet.
Troubleshooting
"Invalid or revoked agent token"
The token is wrong or was deleted. Create a new one in Settings > Agent Tokens.
"This plan allows N hosts"
You've reached your plan's host limit. Hosts already connected aren't affected. Stop monitoring a host, or change your plan.
"This company's plan has ended"
Your trial or plan has ended. Choose a plan under Plan and Billing.
The agent can't connect
- Check that you included
--tls. - Check that the host can reach the address:
curl -I https://kloudsentinel.com. - If you use a proxy or firewall, allow outbound WebSocket traffic to
kloudsentinel.com. - During scheduled maintenance, agents reconnect once the service returns.