- 12 Jun 2024
- 1 Minute to read
- Print
- PDF
Installation using script
- Updated on 12 Jun 2024
- 1 Minute to read
- Print
- PDF
The Platform agent is an agent that receives various information from different tracing agents. The Platform agent is deployed between a tracing agent and the Traceable Platform and works to collect data. It also works to classify data along with redacting the data. The Platform agent makes sure 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
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.
Make sure to copy and save the generated token, as you cannot access it again. You can only edit the name of the token or delete it. 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 a new token and update the same in the Platform agent.
Download
To download the script, navigate to Traceable's download site. Navigate to install → traffic-mirroring → linux → latest. Click on the install.sh
script to download it, or enter the following command in your terminal:
curl -O https://downloads.traceable.ai/install/traffic-mirroring/linux/latest/install.sh
Provide the execute permission to the script. Enter the following command:
chmod +x install.sh
Installation
Install the Traceable Platform agent using the installation script that you downloaded earlier. Enter the following command:
sudo ./install.sh tpa-only -e myEnvironment -s myService -t
Make a note of the following:
Replace
myEnvironment
in the above command with the name of your environment, for example, development, production, testing, and so on.Replace
myService
in the above command with a meaningful name of the service.
During the installation process, you will be prompted to enter a token. Use the Platform agent token that you copied in the Before you being section.
Refer to Traffic mirroring - tpa only section for a complete list of flags that are available to you.
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