Adding and Editing a Collection Channel

Scenario

This topic describes how to add and edit a log collection channel to connect functional components and let SecMaster and the log collector work properly.

Adding a Channel Group

Before adding a collection channel, you need to add a connection group.

1. Log in to the management console.
2. Click in the upper part of the page and choose Security > SecMaster.
3. In the navigation pane on the left, choose Workspaces > Management. In the workspace list, click the name of the target workspace.
   Figure 1 Workspace management page
   

4. In the navigation pane on the left, choose Settings > Collections. Then, select the Collection Channels tab.
   Figure 2 Collection channel management tab page
   

5. Add a channel group.
   1. On the Collection Channels tab, click on the right of Groups.
   2. Enter a group name and click .

   To edit or delete a group, hover the cursor over the group name and click the edit or deletion icon.

Adding a Collection Channel

1. Log in to the management console.
2. Click in the upper part of the page and choose Security > SecMaster.
3. In the navigation pane on the left, choose Workspaces > Management. In the workspace list, click the name of the target workspace.
   Figure 3 Workspace management page
   

4. In the navigation pane on the left, choose Settings > Collections. Then, select the Collection Channels tab.
   Figure 4 Collection channel management tab page
   

5. On the right of the group list, click Add.
6. On the displayed page, in the Basic Configuration phase, configure basic information.

   Table 1 Basic configuration parameters

   Parameter		Description
   Basic Information	Title	User-defined collection channel name.
   	Channel grouping	Select the group to which the collection channel belongs.
   	(Optional) Description	(Optional) Enter the description of the collection channel.
   Configure Source	Source Name	Select the source name of the collection channel. After you select a source, the system automatically generates the information about the selected source.
   Destination	Destination Name	Select the destination name of the collection channel. After you select a destination, the system automatically generates the information about the selected destination.

7. After the basic configuration is complete, click Next in the lower right corner of the page.
8. On the Configure Parser page, select a parser. You can check its details.

   If no parser is available or you want to create a parser, click Create and create one. For details, see Creating and Editing a Parser.

9. After the parser is configured, click Next in the lower right corner of the page.
10. On the Select Node page, click Create. In the Add Node dialog box displayed, select a node and click OK.
    • Running parameters: You can configure running parameters for added nodes by taking the following steps:
      1. In the node list, locate the row that contains the target node, and click Running parameters in the Operation column.
      2. Click Add Configuration and select a key and value.

         If you need to optimize the running parameters of a collection channel, SecMaster provides optimization parameters pipeline.batch.size, pipeline.workers, and pipeline.batch.delay for your choice. If no optimizations are required, delete related configurations.

         Table 2 Parameter configuration description

         Parameter	Type	Description
         pipeline.batch.size	int	This parameter specifies the number of events that can be collected by each worker thread each time. A larger value indicates a higher efficiency. However, the memory overhead also increases. You can increase the heap space in jvm.options.
         pipeline.workers	int	This parameter specifies the number of worker threads in the pipeline. The default value is the number of CPU cores.
         pipeline.batch.delay	int	This parameter specifies the delay to submit the current pipeline. You can use this parameter to increase message submission times and system consumption efficiency.

    • To remove an added node, locate the row that contains the target node, click Remove in the Operation column.

11. After the running node is selected, click Next in the lower right corner of the page.
12. On the Preview Channel Details page, confirm the configuration and click Save and Execute.

    If the collection channel healthy status is Normal, all collection channels are successfully delivered. The following table describes the statuses of collection channels.

    Table 3 Health status of a collection channel

    Monitoring Status	Description
    Healthy	The collection channel is successfully delivered.
    Abnormal	Some collection channels are successfully delivered, and some are abnormal.
    Faulty	The collection channel has not been delivered. This status changes according to the heartbeat status, and there is a delay. Generally, the monitoring status is reported every 30 seconds.

Editing a collection channel

1. Log in to the management console.
2. Click in the upper part of the page and choose Security > SecMaster.
3. In the navigation pane on the left, choose Workspaces > Management. In the workspace list, click the name of the target workspace.
   Figure 5 Workspace management page
   

4. In the navigation pane on the left, choose Settings > Collections. Then, select the Collection Channels tab.
   Figure 6 Collection channel management tab page
   

5. In the collection channel list, locate the row that contains the target channel, click More > Edit in the Operation column. The Edit Collection Channel page is displayed.
6. On the displayed page, in the Basic Configuration phase, configure basic information.

   Table 4 Basic configuration parameters

   Parameter		Description
   Basic Information	Channel Name	User-defined collection channel name.
   	Channel grouping	Select the group to which the collection channel belongs.
   	(Optional) Description	(Optional) Enter the description of the collection channel.
   Source Configuration	Source Name	Select the source name of the collection channel. After you select a source, the system automatically generates the information about the selected source.
   	Destination Name	Select the destination name of the collection channel. After you select a destination, the system automatically generates the information about the selected destination.

7. After the basic configuration is complete, click Next in the lower right corner of the page.
8. On the parser configuration page, select a parser to view its details.

   If no parser is available or you want to create a parser, choose Create to create a parser. For details, see Creating and Editing a Parser.

9. After the parser is configured, click Next in the lower right corner of the page.
10. On the Select Node page, click Add. In the Add Node dialog box displayed, select a node and click OK.
    • Running parameters: After a node is added, if you want to configure parameters for the added node, perform the following steps:
      1. In the node list, locate the row that contains the target node, and click Running parameters in the Operation column.
      2. Click Add Configuration and select a key and value.
    • To remove an added node, locate the row that contains the target node, click Remove in the Operation column.

11. After the running node is selected, click Next in the lower right corner of the page.
12. On the Preview Channel Details page, confirm the configuration and click Save and Execute.

Related Operations

For details about how to view, delete, enable, disable, and restart a collection channel, see Managing Collection Channels.