Installing and running Yandex Unified Agent

Unified Agent is distributed as a deb package for Ubuntu 14.04 or higher. The package contains a binary file with the agent and an empty configuration file located at /etc/yandex/unified_agent/config.yml.

To download the latest version of the agent's deb package, run:

ubuntu_name="ubuntu-14.04-trusty" ua_version=$(curl -s https://storage.yandexcloud.net/yc-unified-agent/latest-version) bash -c 'curl -s -O https://storage.yandexcloud.net/yc-unified-agent/releases/${ua_version}/deb/${ubuntu_name}/yandex-unified-agent_${ua_version}_amd64.deb'

Supported values for the ubuntu_name parameter:

• ubuntu-14.04-trusty;
• ubuntu-16.04-xenial;
• ubuntu-18.04-bionic;
• ubuntu-20.04-focal.

To find out all the available versions of the agent, run this command:

curl -s https://storage.yandexcloud.net/yc-unified-agent/all-versions

To install the deb package, run this command:

sudo dpkg -i yandex-unified-agent_21.02.03_amd64.deb

To make sure Unified Agent is successfully installed and running, run the command systemctl status unified-agent. Sample command output:

user@my-vm:~$ systemctl status unified-agent
● unified-agent.service - Yandex Unified Agent service
   Loaded: loaded (/lib/systemd/system/unified-agent.service; enabled; vendor preset: enabled)
   Active: active (running) since Tue 2021-02-09 15:57:08 UTC; 2 weeks 2 days ago
 Main PID: 141403 (unified_agent)
    Tasks: 8 (limit: 507)
   Memory: 9.4M
   CGroup: /system.slice/unified-agent.service
           └─141403 /usr/bin/unified_agent --config /etc/yandex/unified_agent/config.yml --log-priority NOTICE

After installing the package, edit the configuration file /etc/yandex/unified_agent/config.yml, for example, by setting up the agent for delivering Linux system metrics. For more information about agent configuration, see Configuration.

Unified Agent is distributed as a binary file built for the x86-64/amd64 architecture for Ubuntu 14.04 or higher.

To download the latest version of the agent's binary file, run:

ua_version=$(curl -s https://storage.yandexcloud.net/yc-unified-agent/latest-version) bash -c 'curl -s -O https://storage.yandexcloud.net/yc-unified-agent/releases/$ua_version/unified_agent && chmod +x ./unified_agent'

To find out all the available versions of the agent, run this command:

curl -s https://storage.yandexcloud.net/yc-unified-agent/all-versions

Download the agent's executable file and then create a configuration file, for example, with the settings for delivering Linux system metrics. For more information about agent configuration, see Configuration.

To start the agent, run the command:

./unified_agent --config unified_agent.yml

Where --config is the path to the configuration file.

You can install the agent when creating a VM in the management console. To do this, enable Agent for delivering metrics under Monitoring. The agent is installed automatically with the default configuration file that will send basic VM metrics and agent health metrics. You'll be charged for metric delivery.

The installed agent is a regular Unified Agent that you can additionally set up to deliver custom metrics or logs to Cloud Logging.

To install the agent while creating a VM in the CLI or API, add the following line to user-defined metadata (user-data):

#cloud-config\nruncmd:\n  - wget -O - https://monitoring.api.cloud.yandex.net/monitoring/v2/unifiedAgent/config/install.sh | bash"

To install the agent and send metrics properly, make sure the created VM has access to the internet.

You are responsible for updating and maintaining the agent.