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 install Unified Agent:

1. Download the latest deb package:

   ubuntu_name="ubuntu-22.04-jammy" ua_version=$(curl --silent https://storage.yandexcloud.net/yc-unified-agent/latest-version) bash -c 'curl --silent --remote-name https://storage.yandexcloud.net/yc-unified-agent/releases/${ua_version}/deb/${ubuntu_name}/yandex-unified-agent_${ua_version}_amd64.deb'
   

   For ubuntu_name, specify the OS version:

   • ubuntu-14.04-trusty
   • ubuntu-16.04-xenial
   • ubuntu-18.04-bionic
   • ubuntu-20.04-focal
   • ubuntu-22.04-jammy, starting with version 23.03.02

   You can also download a specific Unified Agent version. To do this, view all available versions and specify the required one instead of the latest-version value:

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

2. Check the version of the deb package using the ls command.

3. Install the deb package:

   sudo dpkg -i yandex-unified-agent_24.09.03_amd64.deb
   

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

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 /etc/yandex/unified_agent/config.yml configuration file, e.g., 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 --silent https://storage.yandexcloud.net/yc-unified-agent/latest-version) bash -c 'curl --silent --remote-name 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 --silent 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 run the agent, run the following command:

./unified_agent --config unified_agent.yml

Where --config is the configuration file path.

You can install Unified Agent when creating a VM through the management console, CLI, API, or Terraform.

To install the agent from the management console, enable Agent for delivering metrics under Monitoring.

To install the agent via the CLI or API, provide the following string in the user 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 using Terraform, add this metadata to the configuration file:

resource "yandex_compute_instance" "this" {
...
resources {
  ...
}

...

metadata = {
  ssh-keys = "<username>:<SSH_key_contents>",
  "install-unified-agent": "1"
}
}

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

The agent is installed with a default configuration file located at /etc/yandex/unified_agent/config.yml.

The configuration file is set up to send basic virtual machine metrics and agent health metrics. You will be charged for metric delivery.

You can also configure the delivery of custom metrics or logs to Cloud Logging.

Once the VM is deployed, Unified Agent will run automatically and begin providing basic VM metrics to Yandex Monitoring.

You are responsible for updating and maintaining the agent.