Manage Lightrun Java agent tags¶

Tagging enables you to group agents together by using a meaningful name, typically based on common functionality. For example, you can use tags to identify the location and purpose of each agent: Database servers, Staging, and so forth. Additionally, you can apply multiple tags to each agent in any combination.

By applying multiple tags, you can bind actions to an agent to an agenet before it is launched and apply actions to applications across different sectors. Once an action is bound to a tag, it is implicitly added to all of the agents that possess that tag.

By default, agents have a single Production tag. You can:

• Create and add a tag to an agent

• View all tags

• View tags from the CLI

Create and add a tag to an agent¶

1. From the relevant server where the agent is installed, go to the agent.metadata.json file and open it.

2. Insert tag names within the tags object (which should be nested in the registration object).

   {
     "registration": {
       "tags": [
         {
           "name": "Tag1"
         },
         {
           "name": "Tag2"
         },
         {
           "name": "Tag3"
         }
       ]
     }
   }
   

   For example, the following JSON applies the tags Production, Main, and East US to the relevant agent.

   {
     "registration": {
       "displayName": "<DISPLAY_NAME>",
       "tags": [
         {
           "name": "Production"
         },
         {
           "name": "Main"
         },
         {
           "name": "East US"
         }
       ]
     }
   }
   

   Alternatively, you can apply tags using a command-line argument when running the agent with your application.

   Multiple tags can be specified using commas. For example, you can set them like this:

   java -Dlightrun.registration.tags=myTag1,myTag2,myOtherTag
   

3. Save the changes and close the file.

4. Restart the application.

   Important

   Changes to this file are not detected until the application is restarted.

View all tag details from the Management Portal¶

Log in to your Lightrun account and navigate to Entities->Tags.

The Tags page loads, appearing similar to the example below.

The details displayed in the Tags page are as follows:

View tags from the CLI¶

1. Install the Lightrun CLI tool

2. Run the command java -jar lightrunc.jar list-tags:

   

For more information, see the CLI reference.