Unryo Agents#

Overview#

The Unryo Agent is a lightweight program that is deployed on your hosts (Unix and Windows) for monitoring the OS performance (processor, disk, swap, processes) as well as the applications running on it.

Prerequisites#

Privileges:

Installing the agent typically requires root or administrator privileges on the host.

Networking:

The agent sends metric data to an Unryo Collector at port 8186/tcp. Ensure all your Agents can reach your Unryo Collector using this port (if need be, you can change to another port).
The agent retrieves its configurations from the Unryo platform at port 443/tcp. Ensure all your agents can reach your Unryo Portal (which is located in our cloud for SaaS deployments or in your network for on-premise deployments).

These networking requirements are for default architectures; your architecture may be different depending on your security requirements and your networking requirements may be different as a result.

Installation#

Create an “agent” account#

The first step is to create an "agent" account in your Unryo Portal. Click on the gear icon on the top right of your Unryo Portal, then Settings > Platform Administration > User.

Click on the white-on-green "+" button.

Fill in the username and password. The username must start with "agent" and the password is up to you. Make sure to keep your password safe.

Install the agent on Linux#

Step 1: Get the installer for your platform:

On a Debian-based Linux: https://downloads.unryo.com/Unryo-Agent-Linux-latest.deb
On an RPM-based Linux: https://downloads.unryo.com/Unryo-Agent-Linux-latest.rpm

Step 2: Run the installer

On a Debian-based Linux: run dpkg -i <path to Debian installer>.
On a RPM-based Linux: run rpm -ivh <path to RPM installer>.

Step 3:: Edit /opt/unryo-agent/etc/vault-client/configuration-vault-client/vault-endpoint.toml

This is the only configuration file on the agent, everything else is from the Unryo Monitor Web interface
Replace <<<<MY_USERNAME>>>> and <<<<MY_PASSWORD>>>> with the username and password for the Portal user you created at the last step, and replace <<<<MY_PORTAL_URL>>>> with your Portal URL.
If you have the base64 command: encode your credentials as follows: echo -n "<username>:<password>" | base64, where <username> and <password> are the username and password for your new Portal user. Otherwise, encode your credentials using the instructions found here. Copy the result and replace <<<<MY_ENCODED64_USER:CREDENTIALS>>>> with it.
If you have not and do not intend to set up a valid TLS certificate on your Unryo Portal, uncomment the last line. We do not recommend this.

Step 4: Start the agent:

Run systemctl daemon-reload.
Run systemctl restart unryo-vault.

Linux Agent Upgrade#

If the previous version of your agent was prior to 1.0 (release candidate), then you must fully uninstall the previous version (keep the one configuration file) then proceed with a fresh install of the agent. To perform a clean removal of the agent and keep the configuration file for reuse:
On RedHat/CentOS/Fedora based distros (rpm manager):
- cp /opt/unryo-agent/etc/configuration-vault-client/vault-endpoint.toml /tmp/
- killall -9 unryo-vault-client
- killall -9 unryo-telegraf
- rpm -e unryo-agent
- find /etc |grep -i unryo- |xargs -n 1 rm
- find /etc |grep -i unryo- |xargs -n 1 rmdir
On Debian/Ubunty based distros (dpkg manager):
- cp /opt/unryo-agent/etc/configuration-vault-client/vault-endpoint.toml /tmp/
- killall -9 unryo-vault-client
- killall -9 unryo-telegraf
- dpkg -r unryo-agent
- find /etc |grep -i unryo- |xargs -n 1 rm
- find /etc |grep -i unryo- |xargs -n 1 rmdir
If you are upgrading from a previous 1.X or higher release:
Depending of your Linux Disto, upgrade the agent normally, example:
- rpm -U ./Unryo-Agent-Linux-latest.rpm
- dpkg -i ./Unryo-Agent-Linux-latest.deb
Validate that the vault-endpoint.toml configuration file persisted
Validate that the unryo-vault and unryo-telegraf services are correctly restarted and running

Install the agent on Windows#

Step 1: Download the ZIP from https://downloads.unryo.com/Unryo-Agent-Windows-latest.zip and extract it.

Extracted the ZIP file move the Unryo-Agent folder from the zip into your C:\Program Files.
Instructions are in the UNRYO-README.txt inside the zip file, ideal for local or remote installation

Step 2: Edit C:\Program Files\Unryo-Agent\etc\configuration-vault-client\vault-endpoint.conf

This is the only configuration file on the agent, everything else is from the Unryo Monitor Web interface
When you upgrade the agent, this is the only file you need to keep
Replace <<<<MY_USERNAME>>>> and <<<<MY_PASSWORD>>>> with the username and password for the Portal user you created at Step 1, and replace <<<<MY_PORTAL_URL>>>> with your Portal URL.
Encode your credentials (<username>:<password>) using the instructions found here. Copy the result and replace <<<<MY_ENCODED64_USER:CREDENTIALS>>>> with it.

Step 3: Start the agent:

This command installs the agent as a Windows service and starts it:

Run C:\Program Files\Unryo-Agent\install\install-unryo-telegraf-service.cmd as an administrator.
Run C:\Program Files\Unryo-Agent\install\install-unryo-vault-service.cmd as an administrator.
From the Windows Task Scheduler, run the task called Unryo Vault service

Windows Agent Upgrade#

Stop the Unryo-Vault task (using Windows Task Scheduler UI)
Stop the Unryo-Telegraf service (using Windows Services UI)
copy/backup the configuration file C:\Program Files\Unryo-Agent\etc\configuration-vault-client\vault-endpoint.conf
delete and replace this folder by the one provided in the agent zip file: C:\Program Files\Unryo-Agent
restore your configuration file C:\Program Files\Unryo-Agent\etc\configuration-vault-client\vault-endpoint.conf
restart the Unryo-Vault task (using Windows Task Scheduler UI)
restart the Unryo-Telegraf service (using Windows Services UI)

Indicate where to send data#

The first thing is to indicate the agent where to send its data.

Unryo Agents send data to an Unryo Collector, which then routes it to the Unryo Platform.
Unryo offers flexibility depending on your architecture. You can have all your Agents sending data to a central Unryo Collector. Or, if your environment is segmented (for example with distributed sites or multiple customers), you can consider using several Collectors.

Go to "Configuration Management":

In the "Metrics" tab, click on the white-on-green "+":

Select InfluxDB Listener as your template, your Unryo Collector as the collector to deploy on, and give your configuration file a name and optionally a description. The default contents will work fine. Only edit them if you know what you are doing. Click on "Confirm" at the bottom right when you are done.

Then, go to the "Agent" tab and click on the white-on-green "+" to add another configuration file. This time, select Output to Unryo Collector as the template and your new Agent as the agent. Make sure to set urls = ["<your Unryo collector address>"].

Start collecting data!#

Your Agent is now actively monitoring your system; by default, it monitors the system's global performance, including the operating system, hardware and application processes. You can see dashboards and alerts (if any) from your Unryo Portal. You can also monitor other technologies by simply activating one of the predefined integrations.