How to change the name and description of the remote agent seen in the Bamboo build logs
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
The purpose of this article is to explain how we can change the name and details of the remote agent seen in Bamboo Build logs.
Environment
The solution was tested on the Bamboo 9.2.12 version.
Solution
When a build is run on the remote agent, the below details are printed in Viewing a build log related to the Remote agent which ran the build:
1
2
Build SCRIP - TIC - Default Job #65 (SCRIP-TIC-JOB1-65) is being prepared for building on agent bamboo-agent, bamboo version: 9.2.12
Remote agent on host bamboo-agent newIn the above example, in the first line, the remote agent name (bamboo-agent) is present, and in the second line, it tells us about the description (Remote agent on host bamboo-agent new) of the remote agent which ran this particular build.
These details are taken from <bamboo-agent-home>bamboo-agent.cfg.xml file, example below:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<configuration>
<buildWorkingDirectory>/var/atlassian/application-data/bamboo-agent/xml-data/build-dir</buildWorkingDirectory>
<agentUuid>3db145eb-3c5f-463c-b7fb-7a0510c1ff5b</agentUuid>
<agentDefinition>
<id>786434</id>
<name>bamboo-agent</name>
<description>Remote agent on host bamboo-agent new</description>
</agentDefinition>
</configuration>We can change the <name></name> and <description></description> tags to change the respective values
Was this helpful?