Skip to content
Docs

    • Linux · macOS · Windows · Kubernetes · Docker

    Install the Tracix Collector

    5 min read · Updated View as Markdown

    The Tracix Collector is an OpenTelemetry Collector distribution. Install it on each host or cluster you want to monitor. It enrolls with your workspace, pulls the configuration of the policy it belongs to, and starts sending telemetry.

    The fastest way to install is to open Collectors in your workspace, select Deploy collector and copy the command it shows: it carries your installer host, the current stable version and the enrollment token of the policy you choose. This page explains each part of that command, so you can run it with confidence or script it.

    Before you begin

    You need three things

    A Tracix workspace, an enrollment token for the policy the collector should join, and outbound HTTPS on port 443 from the host to the release host and your workspace. To get a token, open Collectors › Policies in your workspace, select the policy, then the Settings tab, and under Enrollment tokens use Show on an active token or Create token. See Enroll and manage collectors with policies.

    RequirementSupported
    Operating systemLinux with systemd (Ubuntu 20.04+, Debian 11+, RHEL or CentOS 8+, Amazon Linux 2), macOS 12+, Windows Server 2016+ or Windows 10+
    Architecturex86_64 (amd64) or arm64
    Privilegessudo on Linux and macOS; an elevated (Administrator) PowerShell on Windows
    NetworkOutbound HTTPS (TCP 443), directly or through an HTTP proxy. Inbound only for what your policy listens on, such as syslog, NetFlow or SNMP traps
    The eight characters that end your workspace's address: in acme-prod-a7k3p2q9.app.tracix.io it is a7k3p2q9. Paste the address to fill it in. Every command on this page uses it.

    Install

    1. Save the token to a file

      Save the enrollment token in a file only root can read, such as /root/tracix-token. A file keeps the token out of your shell history and the process list. If you leave out --token-file, the installer prompts for the token with the input hidden.

    2. Run the installer

      bash
      curl -fsSL https://charts.tracix.io/install.sh | sudo bash -s -- \
      --endpoint https://agents-<workspace>.app.tracix.io \
      --token-file /root/tracix-token

      The installer checks that the host reaches the release host and your workspace, downloads the binary for your architecture, installs the systemd service and waits up to 90 seconds for the collector to enroll.

    3. Check the result

      Expected output
      ==> Installation complete!
      ==>   agent id:      <agent id>
      ==>   control plane: agents-<workspace>.app.tracix.io

      If enrollment does not finish, the installer shows the collector's recent log and the likely cause, and exits with an error.

    Treat the enrollment token like a password

    It enrolls collectors into your workspace. Do not paste it into chat or commit it to Git. The installer stores it in a file only the collector can read, and the collector deletes that file once it has enrolled. Revoking the token later stops new enrollments; collectors that already enrolled keep running.

    Optional installer flags

    Linux and macOSWindowsWhat it does
    --token-file PATH-TokenFile PATHReads the token from a file instead of the command line.
    --proxy URL-Proxy URLSends the installer's downloads and the collector's traffic through an HTTP proxy. Pass it again on every re-run.
    --no-proxy LIST-NoProxy LISTHosts that bypass the proxy. Defaults to localhost,127.0.0.1,::1.
    --version VERSION-Version VERSIONInstalls a specific release instead of the one the console promotes.
    --enable-obiAdds the eBPF permissions for zero-code tracing. Linux only.
    TRACIX_SKIP_PREFLIGHT=1-SkipPreflightSkips the connectivity check.

    Running the installer again upgrades the binary in place and enrolls again. The previous configuration is kept as a timestamped backup.

    Confirm the collector enrolled

    1. Check the service: systemctl status tracix-collector on Linux, sudo launchctl print system/com.tracix.collector on macOS, or Get-Service -Name TracixCollector on Windows.
    2. In your workspace, open Collectors. The new collector appears with its policy and health once it has enrolled.
    3. If nothing appears within a few minutes, see Troubleshoot the collector.

    Next steps