- 28 Oct 2024
- 3 Minutes to read
- Print
- PDF
OS specific installation
- Updated on 28 Oct 2024
- 3 Minutes to read
- Print
- PDF
Traceable's Platform agent receives various information from different tracing agents. The Platform agent is deployed between a tracing agent and the Traceable Platform and collects data. It also classifies and redacts data. The Platform agent ensures that no sensitive information reaches the Traceable Platform. The Platform agent receives the blocking rule information from the Traceable Platform and sends it to the instrumentation agent.
Before you begin
Agent support matrix — Before proceeding with the installation, view the Agent Support Matrix.
You would require an Agent token to proceed with Platform agent installation. Complete the following steps to generate a unique Agent token:
Log in to your Traceable account.
Navigate to Settings () → Account → Agent Tokens.
Click on Generate Token.
Copy and save the generated token, as you cannot access it again. You can only edit or delete the name of the token. This token is used in the steps detailed below. If this token is deleted from Traceable Platform (UI), the communication between Traceable Platform agent and Traceable Platform (UI) will break. In such a case, generate and update a new token in the Platform agent.
Amazon Linux 2 (CentOS)
The set of instructions is compatible with Amazon Linux 2 (CentOS). Complete the following steps to install the Traceable agent:
Set up the repository
Select the version of the Traceable agent
Install Traceable agent
Configure Traceable agent
Start Traceable agent
Verify installation
Set up the repository
Enter the following command to set up the Traceable repo:
sudo vi /etc/yum.repos.d/traceable.repo
Paste the following contents (type i
to enter edit mode)
Replace [7|8] with the version of CentOS you are using. Execute rpm -E %{rhel}
to fetch the CentOS version.
In the following sample snippet, in baserul
, replace the centos[7/8]
with the required version of CentOS,, as shown in the example.
[traceable]
name=Traceable repository
baseurl=https://packages.traceable.ai/centos[7|8]/
enabled=1
gpgcheck=0
For example,
[traceable]
name=Traceable repository
baseurl=https://packages.traceable.ai/centos7/
enabled=1
gpgcheck=0
Hold down Shift
+ ZZ
to exit Vi editor.
Install Traceable
sudo yum install traceable
Configure Traceable
Set the refresh token
Add the refresh token to the file below. You copied and saved this token in the Before you Begin section.
sudo vi /etc/traceable/agent/token
Type Shift
+ ZZ
to exit vi.
Reload systemd
Enter the following command to reload the systemd
service:
sudo systemctl daemon-reload
Set the environment variable
Enter the following command to set the environment variable:
sudo systemctl edit traceable
Enter the following, then exit the editor:
[Service]
Environment="TA_ENVIRONMENT=<expected environment>"
Platform agent connection through a proxy
If the Traceable Platform agent is connecting to the Traceable Platform through a transparent proxy, you can add the following environment variable along with TA_ENVIRONMENT
setting:
Enviornment = "http_proxy=http://<address>:<port>"
Environment = "https_proxy=http://<address>:<port>"
If the proxy server requires a username and password, include the credentials as shown below:
Environment = "https_proxy=http://<username>:<password>@<address>:<port>"
Start Traceable
Enter the following command to start the Traceable agent:
sudo systemctl start traceable
Add Traceable to the system startup
sudo systemctl enable traceable && sudo systemctl restart traceable
Verify installation
Enter the following command to verify a successful installation of the Traceable agent:
systemctl is-active traceable
Ensure no ERROR
logs are present,u and a Started metric exporter
message appears in the logs
cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log
Ubuntu
The instructions to install Traceable agent are compatible with Ubuntu 18.04, 20.04, and 22.04. Complete the following steps to install the Traceable agent:
Set up the repository
Install Traceable agent
Configure Traceable agent
Start Traceable agent
Verify installation
Set up the Repository
sudo apt-get update
sudo apt-get install -y ca-certificates
sudo echo "deb [trusted=yes] https://packages.traceable.ai/ubuntu/ focal main" | sudo tee -a /etc/apt/sources.list.d/traceable.list
sudo apt-get update
Install Traceable
sudo apt-get install -y traceable
Configure Traceable
Configuring Traceable involves the following two steps:
Editing the
config.yam
fileReloading
systemd
service
Set the refresh token
Add the refresh token to the file below
sudo vi /etc/traceable/agent/token
Reload systemd
Enter the following command to reload the systemd
service:
sudo systemctl daemon-reload
Set the environment variable
Enter the following command to set the environment variable:
sudo systemctl edit traceable
Enter the following then exit the editor:
[Service]
Environment="TA_ENVIRONMENT=<expected environment>"
Enter the following command to start the Traceable agent:
sudo systemctl start traceable
Platform agent connection through a proxy
If the Traceable Platform agent is connecting to the Traceable Platform through a transparent proxy, you can add the following environment variable along with TA_ENVIRONMENT
setting:
Enviornment = "http_proxy=http://<address>:<port>"
Environment = "https_proxy=http://<address>:<port>"
If the proxy server requires a username and password, include the credentials as shown below:
Environment = "https_proxy=http://username:password@<address>:<port>"
Add Traceable to the system startup
Enter the following command to add a Traceable agent to systemd
startup:
sudo systemctl enable traceable && sudo systemctl restart traceable
Verify installation
Enter the following command to verify a successful installation of the Traceable agent:
systemctl is-active traceable
Ensure no ERROR
logs are present,, and a Started metric exporter
message appears in the logs
cat /var/traceable/log/traceable.YYYY_mm_dd_ss_mil.log