uberAgent

Getting Started with uberAgent for Linux (Tech Preview)

This document provides comprehensive guidance around the latest addition to uberAgent - the platform support for Linux.

It is best for everyone who seeks to integrate uberAgent into their observability strategy. This guide outlines the agent’s capabilities to date, system prerequisites, installation procedures, and configuration steps.

IMPORTANT

uberAgent for Linux is currently in tech preview state. It is not yet a production-ready solution. The information provided here is subject to change as the product evolves.

System Requirements

Backend

uberAgent for Linux supports all backends that are already supported by uberAgent except Microsoft ADX and Microsoft Azure Monitor.

Endpoints

OS Versions

Operating system support continues to grow. The following platforms are currently supported:

  • Ubuntu 22.04 or later
  • eLux 7 2507 or later

Processor Architectures

  • x64

Download

The tech preview of uberAgent for Linux is available as a public download on the Citrix Early Access Release page.

Installing the Linux Endpoint Agent

Ubuntu

The agent installer is available as a DEB file. It can either be installed manually or unattended through existing software deployment tools.

The uberAgent service does not start automatically upon completion of the setup process, as configuration files are not part of the installation package. This allows you to put your configuration in place before uberAgent starts up. The uberAgent service also initiates automatically following a system restart. Alternatively, you may start it manually using systemctl, provided you have root privileges: systemctl start uberAgent

Command Line Installation

  • The installer can be used from the command line to install uberAgent using the command dpkg -i uberagent_7.5.0_amd64.deb (sudo required).
  • Command line installation can be executed locally or remotely, e. g., via SSH.

Installer behavior

On upgrade dpkg -i

  • Stop the uberAgent service if it was previously running.

On remove dpkg -r

  • Remove binary
  • Mask service and remove service file
  • Remove copyright and third-party licenses

On purge dpkg -P In addition to the actions performed during removal, also delete the following:

  • /etc/uberAgent
  • /var/log/uberAgent
  • /var/lib/uberAgent
  • Purge and unmask service

eLux

uberAgent for Linux is also available for eLux. Please follow the instructions in the official documentation to import the uberAgent package and create an image.

Configuration Options

Currently one can configure uberAgent for Linux using local configuration files.

Configuration File Templates

The latest configuration files templates matching your installed uberAgent version are available for download on GitHub.

Example

  • Download the pre-packaged configuration file bundle
    • wget https://github.com/vastlimits/uberAgent-config/raw/refs/heads/version/7.4/config-dist/uberAgent.uAConfig
  • As this is just a compressed file, extract it to the uberAgent configuration directory.
    • sudo unzip uberAgent.uAConfig -d /etc/uberAgent/
  • Modify the uberAgent.conf file to suit your environment, and add at least your receiver. Field descriptions are available as part of the configuration file.
    • sudo nano /etc/uberAgent/uberAgent.conf
     [Receiver]
     Name = My Splunk Receiver
     Type = Splunk
     Protocol = TCP
     Servers = 1.2.3.4:19500
     <!--NeedCopy-->
    
    • Save the file and exit the editor.
  • Start the uberAgent service

    • sudo systemctl start uberAgent

Applying Configuration on eLux

To apply a configuration on an eLux device, transfer the unpacked contents of the configuration archive to /setup/uberAgent/ from Scout (see how to configure file transfer).

Files And Directories on the Filesystem

All directories are created by the uberAgent installer. The agent does not require any additional directories to be created by the user.

uberAgent Executable

/usr/sbin/uberAgent

Configuration Files

/etc/uberAgent/

Persistent Output Queue

/var/lib/uberAgent/OutputQueue/

Log Files

/var/log/uberAgent/

To access log files on eLux, define a diagnostic template that includes all .log files under the path above in Scout. See Requesting diagnostic files to access the logs.

Service Configuration

/lib/systemd/system/uberAgent.service

/usr/share/doc/uberagent/copyright

Licensing

uberAgent for Linux operates fully functional in its tech preview phase without a license file.

Feature and Metric Availability

uberAgent for Linux is currently in tech preview. Below is a summary of items that are available in the current version.

IMPORTANT

While this is a comprehensive list, it does not include every single feature and metric, but rather a selection of the most relevant ones. Also keep in mind that the availability of a sourcetype doesn’t necessarily mean that all fields are available, e.g. due to limitations of the Linux platform.

Application Metrics

Application & Process Performance Metrics

Source type

  • uberAgent:Process:ProcessDetail
  • uberAgent:Process:ProcessStatistics

Application Name to ID Mapping Metrics

Automatic Application Identification

Grouping processes by application is a key feature of uberAgent. On Ubuntu this works for dpkg and snap packages. On eLux EPM/FPM packages are supported.

Source type

  • uberAgent:Application:AppNameIdMapping

Application & Process Startup/Stop Metrics

Source type

  • uberAgent:Process:ProcessStartup
  • uberAgentESA:Process:ProcessStop

Machine Metrics

Machine Inventory Metrics

Source type

  • uberAgent:System:MachineInventory
  • uberAgent:System:DiskInventory
  • uberAgent:System:NetworkConfigInformation
  • uberAgent:System:VolumeInventory

Machine Performance And Utilization Metrics

Source type

  • uberAgent:System:SystemPerformanceSummary2

Network Metrics

Source type

  • uberAgent:Process:NetworkTargetPerformance
  • uberAgent:Application:NetworkConnectFailure

Session Metrics

Source type

  • uberAgent:Session:SessionDetail

Coming soon to uberAgent for Linux

Getting Started with uberAgent for Linux (Tech Preview)