Supported environments and distributions
The CXDOT Collector supports Linux environments with either x86_64 (AMD64) or ARM64 architecture, on distributions based on Linux kernel version 3.2 or later.Prerequisites
Before installing the CXDOT Collector on Linux, you must meet these prerequisites:- You must have
curlinstalled. - You must have
tarinstalled. - You must have either
sha256sumorshasuminstalled. - You must have an API token from a restricted service account with a write-only scope.
Install
To install the CXDOT Collector on Linux, follow these steps.For a long-running deployment, install the CXDOT Collector in a stable location, and
use your distribution’s service manager to run the Collector.
-
Run the following command to download and install the CXDOT Collector:
Replace
VALUEwith the version of the CXDOT Collector to use (for example,1.4.0+otel-0.157.0). This script createscxdot-collectorandcxdot-adminin/usr/local/bin, and an example configuration file and a software license in/usr/local/share/cxdot-collector. The script requestssudoaccess if these directories aren’t writable. -
Run the following command to make a copy of the example configuration file:
-
In the environment where the CXDOT Collector is deployed, create an environment
variable named
XCOR_API_TOKEN, and set its value to your Cortex XCOR API token. -
Add the
api_tokenkey to your YAML configuration file, and set its value to${env:XCOR_API_TOKEN}:config.yaml -
Set the name of your Cortex XCOR tenant by adding the following key to your YAML
configuration file:
config.yaml
-
Run the following command to start the CXDOT Collector:
The CXDOT Collector writes logs to
stdout. To confirm that the Collector is running, look for the messageEverything is ready. Additionally, you can confirm whether host metrics appear in your Cortex XCOR tenant. The CXDOT Collector’s default configuration collects telemetry data from your host environment, like information about memory, network activity, and uptime. If these metrics appear in your tenant, that means the Collector started up successfully.
Upgrade
To upgrade the CXDOT Collector to a new version, run the same command that you used to install the Collector:VALUE with the new version of the CXDOT Collector to use (for
example, 1.4.0+otel-0.157.0).