Step 2: Add an Agent

Prerequisites

The database audit instance is in the Running state.

Scenarios

Determine where to add the agent based on how your database is deployed. Common database deployment modes are as follows:

• Deploy DBSS for databases built on ECS/BMS. For details, see Figure 1 and Figure 2.
  Figure 1 One application connecting to multiple databases built on ECS/BMS
  
  Figure 2 Multiple applications connecting to one database built on ECS/BMS
  
• Deploy DBSS for RDS databases. For details, see Figure 3 and Figure 4.
  Figure 3 One application connecting to multiple RDS databases
  
  Figure 4 Multiple applications connecting to one RDS database
  

Table 1 provides more details.

• If your applications and databases (databases built on ECS/BMS) are deployed on the same node, add the agent on the database side.
• For easier O&M, you can deploy the database audit agent in a large number of containerized applications or databases in batches. This makes configuration quicker and easier. For details, see Container-based database audit agent

Adding an Agent (User-built Databases on ECS/BMS)

1. For details, see Step 1.
2. Log in to the management console.
3. Click and choose Security > Database Security Service. The Dashboard page is displayed.
4. In the navigation tree on the left, choose Databases.
5. In the Instance drop-down list, select the instance whose agent is to be added.
6. In the Agent column of the desired database, click Add.
   Figure 5 Adding an agent
   

7. In the displayed dialog box, select an add mode, as shown in Figure 6. For details about related parameters, see Table 2.
   Figure 6 Adding an agent to a database
   

   Table 2 Parameters for adding an agent (user-built databases on ECS/BMS)

   Parameter	Description	Example Value
   Add Mode	Mode for adding an agent Select an existing agent If an agent has been installed on a database connected to the same application as the desired database, select Select an existing agent. Create an agent If no agent is available, select Create an agent to create one.	Create an agent
   Database Name	Optional. If you select Select an existing agent for Add Mode, you need to select a database that already has an agent.	test1
   Agent ID	This parameter is mandatory when Add Mode is set to Select an existing agent. Select an added agent ID of the instance. The agent ID is automatically generated by the system.	-
   Installing Node Type	This parameter is mandatory when Add Mode is set to Create an agent. When auditing user-installed databases on ECS/BMS, select Database or Application for Installing Node Type.	Database
   Installing Node IP Address	This parameter is mandatory if Installing Node Type is set to Application. IP address of the application node to be audited. You can enter only one IP address. The IP address must be the internal IP address of the application node. IPv4 and IPv6 formats are both supported.	192.168.1.1
   OS	This parameter is mandatory when Add Mode is set to Create an agent. OS of the database to be audited. The value can be LINUX64_x86 , LINUX64_Arm, or WINDOWS64. NOTE: Select an OS version based on the server architecture.	LINUX64_X86
   CPU Threshold (%)	Optional. CPU threshold of the application node to be audited. The default value is 80.	80
   Memory Threshold (%)	Optional. Memory threshold of the application node to be audited. The default value is 80.	80

8. Click OK.
9. In the Agent column of the desired database, click View Agent. In the Agents area, view information about the added agent.
   Figure 7 Successfully adding an agent
   
   

   After adding the agent, confirm that the agent information is correct. If the agent is incorrectly added, click Delete in the Operation column of the row to delete it, and add an agent again.

Adding an Agent (RDS Databases)

If an application connects to multiple RDS databases, be sure to:

• Add an agent to each of the RDS databases.
• Select Select an existing agent if one of the databases already has an agent. Add that agent for the rest of the databases.

1. For details, see Step 1.
2. Log in to the management console.
3. Click and choose Security > Database Security Service. The Dashboard page is displayed.
4. In the navigation tree on the left, choose Databases.
5. In the Instance drop-down list, select the instance whose agent is to be added.
6. In the Agent column of the desired database, click Add.
   Figure 8 Adding an agent
   

7. In the displayed dialog box, select an add mode, as shown in Figure 9 and Figure 10. For details about related parameters, see Table 3.
   • Select Select an existing agent for Add Mode.
     For details about when you should select this option, see When Should I Select an Existing Agent?

     

     If an agent has been installed on the application, you can select it to audit the desired database.

     Figure 9 Selecting an existing agent
     
   • Set Add Mode to Create an agent.

     If no agent is available, select Create an agent to create one.

     Select Installing Node Type to Application, and set Installing Node IP Address to the intranet IP address of the application.

     Figure 10 Adding an agent to an application
     

   Table 3 Parameters for adding an agent (RDS databases)

   Parameter	Description	Example Value
   Add Mode	Mode for adding an agent Selecting an existing agent If an agent has been installed on a database connected to the same application as the desired database, select Select an existing agent. Create an agent If no agent is available, select Create an agent to create one.	Create an agent
   Database Name	Optional. If you select Select an existing agent for Add Mode, you need to select a database that already has an agent.	tesT
   Agent ID	This parameter is mandatory when Add Mode is set to Select an existing agent. Select an added agent ID of the instance. The agent ID is automatically generated by the system.	-
   Installing Node Type	This parameter is mandatory when Add Mode is set to Create an agent. To audit the RDS databases, select Application.	Application
   Installing Node IP Address	This parameter is mandatory when Installing Node Type is set to Application. IP address of the application node to be audited. You can enter only one IP address. The IP address must be the internal IP address of the application node. IPv4 and IPv6 formats are both supported. NOTICE: To audit an RDS database connected to an off-cloud application, set this parameter to the IP address of the proxy.	192.168.1.1
   Audited NIC Name	Optional. This parameter is configurable if Installing Node Type is set to Application. Name of the network interface card (NIC) of the application node to be audited	-
   CPU Threshold (%)	Optional. This parameter is configurable if Installing Node Type is set to Application. CPU threshold of the application node to be audited. The default value is 80. NOTICE: If the CPU usage of a server exceeds the threshold, the agent on the server will stop running.	80
   Memory Threshold (%)	Optional. This parameter is configurable if Installing Node Type is set to Application. Memory threshold of the application node to be audited. The default value is 80. NOTICE: If the memory usage of your server exceeds the threshold, the agent will stop running.	80
   OS	Optional. This parameter is configurable if Installing Node Type is set to Application. OS of the application node to be audited. The value can be LINUX64_X86, LINUX64_ARM, or WINDOWS64.	LINUX64_X86

8. Click OK.
9. In the Agent column of the desired database, click View Agent. In the Agents area, view information about the added agent.
   Figure 11 Successfully adding an agent
   
   

   After adding the agent, confirm that the agent information is correct. If the agent is incorrectly added, click Delete in the Operation column of the row to delete it, and add an agent again.

Follow-Up Procedure

Configure TCP (port 8000) and UDP (ports 7000 to 7100) in the security group inbound rule of the agent node to allow the agent to communicate with the audit instance. For details about how to add a security group rule, see Adding a Security Group Rule.