2023-6-30
diff --git a/docs/lts/umn/lts_02_0013.html b/docs/lts/umn/lts_02_0013.html
index fedd58b4c..1fde0e8ef 100644
--- a/docs/lts/umn/lts_02_0013.html
+++ b/docs/lts/umn/lts_02_0013.html
@@ -1,21 +1,22 @@
Installing ICAgent (Intra-Region Hosts)
-To use LTS to collect logs (such as host metrics, container metrics, node logs, container logs, and standard output logs) from intra-region hosts, you need to install ICAgent on the hosts. ICAgent is a log collection tool for LTS. It runs on hosts where logs need to be collected.
+ To use LTS to collect logs (such as node logs, container logs, and standard output) from intra-region hosts, you must install ICAgent on them. ICAgent is a log collection tool for LTS. It runs on hosts where logs need to be collected.
PrerequisitesBefore installing ICAgent, ensure that the time and time zone of your local browser are consistent with those of the host. If they are inconsistent, errors may occur during log reporting.
- Installation MethodsThere are two methods to install ICAgent.
+ Installation ScenariosThere are two methods to install ICAgent. Select one that best suits your needs.
- Table 1 Installation methodsMethod
+Table 1 Installation scenariosScenario
|
-Scenario
+ | Description
|
|---|
Initial installation
|
You can use this method to install ICAgent on a host that has no ICAgent installed.
-Run the ps -aux | grep icagent command on the host to check whether there is an ICAgent process. If no, the ICAgent has not been installed.
+Run the following command on the host. If no ICAgent process is displayed, no ICAgent has been installed on the host.
+ps -aux | grep icagent
|
Inherited installation (supported only for Linux hosts)
@@ -30,43 +31,37 @@
Initial Installation (Linux)- Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Host Management > Hosts in the navigation pane.
- Click Install ICAgent in the upper right corner.
Before installing ICAgent, ensure that the time and time zone of your local browser are consistent with those of the host.
- Set Host to Intra-region hosts.
- Set OS to Linux.
- If you set Installation Mode to Obtain AK/SK, perform this step. Obtain an access key (AK/SK) in advance. You need to enter it when installing ICAgent. AK is used together with SK to sign requests cryptographically, ensuring that the requests are secret, complete, and correct. Ensure that the public account and AK/SK will not be deleted or disabled. If the AK/SK is deleted, ICAgent cannot report data to LTS.
For details, see How Do I Obtain an AK/SK Pair?
- If you set Installation Mode to Create an agency, this step is required. In this installation mode, you do not need to obtain and enter an AK/SK. ICAgent automatically obtains an AK/SK during agency creation.
For details, see How Do I Install ICAgent by Creating an Agency?
- - On the Install ICAgent page, click Copy Command to copy the ICAgent installation command.
- Log in as user root to the host which is deployed in the region same as that you are logged in to (by using a remote login tool such as PuTTY) and run the copied command. If you have chosen Obtain AK/SK as the installation mode, enter the AK/SK as prompted.
- When message "ICAgent install success" is displayed, ICAgent has been installed in the /opt/oss/servicemgr/ directory of the host.
- If the installation fails, uninstall ICAgent and then install it again.
- - Choose Host Management > Hosts in the navigation pane of the LTS console and check whether the ICAgent status is Running.
+ On the Install ICAgent page, click Copy Command to copy the ICAgent installation command.Log in as user root to the host which is deployed in the region same as that you are logged in to (by using a remote login tool such as PuTTY) and run the copied command. If you have chosen Obtain AK/SK as the installation mode, enter the AK/SK as prompted.- When message "ICAgent install success" is displayed, ICAgent has been installed in the /opt/oss/servicemgr/ directory of the host.
- If the installation fails, uninstall ICAgent and then install it again. For details, see Uninstalling ICAgent.
+Choose Host Management > Hosts in the navigation pane of the LTS console and check whether the host's ICAgent status is Running.The NIC information is obtained by ICAgent installed on the node using the ifconfig command. If inet information is not configured for the NIC, the IPv4 address is not reported, and -- is displayed in the Host IPv4 Address column on the Hosts page. If inet6 information is not configured, the IPv6 address is not reported, and -- is displayed in the Host IPv6 Address column on the Hosts page.
+
Initial Installation (Windows)- On the Hosts page of the LTS console, click Install ICAgent in the upper right corner.
- Set Host to Intra-region hosts.
- Set OS to Windows.
- You can download it to the local PC by clicking the name of the package or visiting the download URL.
- Save the ICAgent installation package to a directory on the target host, for example, C:\ICAgent, and decompress the package.
- Obtain an AK/SK. For details, see How Do I Obtain an AK/SK Pair?
- On the Install ICAgent page, click Copy Command to copy the ICAgent installation command to the local PC and replace the AK/SK in the command with the obtained one.
- Open the Command Prompt, go to the directory where the ICAgent installation package is decompressed, and run the copied command.
If the message "Service icagent installed successfully" is displayed, the installation is successful.
+ Initial Installation (Windows)- On the Hosts page of the LTS console, click Install ICAgent in the upper right corner.
- Set Host to Intra-region hosts.
- Set OS to Windows.
- You can download it to the local PC by clicking the name of the package or visiting the download URL.
- Save the ICAgent installation package to a directory on the target host, for example, C:\ICAgent, and decompress the package.
- Obtain an AK/SK. For details, see How Do I Obtain an AK/SK Pair?
- On the Install ICAgent page, click Copy Command to copy the ICAgent installation command to the local PC and replace the AK/SK in the command with the obtained one.
- Open the Command Prompt, go to the directory where the ICAgent installation package is decompressed, and run the copied command.
If the message "Service icagent installed successfully" is displayed, the installation is successful.
- Choose Host Management > Hosts in the navigation pane of the LTS console and check whether the ICAgent status is Running.
+ - Choose Host Management > Hosts in the navigation pane of the LTS console and check whether the host's ICAgent status is Running.
The NIC information is obtained by ICAgent installed on the node using the ifconfig command. If inet information is not configured for the NIC, the IPv4 address is not reported, and -- is displayed in the Host IPv4 Address column on the Hosts page. If inet6 information is not configured, the IPv6 address is not reported, and -- is displayed in the Host IPv6 Address column on the Hosts page.
+
Inherited Installation (Linux)Assume that you need to install ICAgent on multiple hosts, and one of the hosts already has ICAgent installed. The ICAgent installation package, ICProbeAgent.tar.gz, is in the /opt/ICAgent/ directory. To install ICAgent on other hosts one by one:
+ In inherited installation, the hosts must all belong to the same VPC and be on the same subnet.
- Run the following command on the host where ICAgent has been installed, where x.x.x.x is the IP address of the host you want to install ICAgent on.
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -ip x.x.x.x
- - Enter the password for user root of the host when prompted.
- If the Expect tool is installed on the host that has ICAgent installed, the ICAgent installation should be able to complete without prompting you for a password. Otherwise, enter the password as prompted.
- Ensure that user root can run SSH or SCP commands on the host where ICAgent has been installed to remotely communicate with the remote host to install ICAgent.
- When message "ICAgent install success" is displayed, ICAgent has been installed in the /opt/oss/servicemgr/ directory of the host. You can then choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
- If "ICAgent install success" is not displayed, the installation fails. Uninstall ICAgent and install it again.
+ - Enter the password for user root of the host when prompted.
- If the Expect tool is installed on the host that has ICAgent installed, the ICAgent installation should be able to complete without prompting you for a password. Otherwise, enter the password as prompted.
- Ensure that user root can run SSH or SCP commands on the host where ICAgent has been installed to remotely communicate with the remote host to install ICAgent.
- When message "Install ICAgent success" is displayed, ICAgent has been installed in the /opt/oss/servicemgr/ directory of the host. You can then choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
- If "Install ICAgent success" is not displayed, the installation fails. Uninstall ICAgent and install it again. For details, see Uninstalling ICAgent.
Batch Inherited Installation (Linux)Assume that you need to install ICAgent on multiple hosts, and one of the hosts already has ICAgent installed. The ICAgent installation package, ICProbeAgent.tar.gz, is in the /opt/ICAgent/ directory. In this case, you can follow the directions below to install ICAgent on other hosts in batches.
- - The hosts must all belong to the same VPC and be on the same subnet.
- Python 3.* is required for batch installation. If you are prompted that Python cannot be found during ICAgent installation, install Python of a proper version on the host and try again.
+ - The hosts must all belong to the same VPC and be on the same subnet.
- Python 3.* is required for batch installation. If you are prompted that Python cannot be found during ICAgent installation, install Python of a proper version on the host and try again.
+ Prerequisites
+ The IP addresses and root's passwords of all hosts to install ICAgent have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the host that has ICAgent installed. An IP address and the password of a host's user root in the iplist.cfg file must be separated by a space. Examples:
+ 192.168.0.109 Password (Replace the IP address and password with the actual ones)
+ 192.168.0.39 Password (Replace the IP address and password with the actual ones)
+ - The iplist.cfg file contains sensitive information. You are advised to clear it after using it.
+ - If all servers share the same password, the iplist.cfg file only needs to include the IP addresses, not passwords. You need to enter the password during execution. If an IP address has a different password, enter the password after the IP address.
+ Perform the following operations:
+ - Run the following command on the host that has ICAgent installed:
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -batchModeConfig /opt/ICAgent/iplist.cfg
+Enter the default password for user root of the hosts to install ICAgent. If the passwords of all hosts have been configured in the iplist.cfg file, press Enter to skip this step.
+Wait for a while. When message "Install ICAgent success" is displayed, ICAgent has been installed on all the hosts listed in the configuration file.
+ - Choose Host Management > Hosts in the navigation pane of the LTS console to check the hosts' ICAgent statuses. For details, see Checking the ICAgent Status.
- Prerequisites
- The IP addresses and root's passwords of all hosts to install ICAgent have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the host that has ICAgent installed. An IP address and the password of a host's user root in the iplist.cfg file must be separated by a space. Examples:
- 192.168.0.109 Password (Replace the IP address and password with the actual ones)
- 192.168.0.39 Password (Replace the IP address and password with the actual ones)
- - The iplist.cfg file contains sensitive information. You are advised to clear it after using it.
- - If all hosts share a password, list only IP addresses in the iplist.cfg file and enter the password manually during execution. If one of the hosts uses a different password, type the password behind its IP address.
- Procedure
- - Run the following command on the host that has ICAgent installed:
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -batchModeConfig /opt/ICAgent/iplist.cfg
-Enter the default password for user root of the hosts to install ICAgent. If the passwords of all hosts have been configured in the iplist.cfg file, press Enter to skip this step.
-batch install begin
-Please input default passwd:
-send cmd to 192.168.0.109
-send cmd to 192.168.0.39
-2 tasks running, please wait...
-2 tasks running, please wait...
-2 tasks running, please wait...
-End of install agent: 192.168.0.39
-End of install agent: 192.168.0.109
-All hosts install icagent finish.
-Wait for a while. When message "All hosts install icagent finish." is displayed, ICAgent has been installed on all the hosts listed in the configuration file.
- - Choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
diff --git a/docs/lts/umn/lts_02_0014.html b/docs/lts/umn/lts_02_0014.html
index 0894894f2..60c9ec6a1 100644
--- a/docs/lts/umn/lts_02_0014.html
+++ b/docs/lts/umn/lts_02_0014.html
@@ -1,107 +1,106 @@
- Managing ICAgent
- After ICAgent is installed, you can upgrade and uninstall it, and view its status.
- Upgrading ICAgentTo deliver a better collection experience, LTS regularly upgrades ICAgent. When LTS prompts you that a new ICAgent version is available, you can follow the directions here to obtain the latest version.
- Linux hosts support ICAgent upgrade on the LTS console.
- - Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Host Management > Hosts in the navigation pane.
- Select Intra-Region Hosts or Extra-Region Hosts. When the system prompts you that a new ICAgent version is available, select one or more check boxes of hosts where ICAgent is to be upgraded, and click Upgrade ICAgent.
- Click the CCE Cluster tab. Search for and select the cluster whose ICAgent is to be upgraded, and click Upgrade ICAgent.
- If there are no CCE clusters available, Output to AOM is unavailable.
- To disable the function of exporting container standards to AOM, you need to have ICAgent 5.12.133 or later.
- If you create a CCE cluster for the first time, ICAgent will be installed on hosts in the cluster by default, and logs will be reported to AOM. Output to AOM is enabled by default. To report logs to LTS, disable Output to AOM before upgrading ICAgent. You are advised to choose Log Ingestion > Cloud Service > Cloud Container Engine (CCE) to collect container data and output it to LTS instead of AOM.
- CCE cluster ID (ClusterID): Each cluster has a fixed ID.
- When ICAgent is upgraded, LTS creates log groups and host groups for your CCE cluster. The name of the log group and host group is k8s-log-{ClusterID}. You can create an ingestion configuration (Cloud Services > Cloud Container Engine (CCE)) to add logs of the current CCE cluster to the log group.
- If the hosts of a cluster have no ICAgent installed or outdated ICAgent installed, click Upgrade ICAgent to install or upgrade ICAgent on all hosts in the cluster.
- - In the displayed dialog box, click OK.
The upgrade begins. This process takes about a minute. When the ICAgent status changes from Upgrading to Running, the ICAgent upgrade has completed.
-If the ICAgent is abnormal after the upgrade or if the upgrade fails, log in to the host and run the installation command. ICAgent can be re-installed on top of itself.
-
+ Managing ICAgent in Host Scenarios
+ ICAgent is a log collection tool for LTS. It runs on hosts where logs need to be collected. This section describes how to install ICAgent on a host, upgrade ICAgent, uninstall ICAgent, and check the ICAgent status.
+ Host scenarios cover traditional computing environments, such as physical servers and ECSs. Hosts are classified into intra-region and extra-region hosts based on their locations.
+
- Uninstalling ICAgentIf ICAgent is uninstalled from a host, log collection will be affected. Exercise caution when performing this operation.
- Only ICAgent installed on Linux hosts can be uninstalled from the Host Management page of the LTS console. To uninstall ICAgent from a Windows host, go to \ICProbeAgent\bin\manual\win in the directory where the ICAgent installation package was decompressed, and double-click the script named uninstall.bat. If message "ICAgent uninstall success" is displayed, the uninstallation is successful.
- Uninstalling ICAgent does not delete the installation files. You need to delete them manually if necessary.
- You can uninstall ICAgent using either of the following methods:
- - Uninstalling ICAgent on the console: applies to the scenario where ICAgent has been successfully installed.
- Choose Host Management > Hosts in the navigation pane.
- Select one or more hosts where ICAgent is to be uninstalled and click Uninstall ICAgent.
- In the displayed dialog box, click OK.
The uninstallation begins. This process takes about a minute.
+Upgrading ICAgentLTS automatically checks ICAgent versions. When LTS detects that your host is running an outdated ICAgent version, it displays a message indicating that your ICAgent version is too early. - You can click Authorize Auto Upgrade to authorize LTS to automatically upgrade ICAgent during off-peak hours.
- You can also click Manually Upgrade to go to the Host Management page to perform the upgrade yourself.
- If you do not need to upgrade ICAgent, select Do not show again.
- Upgrading ICAgent does not affect your services. You are advised to upgrade ICAgent during off-peak hours.
- During the upgrade, the monitoring metrics reported by ICAgent are interrupted for about 2 to 3 minutes.
- Upgrading ICAgent does not affect log collection. After the upgrade, ICAgent will continue collecting logs from the position before the upgrade.
+
+ Linux hosts support ICAgent upgrade on the LTS console, while Windows hosts do not.
+ - Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Host Management > Hosts in the navigation pane.
- Click the Intra-Region Hosts or Extra-Region Hosts tab. When the system prompts you that a new ICAgent version is available, select one or more hosts where ICAgent is to be upgraded, and click Upgrade ICAgent.
- In the displayed dialog box, click OK.
The ICAgent upgrade takes about 1 minute. When the ICAgent status changes from Updating to Running, the ICAgent upgrade has completed.
+If ICAgent is abnormal after the upgrade or if the upgrade fails, log in to the host and run the installation command to reinstall ICAgent. Uninstalling the original ICAgent is not required. For details, see Installing ICAgent (Intra-Region Hosts) and Installing ICAgent (Extra-Region Hosts).
+
+ Uninstalling ICAgent If ICAgent is uninstalled from a host, log collection will be affected. Exercise caution when performing this operation.
+
+ Uninstalling ICAgent does not delete the installation files. You need to delete them manually if necessary.
+ Only ICAgent installed on Linux hosts can be uninstalled from the Host Management page of the LTS console. To uninstall ICAgent from a Windows host, go to \ICProbeAgent\bin\manual\win in the directory where the ICAgent installation package was decompressed, and double-click the script named uninstall.bat. If message "ICAgent uninstall success" is displayed, the uninstallation is successful.
+ Uninstall ICAgent from a Linux environment using any of the following methods:
+ - Uninstalling ICAgent on the console: applicable to uninstall ICAgent that has been successfully installed.
- Choose Host Management > Hosts in the navigation pane.
- Select one or more hosts where ICAgent is to be uninstalled and click Uninstall ICAgent.
- In the displayed dialog box, click OK.
The uninstallation begins. This process takes about a minute.
After the uninstallation is complete, the ICAgent status of the host will be displayed as Uninstalled in the host list.
To reinstall ICAgent, wait for 5 minutes after it is uninstalled. Otherwise, the ICAgent may be automatically uninstalled again.
- - Logging in to the host to uninstall ICAgent: applies to the scenario where ICAgent fails to be installed.
- Log in to a host where ICAgent is to be uninstalled as user root.
- Run the following command:
bash /opt/oss/servicemgr/ICAgent/bin/manual/uninstall.sh
+ - Logging in to the host to uninstall ICAgent: applicable to uninstall ICAgent that failed to be installed.
- Log in to a host where ICAgent is to be uninstalled as user root.
- Run the following command:
bash /opt/oss/servicemgr/ICAgent/bin/manual/uninstall.sh
If the message "ICAgent uninstall success" is displayed, the uninstallation has completed.
- - Remotely uninstalling ICAgent: applies to the scenario where the ICAgent has been successfully installed and needs to be remotely uninstalled.
You can uninstall ICAgent on one host remotely from another host.
+ - Remotely uninstalling ICAgent: applicable to remotely uninstall ICAgent that has been successfully installed.
You can uninstall ICAgent on one host remotely from another host. In remote uninstallation, the hosts must all belong to the same VPC and be on the same subnet.
- Run the following command on the host where ICAgent has been installed. x.x.x.x indicates the IP address of the host you want to uninstall ICAgent from.
bash /opt/oss/servicemgr/ICAgent/bin/remoteUninstall/remote_uninstall.sh -ip x.x.x.x
- - Enter the password for user root of the host when prompted.
- If the Expect tool is installed on the host that has ICAgent installed, the ICAgent uninstallation should be able to complete without prompting you for a password. Otherwise, enter the password as prompted.
- Ensure that user root can run SSH or SCP commands on the host where ICAgent has been installed to communicate with the remote host.
- If the message "ICAgent uninstall success" is displayed, the uninstallation has completed.
+ - Enter the password for user root of the host when prompted.
- If the Expect tool is installed on the host that has ICAgent installed, the ICAgent uninstallation should be able to complete without prompting you for a password. Otherwise, enter the password as prompted.
- Ensure that user root can run SSH or SCP commands on the host where ICAgent has been installed to communicate with the remote host.
- If the message "Uninstall ICAgent success" is displayed, the uninstallation has completed.
- - Batch uninstalling ICAgent: applies to the scenario where the ICAgent has been installed and needs to be uninstalled in batches.
If ICAgent has been installed on a host and the ICAgent installation package ICProbeAgent.tar.gz is in the /opt/ICAgent/ directory of the host, you can use this method to uninstall ICAgent from multiple hosts at once.
-The hosts must all belong to the same VPC and be on the same subnet.
+ - Batch uninstalling ICAgent: applicable to uninstall ICAgent that has been successfully installed from a batch of hosts.
If ICAgent has been installed on a host and the ICAgent installation package ICProbeAgent.tar.gz is in the /opt/ICAgent/ directory of the host, you can use this method to uninstall ICAgent from multiple hosts at once.
+ The hosts must all belong to the same VPC and be on the same subnet.
+ Prerequisites
-The IP addresses and passwords of all hosts to uninstall ICAgent have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the host that has ICAgent installed. Each IP address and password in the iplist.cfg file must be separated by a space. Examples:
-192.168.0.109 Password (Replace the IP address and password with the actual ones)
-192.168.0.39 Password (Replace the IP address and password with the actual ones)
+The IP addresses and passwords of all hosts to uninstall ICAgent have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the host that has ICAgent installed. Each IP address and password in the iplist.cfg file must be separated by a space. Examples:
+192.168.0.109 Password (Replace the IP address and password with the actual ones)
+192.168.0.39 Password (Replace the IP address and password with the actual ones)
- The iplist.cfg file contains sensitive information. You are advised to clear it after using it.
- If all hosts share a password, list only IP addresses in the iplist.cfg file and enter the password manually during execution. If one of the hosts uses a different password, type the password behind its IP address.
+Procedure
- Run the following command on the host that has ICAgent installed:
bash /opt/oss/servicemgr/ICAgent/bin/remoteUninstall/remote_uninstall.sh -batchModeConfig /opt/ICAgent/iplist.cfg
Enter the default password for user root of the hosts to uninstall ICAgent. If the passwords of all hosts have been configured in the iplist.cfg file, press Enter to skip this step.
-batch uninstall begin
-Please input default passwd:
-send cmd to 192.168.0.109
-send cmd to 192.168.0.39
-2 tasks running, please wait...
-End of uninstall agent: 192.168.0.109
-End of uninstall agent: 192.168.0.39
-All hosts uninstall icagent finish.
-If message "All hosts uninstall icagent finish." is displayed, the batch uninstallation has completed.
+Wait until the message "Uninstall ICAgent success" is displayed, which indicates that ICAgent is successfully uninstalled from all the servers listed in the configuration file.
+However, ICAgent on the server where the uninstallation operation is performed will not be uninstalled. You need to uninstall it from the server separately.
- Choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
Checking the ICAgent StatusChoose Host Management > Hosts in the navigation pane to check the ICAgent status of the target host. The following table lists the ICAgent statuses.
+ Checking the ICAgent StatusIn the navigation pane, choose Host Management > Hosts. Click the Intra-Region Hosts or Extra-Region Hosts tab based on your host's location, locate your host, and check its ICAgent status. For status details, see Table 1.
- Table 1 ICAgent statusesStatus
+Table 1 ICAgent statusesStatus
|
-Description
+ | Description
|
|---|
-Running
+ | Running
|
-ICAgent is running properly.
+ | ICAgent is running properly.
|
-Uninstalled
+ | Uninstalled
|
-ICAgent is not installed.
+ | ICAgent is not installed.
|
-Installing
+ | Installing
|
-ICAgent is being installed. This process takes about one minute.
+ | ICAgent is being installed. This process takes about 1 minute.
|
-Installation failed
+ | Installation failed
|
-ICAgent installation failed.
+ | ICAgent installation failed.
|
-Upgrading
+ | Upgrading
|
-ICAgent is being upgraded. This process takes about one minute.
+ | ICAgent is being upgraded. This process takes about 1 minute.
|
-Upgrade failed
+ | Upgrade failed
|
-ICAgent upgrade failed.
+ | ICAgent upgrade failed.
|
-Offline
+ | Offline
|
-ICAgent is abnormal because the AK/SK is incorrect. Obtain the correct AK/SK and install ICAgent again.
+ | ICAgent is abnormal because the AK/SK is incorrect. Obtain the correct AK/SK and install ICAgent again.
|
-Faulty
+ | Faulty
|
-ICAgent is faulty. Contact technical support.
+ | ICAgent is faulty. Contact technical support.
|
-Uninstalling
+ | Uninstalling
|
-ICAgent is being uninstalled. This process takes about one minute.
+ | ICAgent is being uninstalled. This process takes about 1 minute.
|
-Authentication error
+ | Authentication error
|
-Authentication fails because parameters were incorrectly configured during ICAgent installation.
+ | Authentication fails because parameters were incorrectly configured during ICAgent installation.
|
diff --git a/docs/lts/umn/lts_02_0030.html b/docs/lts/umn/lts_02_0030.html
index a4f45a920..758670c44 100644
--- a/docs/lts/umn/lts_02_0030.html
+++ b/docs/lts/umn/lts_02_0030.html
@@ -4,6 +4,8 @@
+- Using ICAgent to Collect Host Logs
+
- Ingesting Cloud Service Logs to LTS
- Using APIs to Ingest Logs to LTS
diff --git a/docs/lts/umn/lts_02_0828.html b/docs/lts/umn/lts_02_0828.html
index e02884a42..7437d9839 100644
--- a/docs/lts/umn/lts_02_0828.html
+++ b/docs/lts/umn/lts_02_0828.html
@@ -4,11 +4,11 @@
ICAgent is a log collection tool for LTS. To use LTS to collect logs from extra-region hosts, you need to install ICAgent on the hosts. This section describes how to install ICAgent on an extra-region host.
PrerequisitesBefore installing ICAgent, ensure that the time and time zone of your local browser are consistent with those of the host. If they are inconsistent, errors may occur during log reporting.
- Installation MethodsThere are two methods to install ICAgent.
+ Installation ScenariosThere are two methods to install ICAgent. Select one that best suits your needs.
- Table 1 Installation methodsMethod
+Table 1 Installation scenariosScenario
|
-Scenario
+ | Description
|
|---|
@@ -26,15 +26,15 @@
Initial Installation (Linux)Before installing ICAgent on a host not in this region, apply for an ECS as a jump server on the ECS console. For details, see Using Multiple Jump Servers.
-  You are advised to use CentOS 6.5 64bit or later images. The minimum flavor for the ECS is 1 vCPU and 1 GB of memory, while the recommended flavor is 2 vCPUs and 4 GB of memory.
+ Initial Installation (Linux)Before installing ICAgent on a host not in this region, apply for an ECS as a jump server on the ECS console. For details, see Creating Multiple Jump Servers for Load Balancing Using ELB.
+ You are advised to use CentOS 6.5 64bit or later images. The minimum flavor for the ECS is 1 vCPU and 1 GB of memory, while the recommended flavor is 2 vCPUs and 4 GB of memory.
- - Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Host Management > Hosts in the navigation pane.
- Click Install ICAgent in the upper right corner.
- Set Host to Extra-region hosts.
- Set OS to Linux.
- Set Network Connectivity to Private line. When the network is connected via a private line, hosts in other IDCs are disconnected from LTS backend by default and a network connectivity solution is required. You are advised to select VPCEP.
Private line: Extra-region hosts connect to LTS in the current region through a jump server or VPC Endpoint (VPCEP), offering greater security and stability. In this scenario, extra-region hosts cannot communicate with LTS in the current region by default, and ICAgent installed on these hosts cannot directly access the network segment used by LTS in the current region to report logs. Therefore, you need to configure a network connection solution to use a jump server or VPCEP to connect to the LTS backend and forward data to LTS. - Jump server: functions as a data forwarder and forwards the data collected by ICAgent from extra-region hosts to LTS. This solution is suitable for tests or scenarios with low log traffic. VPCEP is recommended for scenarios with high log traffic.
- VPCEP: provides private channels to connect your VPC to LTS in the current region, enabling resources in the VPC to access VPC endpoint services without the need for EIPs. This solution reduces the risks of data transmission on public networks and improves the transmission security and efficiency.
+ - Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Host Management > Hosts in the navigation pane.
- Click Install ICAgent in the upper right corner.
- Set Host to Extra-region hosts.
- Set OS to Linux.
- Set Network Connectivity. For extra-region hosts to report logs to LTS in the current region, you are advised to select Private line for higher stability and reliability.
Private line: Extra-region hosts connect to LTS in the current region through a jump server or VPC Endpoint (VPCEP), offering greater security and stability. In this scenario, extra-region hosts cannot communicate with LTS in the current region by default, and ICAgent installed on these hosts cannot directly access the network segment used by LTS in the current region to report logs. Therefore, you need to configure a network connection solution to use a jump server or VPCEP to connect to the LTS backend and forward data to LTS. - Jump server: functions as a data forwarder and forwards the data collected by ICAgent from extra-region hosts to LTS. This solution is suitable for tests or scenarios with low log traffic. VPCEP is recommended for scenarios with high log traffic.
- VPCEP: provides private channels to connect your VPC to LTS in the current region. This solution reduces the risks of data transmission on public networks and improves the transmission security and efficiency.
- If you set LTS Backend Connection to VPCEP, enter the VPCEP domain name and go to 9.
With the assistance of network engineers, configure DNS domain name resolution rules on other clouds to resolve VPCEP domain names to specified IP addresses.
Then, copy the ping command displayed on this page and run it on the target host whose logs are to be collected. A successful ping test indicates that the network configuration is correct.
- - Enable forwarding ports on the jump server. This step is mandatory when LTS Backend Connection is set to Jump server.
- Apply for an ECS in the current region as a jump server.
- Add security group rules for the jump server and enable the corresponding inbound ports to ensure data connectivity between the extra-region hosts and the jump server.
- On the ECS console, click the ECS name to access the details page, and click the Security Groups tab. The security group list is displayed.
- Click a security group name to access the details page.
- On the security group details page, click the Inbound Rules tab and then click Add Rule. On the page displayed, add a security group rule based on Table 2.
+
- Enable forwarding ports on the jump server. This step is mandatory when LTS Backend Connection is set to Jump server.
- Apply for an ECS in the current region as a jump server.
- Add security group rules for the jump server and enable the corresponding inbound ports to ensure data connectivity between the extra-region hosts and the jump server.
- On the ECS console, click the ECS name to access the details page, and click the Security Groups tab. The security group list is displayed.
- Click a security group name to access the details page.
- On the security group details page, click the Inbound Rules tab and then click Add Rule. On the page displayed, add a security group rule based on Table 2.
Table 2 Security group ruleDirection
|
Protocol
@@ -58,30 +58,27 @@
|
|---|
- - Enter the private IP address of the jump server and generate an SSH tunneling command.
Figure 1 Entering the private IP address of the jump server
- The private IP address of the jump server refers to the internal IP address of the VPC where the jump server is located.
-
- - Click Copy Command.
- Log in to the jump server as user root and run the SSH tunneling command:
ssh -f -N -L {Jump server IP address}:8149:{ELB IP address}:8149 -L {Jump server IP address}:8102:{ELB IP address}:8102 -L {Jump server IP address}:8923:{ELB IP address}:8923 -L {Jump server IP address}:30200:{ELB IP address}:30200 -L {Jump server IP address}:30201:{ELB IP address}:30201 -L {Jump server IP address}:80:icagent-{Region}.{OBS domain name}:80 {Jump server IP address}
-Enter the password of user root as prompted.
- - Run the netstat -lnp | grep ssh command to check whether the corresponding TCP ports are being listened to. If the command output similar to Figure 2 is returned, the ports are open.
Figure 2 Open TCP ports
+ - Go back to the LTS console. On the Install ICAgent page, enter the obtained private IP address of the jump server to generate its SSH tunneling command. The private IP address of the jump server refers to the internal IP address of the VPC where the jump server is located.
Figure 1 Entering the private IP address of the jump server
+ - On the Install ICAgent page, click Copy Command to copy the SSH tunneling command.
- Log in to the jump server as user root and run the SSH tunneling command.
Enter the password of user root as prompted.
+ - Run the following command to check whether the corresponding ports are being listened to. If the command output similar to Figure 2 is returned, the TCP ports are open.
netstat -lnp | grep ssh
+Figure 2 Verification results of TCP ports
If the jump server powers off and restarts, run the preceding command again.
- - Obtain an AK/SK and specify DC and Connection IP.
- DC: Specify a name for the data center of the host so it is easier to find the host.
- Connection IP: For EIP connection, use the EIP of the jump server. For VPC peering connection, use the internal IP address of the VPC where the jump server locates.
-
+ - Obtain an AK/SK and specify DC and Connection IP.
- DC: Specify a name for the data center of the host so it is easier to find the host.
- Connection IP: For EIP connection, use the EIP of the jump server. For VPC peering connection, use the internal IP address of the VPC where the jump server locates.
- - Copy the ICAgent installation command.
- Log in as user root to the host which is deployed in the region same as that you are logged in to (by using a remote login tool such as PuTTY) and run the copied command.
- When message "ICAgent install success" is displayed, ICAgent has been installed in the /opt/oss/servicemgr/ directory of the host. You can then choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
- If the installation fails, uninstall ICAgent and reinstall it. If the reinstallation fails, contact technical support.
+ - Copy the ICAgent installation command on the Install ICAgent page.
- Log in as user root to the host which is deployed in the region same as that you are logged in to (by using a remote login tool such as PuTTY) and run the copied command.
- When message "ICAgent install success" is displayed, ICAgent has been installed in the /opt/oss/servicemgr/ directory of the host. You can then choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
- If the installation fails, uninstall ICAgent and then install it again. For details, see Uninstalling ICAgent.
- The NIC information is obtained by ICAgent installed on the node using the ifconfig command. If inet information is not configured for the NIC, the IPv4 address is not reported, and -- is displayed in the Host IPv4 Address column on the Hosts page. If inet6 information is not configured, the IPv6 address is not reported, and -- is displayed in the Host IPv6 Address column on the Hosts page.
- Initial Installation (Windows)Before installing ICAgent on a host not in this region, apply for a Linux ECS as a jump server on the ECS console. For details, see Using Multiple Jump Servers.
+ Initial Installation (Windows)Before installing ICAgent on a host not in this region, apply for a Linux ECS as a jump server on the ECS console. For details, see Creating Multiple Jump Servers for Load Balancing Using ELB.
You are advised to use CentOS 6.5 64bit or later images. The minimum flavor for the ECS is 1 vCPU and 1 GB of memory, while the recommended flavor is 2 vCPUs and 4 GB of memory.
- - Click Install ICAgent in the upper right corner.
- Set Host to Extra-region hosts.
- Set OS to Windows.
- Set Network Connectivity to Private line. When the network is connected via a private line, hosts in other IDCs are disconnected from LTS backend by default and a network connectivity solution is required. You are advised to select VPCEP.
Private line: Extra-region hosts connect to LTS in the current region through a jump server or VPC Endpoint (VPCEP), offering greater security and stability. In this scenario, extra-region hosts cannot communicate with LTS in the current region by default, and ICAgent installed on these hosts cannot directly access the network segment used by LTS in the current region to report logs. Therefore, you need to configure a network connection solution to use a jump server or VPCEP to connect to the LTS backend and forward data to LTS. - Jump server: functions as a data forwarder and forwards the data collected by ICAgent from extra-region hosts to LTS. This solution is suitable for tests or scenarios with low log traffic. VPCEP is recommended for scenarios with high log traffic.
- VPCEP: provides private channels to connect your VPC to LTS in the current region, enabling resources in the VPC to access VPC endpoint services without the need for EIPs. This solution reduces the risks of data transmission on public networks and improves the transmission security and efficiency.
+ - Click Install ICAgent in the upper right corner.
- Set Host to Extra-region hosts.
- Set OS to Windows.
- Set Network Connectivity. For extra-region hosts to report logs to LTS in the current region, you are advised to select Private line for higher stability and reliability.
Private line: Extra-region hosts connect to LTS in the current region through a jump server or VPC Endpoint (VPCEP), offering greater security and stability. In this scenario, extra-region hosts cannot communicate with LTS in the current region by default, and ICAgent installed on these hosts cannot directly access the network segment used by LTS in the current region to report logs. Therefore, you need to configure a network connection solution to use a jump server or VPCEP to connect to the LTS backend and forward data to LTS. - Jump server: functions as a data forwarder and forwards the data collected by ICAgent from extra-region hosts to LTS. This solution is suitable for tests or scenarios with low log traffic. VPCEP is recommended for scenarios with high log traffic.
- VPCEP: provides private channels to connect your VPC to LTS in the current region. This solution reduces the risks of data transmission on public networks and improves the transmission security and efficiency.
- If you set LTS Backend Connection to VPCEP, enter the VPCEP domain name and go to 7.
With the assistance of network engineers, configure DNS domain name resolution rules on other clouds to resolve VPCEP domain names to specified IP addresses.
Then, copy the ping command displayed on this page and run it on the target host whose logs are to be collected. A successful ping test indicates that the network configuration is correct.
- - Enable forwarding ports on the jump server. This step is mandatory when LTS Backend Connection is set to Jump server.
- Apply for a Linux ECS in the current region as a jump server.
- Modify the security group rule used by the jump server.
- On the ECS details page, click the Security Groups tab.
- Click a security group name to access the details page.
- On the security group details page, click the Inbound Rules tab and then click Add Rule. On the page displayed, add a security group rule based on Table 3.
+
- Enable forwarding ports on the jump server. This step is mandatory when LTS Backend Connection is set to Jump server.
- Apply for a Linux ECS in the current region as a jump server.
- Modify the security group rule used by the jump server.
- On the ECS details page, click the Security Groups tab.
- Click a security group name to access the details page.
- On the security group details page, click the Inbound Rules tab and then click Add Rule. On the page displayed, add a security group rule based on Table 3.
Table 3 Security group ruleDirection
|
Protocol
@@ -105,61 +102,68 @@
|
|---|
- - Enter the private IP address of the jump server and generate an SSH tunneling command.
The private IP address of the jump server refers to the internal IP address of the VPC where the jump server is located.
-
- - Click Copy Command.
- Log in to the jump server as user root and run the SSH tunneling command:
ssh -f -N -L {Jump server IP address}:8149:{ELB IP address}:8149 -L {Jump server IP address}:8102:{ELB IP address}:8102 -L {Jump server IP address}:8923:{ELB IP address}:8923 -L {Jump server IP address}:30200:{ELB IP address}:30200 -L {Jump server IP address}:30201:{ELB IP address}:30201 -L {Jump server IP address}:80:icagent-{Region}.{OBS domain name}:80 {Jump server IP address}
-Enter the password of user root as prompted.
- - Run the netstat -lnp | grep ssh command to check whether the corresponding TCP ports are being listened to. If the command output similar to Figure 3 is returned, the ports are open.
Figure 3 Open TCP ports
+ - Go back to the LTS console. On the Install ICAgent page, enter the obtained private IP address of the jump server to generate its SSH tunneling command. The private IP address of the jump server refers to the internal IP address of the VPC where the jump server is located.
- On the Install ICAgent page, click Copy Command to copy the SSH tunneling command.
- Log in to the jump server as user root and run the SSH tunneling command.
Enter the password of user root as prompted.
+ - Run the netstat -lnp | grep ssh command to check whether the corresponding ports are being listened to. If the command output similar to Figure 3 is returned, the TCP ports are open.
Figure 3 Verification results of TCP ports
If the jump server powers off and restarts, run the preceding command again.
- - Download the ICAgent installation package to the local PC as prompted.
- Save the ICAgent installation package to a directory on the Windows host, for example, C:\ICAgent, and decompress the package.
- Obtain an AK/SK.
- Generate and copy the installation command.
- Enter the connection IP in the text box and replace the AK/SK to generate the installation command.
Connection IP: For EIP connection, use the EIP of the jump server. For VPC peering connection, use the internal IP address of the VPC where the jump server locates.
-
+ - Download the ICAgent installation package to the local PC as prompted.
- Save the ICAgent installation package to a directory on the Windows host, for example, C:\ICAgent, and decompress the package.
- Obtain an AK/SK and save it to replace the AK/SK in the installation command.
- Generate the installation command and copy it.
- Enter the connection IP in the text box and replace the AK/SK to generate the installation command.
Connection IP: For EIP connection, use the EIP of the jump server. For VPC peering connection, use the internal IP address of the VPC where the jump server locates.
- Click Copy Command to copy the ICAgent installation command.
- - Open the Command Prompt, go to the directory where the ICAgent installation package is decompressed, and run the copied command.
- If the message "Service icagent installed successfully" is displayed, the installation is successful. You can then choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
- If the installation fails, uninstall ICAgent and reinstall it. If the reinstallation fails, contact technical support.
+ - Open the Command Prompt, go to the directory where the ICAgent installation package is decompressed, and run the copied command.
- If the message "Service icagent installed successfully" is displayed, the installation is successful. You can then choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
- If the installation fails, uninstall ICAgent and then install it again. For details, see Uninstalling ICAgent.
- The NIC information is obtained by ICAgent installed on the node using the ifconfig command. If inet information is not configured for the NIC, the IPv4 address is not reported, and -- is displayed in the Host IPv4 Address column on the Hosts page. If inet6 information is not configured, the IPv6 address is not reported, and -- is displayed in the Host IPv6 Address column on the Hosts page.
- Using Multiple Jump Servers You can use multiple jump servers to prevent the risk of single point of failures and improve access reliability.
+ Creating Multiple Jump Servers for Load Balancing Using ELBA single jump server may encounter a single point of failure (SPOF), potentially leading to O&M instability. To mitigate this, you can create multiple jump servers and use ELB to distribute traffic among them, enhancing access reliability.
+ - Create a Linux ECS that as a jump server.
Log in to the ECS console and create a Linux ECS. If you already have an ECS that meets the requirements, you can directly use it as the jump server.
+ Configure the CPU and memory based on the service requirements. The recommended specifications are 2 vCPUs and 4 GB of memory, or above.
-- Create a Linux ECS that as a jump server.
Configure the CPU and memory based on the service requirements. The recommended specifications are 2 vCPUs and 4 GB of memory, or above.
-
- - Log in to the jump server as use root and use the internal IP address of the jump server to create an SSH tunnel.
- On the ECS console, locate the jump server and obtain its private IP address.
- On the LTS console, choose Host Management in the navigation pane, and click Install ICAgent in the upper right corner. In the dialog box displayed, select Linux for OS, select Extra-region hosts for Host, and enter the private IP address to generate the SSH tunneling command. Log in to the jump server and run the command to create an SSH tunnel.
-
- If there are multiple jump servers, repeat 2 and add them to the same VPC. When creating an ECS, select the same VPC for Network.
- Create a load balancer. When creating the load balancer, you should:
- Select the same VPC as that of the jump servers.
- Create an EIP for connecting to the jump servers.
- Apply for the bandwidth based on the service requirements.
- - Add listeners for TCP ports 30200, 30201, 8149, 8923, and 8102.
- Add all jump servers to the backend server group.
+ - Add security group rules for the jump server and enable the corresponding inbound ports to ensure data connectivity between the extra-region hosts and the jump server.
- Log in to the ECS console, check the ECS list, and locate the ECS that you created as the jump server.
- Click its name to go to the ECS details page. Click the security group name to access the security group details page.
- Click the Inbound Rules tab and click Add Rule. Set the ports by referring to Table 4. Set other parameters based on your network requirements.
+
Table 4 Security group ruleAction
+ |
+Protocol
+ |
+Port
+ |
+Description
+ |
+
|---|
+
+Allow
+ |
+TCP
+ |
+8149,8102,8923,30200,30201,80
+ |
+Ports used by ICAgent to send data to the jump server, ensuring data connectivity between hosts in other regions and the jump server.
+ |
+
+
+
+
+ - Return to the ECS list, locate the ECS created in 1, and view its private IP address and EIP (available if an EIP has been enabled).
- Log in to the LTS console. In the navigation pane, choose Host Management > Hosts. Click Install ICAgent. On the displayed page, enter the private IP address of the jump server to generate the SSH tunneling command. The private IP address of the jump server refers to the internal IP address of the VPC where the jump server is located.
- On the Install ICAgent page, click Copy Command to copy the SSH tunneling command.
- Log in to the jump server as user root and run the copied SSH tunneling command.
- Repeat the preceding steps to create multiple jump servers. Add them to the same VPC by selecting the same VPC for Network during their creation.
- Log in to the ELB console and create a load balancer. When creating the load balancer, you should:
- Select the same VPC as that of the jump servers.
- Create an EIP for connecting to the jump servers.
- Apply for the bandwidth based on the service requirements.
+ - Add listeners for TCP ports 30200, 30201, 8149, 8923, and 8102.
- Create a backend server group and add all the jump servers to it.
- Return to the LTS console. On the Install ICAgent page, enter the EIP of the load balancer in Connection IP, copy the installation command, and run it on the extra-region host.
Inherited Installation (Linux)Assume that you need to install ICAgent on multiple hosts, and one of the hosts already has ICAgent installed. The ICAgent installation package, ICProbeAgent.tar.gz, is in the /opt/ICAgent/ directory. To install ICAgent on other hosts one by one:
- - Run the following command on the host where ICAgent has been installed, where x.x.x.x is the IP address of the host you want to install ICAgent on.
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -ip x.x.x.x
+- Run the following command on the host where ICAgent has been installed, where x.x.x.x is the IP address of the host you want to install ICAgent on.
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -ip x.x.x.x
- Enter the password for user root of the host when prompted.
- If the Expect tool is installed on the host that has ICAgent installed, the ICAgent installation should be able to complete without prompting you for a password. Otherwise, enter the password as prompted.
- Ensure that user root can run SSH or SCP commands on the host where ICAgent has been installed to remotely communicate with the remote host to install ICAgent.
- When message "ICAgent install success" is displayed, ICAgent has been installed in the /opt/oss/servicemgr/ directory of the host. You can then choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
- If the installation fails, uninstall ICAgent and reinstall it. If the reinstallation fails, contact technical support.
- Batch Inherited Installation (Linux)Assume that you need to install ICAgent on multiple hosts, and one of the hosts already has ICAgent installed. The ICAgent installation package, ICProbeAgent.tar.gz, is in the /opt/ICAgent/ directory. In this case, you can follow the directions below to install ICAgent on other hosts in batches.
-  - The hosts must all belong to the same VPC and be on the same subnet.
-
+ Batch Inherited Installation (Linux)Assume that you need to install ICAgent on multiple hosts, and one of the hosts already has ICAgent installed. The ICAgent installation package, ICProbeAgent.tar.gz, is in the /opt/ICAgent/ directory. In this case, you can follow the directions below to install ICAgent on other hosts in batches.
+ - The hosts must all belong to the same VPC and be on the same subnet.
- Python 3.* is required for batch installation. If you are prompted that Python cannot be found during ICAgent installation, install Python of a proper version on the host and try again.
+ Prerequisites
+ The IP addresses and root's passwords of all hosts to install ICAgent have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the host that has ICAgent installed. An IP address and the password of a host's user root in the iplist.cfg file must be separated by a space. Examples:
+ 192.168.0.109 Password (Replace the IP address and password with the actual ones)
+ 192.168.0.39 Password (Replace the IP address and password with the actual ones)
+ - The iplist.cfg file contains sensitive information. You are advised to clear it after using it.
+ - If all servers share the same password, the iplist.cfg file only needs to include the IP addresses, not passwords. You need to enter the password during execution. If an IP address has a different password, enter the password after the IP address.
+ Perform the following operations:
+ - Run the following command on the host that has ICAgent installed:
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -batchModeConfig /opt/ICAgent/iplist.cfg
+Enter the default password for user root of the hosts to install ICAgent. If the passwords of all hosts have been configured in the iplist.cfg file, press Enter to skip this step.
+Wait for a while. When message "Install ICAgent success" is displayed, ICAgent has been installed on all the hosts listed in the configuration file.
+ - Choose Host Management > Hosts in the navigation pane of the LTS console to check the hosts' ICAgent statuses. For details, see Checking the ICAgent Status.
- Prerequisites
- The IP addresses and passwords of all hosts to install ICAgent have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the host that has ICAgent installed. Each IP address and password in the iplist.cfg file must be separated by a space. Examples:
- 192.168.0.109 Password (Replace the IP address and password with the actual ones)
- 192.168.0.39 Password (Replace the IP address and password with the actual ones)
- - The iplist.cfg file contains sensitive information. You are advised to clear it after using it.
- - If all hosts share a password, list only IP addresses in the iplist.cfg file and enter the password manually during execution. If one of the hosts uses a different password, type the password behind its IP address.
-
- Procedure
- - Run the following command on the host that has ICAgent installed:
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -batchModeConfig /opt/ICAgent/iplist.cfg
-Enter the default password for user root of the hosts to install ICAgent. If the passwords of all hosts have been configured in the iplist.cfg file, press Enter to skip this step.
-batch install begin
-Please input default passwd:
-send cmd to 192.168.0.109
-send cmd to 192.168.0.39
-2 tasks running, please wait...
-2 tasks running, please wait...
-2 tasks running, please wait...
-End of install agent: 192.168.0.39
-End of install agent: 192.168.0.109
-All hosts install icagent finish.
-If the message "All hosts install icagent finish." is displayed, ICAgent has been installed on all the hosts listed in the configuration file.
- - Choose Host Management > Hosts in the navigation pane of the LTS console to check the ICAgent status.
@@ -167,3 +171,10 @@ All hosts install icagent finish.
+
+
\ No newline at end of file
diff --git a/docs/lts/umn/lts_02_0926.html b/docs/lts/umn/lts_02_0926.html
index 76ec85aab..af2459537 100644
--- a/docs/lts/umn/lts_02_0926.html
+++ b/docs/lts/umn/lts_02_0926.html
@@ -1,12 +1,12 @@
- Creating an Alarm Action Rule
- LTS allows you to customize alarm action rules. You can create an alarm action rule to associate an SMN topic with a message template. You can also customize notification content when creating a message template.
+ Creating an Alarm Notification Rule
+ LTS allows you to create custom alarm notification rules. An alarm notification rule associates an SMN topic with a message template. When an alarm is triggered, SMN automatically sends an alarm notification via channels like SMS or email, using the specified message template.
Prerequisites- A topic has been created.
- A topic policy has been configured.
- A subscriber has been added to the topic. A subscriber is the recipient of the notification, for example, an email or SMS message receiver.
- PrecautionYou can create a maximum of 1,000 alarm action rules. If this number has been reached, delete unnecessary rules.
+ PrecautionYou can create up to 1,000 alarm notification rules. If this limit has been reached, delete unnecessary rules.
- Creating an Alarm Action Rule- Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Log Alarms in the navigation pane.
- Click the Alarm Action Rules tab.
- Click Create. Set parameters such as the action rule name and action rule configuration.
+ Creating an Alarm Notification Rule- Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Log Alarms in the navigation pane.
- Click the Alarm Action Rules tab.
- Click Create. Set parameters such as the notification rule name and notification rule configuration.
Table 1 Parameters for configuring an alarm action ruleParameter
|
Description
@@ -46,43 +46,10 @@
- Click OK.
-More OperationsAfter an alarm action rule is created, you can perform operations described in Table 2.
-
- Table 2 Related operationsOperation
- |
-Description
- |
-
|---|
-
-Modifying an alarm action rule
- |
-Click Modify in the Operation column.
- |
-
-Exporting an alarm action rule
- |
-Select one or more alarm action rules and click Export. If no alarm action rule is selected, clicking Export will export all alarm action rules.
- |
-
-Deleting an alarm action rule
- |
-
- |
-
-Searching for an alarm action rule
- |
-Enter a rule name in the search box in the upper right corner and click  .
- |
-
-
-
-
- Managing Host Groups
-Host groups allow you to configure host log ingestion efficiently. You can add multiple hosts to a host group and associate the host group with log ingestion configurations. The ingestion configurations will then be applied to all the hosts in the host group.
+ A host group is a virtual group of hosts, allowing you to configure host log collection efficiently. You can add multiple hosts to a host group and associate the host group with log ingestion configurations. The ingestion configurations will then be applied to all the hosts in the host group.
- When there is a new host, simply add it to a host group and the host will automatically inherit the log ingestion configurations associated with the host group.
- You can also use host groups to modify the log collection paths for multiple hosts at one go.
- You can create host groups of the IP address and custom identifier types.
+ You can create host groups of the IP address or custom identifier type.
- Creating a Host Group (IP Address)- Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Host Management > Host Groups in the navigation pane.
- Click Create Host Group in the upper right corner.
- In the displayed slide-out panel, enter a host group name, select IP for Host Group Type, and select a host OS (Linux or Windows).
- In the host list, select one or more hosts to add to the group and click OK.
- You can filter hosts by host name or host IP address. You can also click Search by Host IP Address and enter multiple host IP addresses in the displayed search box to search for matches.
- If your desired hosts are not in the list, click Install ICAgent. On the displayed page, install ICAgent on the hosts as prompted. For details, see Installing ICAgent (Intra-Region Hosts).
+Creating a Host Group (IP Address)- Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Host Management > Host Groups in the navigation pane.
- Click Create Host Group.
- In the displayed slide-out panel, enter a host group name, select IP for Host Group Type, and select a host OS (Linux or Windows). Enter remarks. Up to 1,024 characters are allowed.
- In the host list, select one or more hosts to add to the group and click OK.
- You can filter hosts by host name, enterprise project, IPv4 address, or IPv6 address. You can also click Search by Host IP Address and enter multiple host IP addresses in the displayed search box to search for matches.
- If your desired hosts are not in the list, click Install ICAgent. On the displayed page, install ICAgent on the hosts as prompted. For details, see Installing ICAgent (Intra-Region Hosts).
Creating a Host Group (Custom Identifier)To create a host group of the custom identifier type, you need to plan the hosts to be identified in advance and ensure that ICAgent has been installed on the hosts.
- - Click Create Host Group in the upper right corner.
- In the displayed slide-out panel, enter a host group name, select Custom identifier for Host Group Type, and select a host OS (Linux or Windows).
Figure 1 Creating a custom identifier host group
- - Enter a custom identifier. You can also click
 to enter more.Up to 10 custom identifiers can be added.
- - Click OK. After the host group is created, go to 5 to add hosts to it.
- Perform the following operations to create the custom_tag file to save host tags:
- Log in to the host and run the cd /opt/cloud command. If the system indicates that the /opt/cloud directory does not exist, run the mkdir /opt/cloud/ command to create it. If the /opt/cloud directory already exists, navigate to it and run the mkdir lts command to create the lts directory in it.
- Run the chmod 750 lts command to modify the permission on the lts directory.
- Run the touch custom_tag command in the lts directory to create the custom_tag file.
- Run the chmod 640 custom_tag;vi custom_tag command to modify the custom_tag permission and open the file.
- Press i to enter the insert mode, enter a custom identifier, press Esc, enter :wq!, save the modification and exit.
- Use either of the following methods to add a host to the custom identifier host group:
+
- Click Create Host Group.
- In the displayed slide-out panel, enter a host group name, select Custom identifier for Host Group Type, and select a host OS (Linux or Windows). Enter remarks. Up to 1,024 characters are allowed.
Figure 1 Creating a custom identifier host group
+ - Enter a custom identifier. You can also click Add to enter more.
Up to 10 custom identifiers can be added.
+ - Click OK. After the host group is created, go to 5 to add hosts to it.
- Perform the following operations to create the custom_tag file to save host tags:
- Log in to the host and run the following command to check for the /opt/cloud directory:
cd /opt/cloud
+- If the /opt/cloud directory does not exist, run the following command to create it:
mkdir /opt/cloud/
+ - If the /opt/cloud directory already exists, navigate to it and run the following command to create the lts directory in it.
mkdir lts
+
+ - Run the following command to change the permission on the lts directory:
chmod 750 lts
+ - Run the following command in the lts directory to create the custom_tag file.
cd lts
+touch custom_tag
+ - Run the following command to modify the custom_tag permission and open the file.
chmod 640 custom_tag;vi custom_tag
+ - Press i to enter the insert mode, enter a custom identifier, press Esc, enter :wq!, save the modification and exit.
:wq!
+ - Use either of the following methods to add a host to the custom identifier host group:
Table 1 MethodsType
|
Method 1 (Recommended)
@@ -52,13 +61,13 @@
|
|---|
Changing a host group name
|
-- Go to the Host Groups page.
- In the host group list, click the modification button in the Operation column of the target host group.
- On the displayed dialog box, modify the information such as the host group name and custom identifier.
- Click OK.
+ | - On the Host Groups list, click Modify in the Operation column of the target host group.
- On the displayed dialog box, modify the information such as the host group name and custom identifier.
- Click OK.
|
Adding hosts to a host group
|
Method 1:
-- In the host group list, click
 in the row containing the target host group whose type is IP. - Click Add Host.
- In the displayed slide-out panel, all hosts that are not in the host group and run the selected OS type are displayed. Select the hosts to be added to the host group.
- You can filter hosts by host name or host IP address. You can also click
 and enter multiple host IP addresses in the displayed search box to search for matches. - If your desired hosts are not in the list, click Install ICAgent. On the displayed page, install ICAgent on the hosts as prompted. For details, see Installing ICAgent.
+- In the host group list, locate the host group whose host group type is IP and click next to the host group name.
- Click Add Host.
- In the displayed slide-out panel, all hosts that are not in the host group and run the selected OS type are displayed. Select the hosts to be added to the host group.
- You can filter hosts by host name, enterprise project, IPv4 address, or IPv6 address. You can also click Search by Host IP Address and enter multiple host IP addresses in the displayed search box to search for matches.
- If your desired hosts are not in the list, click Install ICAgent. On the displayed page, install ICAgent on the hosts as prompted. For details, see Installing ICAgent.
- Click OK.
Method 2:
- Choose Host Management > Hosts in the navigation pane.
- In the host list, select the target hosts and click Add to Host Group.
- In the displayed slide-out panel, select the target host group.
- Click OK.
@@ -66,8 +75,7 @@
|
Removing a host from a host group
|
-- In the host group list, click
 in the row containing the target host group. - In the host list, click Remove in the Operation column of the row containing the host to be removed.
- In the displayed dialog box, click OK.
This operation is not supported for hosts in the custom identifier host group.
-
+ | - In the host group list, click in the row containing the target host group.
- In the host list, click Remove in the Operation column of the row containing the host to be removed.
- In the displayed dialog box, click OK. This operation is not supported for hosts in the custom identifier host group.
|
Uninstalling ICAgent from a host
@@ -93,7 +101,7 @@
|
Disassociating a host group from multiple ingestion configurations
|
-- Click the Associated Ingestion Configurations tab, select the target ingestion configurations, and then click Disassociate above the list.
- Click OK.
+ | - In the host group list, click
 in the row containing the target host group. - The Hosts tab page is displayed by default. Click the Associated Ingestion Configurations tab, select the target ingestion configurations, and then click Disassociate above the list.
- Click OK.
|
Copying a host group ID
@@ -103,14 +111,17 @@
|
Exporting host information
|
-- On the Hosts page, switch to the Intra-Region Hosts, CCE Cluster, or Extra-Region Hosts tab and select the desired hosts.
- Click Export to export the information of the selected hosts to the local PC.
+ | - On the Hosts page, switch to the Intra-Region Hosts, CCE Cluster, or Extra-Region Hosts tab and select the desired hosts.
- Click Export and choose Export all data to an XLSX file or Export selected data to an XLSX file to export the host information to your local PC.
|
Deleting Host Groups- Choose Host Management > Host Groups in the navigation pane.
- Delete a host group:
- Click the deletion icon in the Operation column of the row containing the target host group.
- In the displayed dialog box, click OK.
+Deleting Host GroupsYou can delete a host group that is no longer needed.
+ Deleting a host group may lead to log ingestion exceptions. In addition, deleted host groups cannot be restored.
+
+ - Choose Host Management > Host Groups in the navigation pane.
- Delete a host group:
- Click Delete in the Operation column of the target host group.
- In the displayed dialog box, click OK.
- Delete host groups in batches:
- Select host groups to be deleted and click Delete above the list.
- In the displayed dialog box, click OK.
+
+
\ No newline at end of file
diff --git a/docs/lts/umn/lts_03_0002.html b/docs/lts/umn/lts_03_0002.html
index 79a6c6e80..95a48c243 100644
--- a/docs/lts/umn/lts_03_0002.html
+++ b/docs/lts/umn/lts_03_0002.html
@@ -21,7 +21,7 @@
|
|---|
Cloud Service
|
-Select ECS.
+ | Select Elastic Cloud Server (ECS) and Bare Metal Server (BMS).
|
Validity Period
diff --git a/docs/lts/umn/lts_04_0003.html b/docs/lts/umn/lts_04_0003.html
index e7577714b..67a60d677 100644
--- a/docs/lts/umn/lts_04_0003.html
+++ b/docs/lts/umn/lts_04_0003.html
@@ -1,7 +1,7 @@
Managing Log Groups
-A log group is the basic unit for LTS to manage logs. It classifies and consists of log streams, but does not store any log data. Up to 100 log groups can be created for each account.
+ A log group is the basic unit for LTS to manage logs. It classifies and consists of log streams, but does not store any log data itself. Up to 100 log groups can be created for each account.
A log group usually corresponds to a project or business in a company. You are advised to sort log streams of various applications or services within a project or business to the same log group. In this way, project staff only need to monitor log streams in the log group corresponding to their project, without being distracted by log streams of other projects.
LTS allows you to add tags to log groups to help O&M personnel manage services.
PrerequisitesYou have obtained an account and its password for logging in to the LTS console.
@@ -15,13 +15,15 @@
|
Log Group Name
|
-- Enter 1 to 64 characters, including only letters, digits, hyphens (-), underscores (_), and periods (.). Do not start with a period or underscore or end with a period.
- Collected logs are sent to log streams of the corresponding log groups. If there are too many logs to collect, separate logs into different log groups based on log types, and name log groups in an easily identifiable way.
+ | A log group is the basic unit for LTS to manage logs. It is used to classify log streams. If there are too many logs to collect, separate logs into different log groups based on log types, and name log groups in an easily identifiable way.
+LTS automatically generates a default log group name. You are advised to customize one based on your service. You can also change it after the log group is created. The naming rules are as follows:
+- Enter 1 to 64 characters, including only letters, digits, hyphens (-), underscores (_), and periods (.). Do not start with a period or underscore or end with a period.
- Each log group name must be unique.
|
Enterprise Project Name
|
-Select an enterprise project. You can click View Enterprise Projects to view all enterprise projects.
-Enterprise projects allow you to manage cloud resources and users by project.
+ | Enterprise projects allow you to manage cloud resources and users by project.
+By default, the default enterprise project is used. You are advised to select an enterprise project that fits your service needs. To see all available options, click View Enterprise Projects.
|
Log Retention (Days)
@@ -32,8 +34,16 @@
|
Tag
|
-Tag the log group as required. Click Add Tags, enter a tag key and value, and enable Apply to Log Stream.
-- To add more tags, repeat this step. A maximum of 20 tags can be added.
- To delete a tag, click Delete in the Operation column of the tag.
- A tag key can contain up to 128 characters, and a tag value can contain up to 255 characters.
- A tag key must be unique.
- If a tag is used by a transfer task, you need to modify the task configuration after deleting the tag.
+ | Tag the log group as required. Click Add Tags and enter a tag key and value. If you enable Apply to Log Stream, the tag will be applied to all log streams in the log group. To add more tags, repeat this step. A maximum of 20 tags can be added.
+Tag key restrictions:
+- A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.
- A tag key can contain up to 128 characters.
- Each tag key must be unique.
+Tag value restrictions:
+- A tag value can contain letters, digits, spaces, and the following special characters: _.:=+-@
- A tag value can contain up to 255 characters.
+Deleting a tag:
+Click Delete in the Operation column of the tag.
+ WARNING: Deleted tags cannot be recovered.
+ If a tag is used by a transfer task, you need to modify the task configuration after deleting the tag.
+
|
Remark
@@ -44,23 +54,25 @@
|
- Click OK. The created log group will be displayed in the log group list.
- In the log group list, you can view information such as the log group name, tags, and log streams.
- Click the log group name to access the log stream details page.
- When multiple log groups are created concurrently, there may be a limit exceeding error.
+ - Click OK. The created log group will be displayed in the log group list.
- In the log group list, view information such as the log group name, tags, and log streams.
- Click the log group name to access the log details page.
Modifying a Log GroupYou can modify log group settings, such as the group name, log retention duration, or tags as follows:
- - In the log group list on the Log Management page, locate the target log group and click Modify in the Operation column.
- On the page displayed, modify the group name, log retention period, and tags.
- Click OK.
- After the modification is successful, move the cursor over the log group name. The new and original log group names are displayed.
Figure 1 Log group name
+Modifying a Log GroupAfter a log group is created, you can modify its settings, such as the group name, log retention duration, or tags as follows:
+ - In the log group list on the Log Management page, locate the target log group and click Modify in the Operation column.
- On the page displayed, modify the group name, log retention period, and tags.
- Click OK.
- After the modification is successful, move the cursor over the log group name to view the new and original names along with the log group ID.
Figure 1 Log group name
Deleting a Log GroupYou can delete a log group that is no longer needed. Deleting a log group will also delete the log streams and log data in the log group. This may lead to exceptions in related tasks. In addition, deleted log groups cannot be restored. Exercise caution when performing this operation.
+ Deleting a Log GroupYou can delete a log group that is no longer needed. Deleting a log group will also delete the log streams and log data in the log group.
If you want to delete a log group that is associated with a log transfer task, delete the task first.
- - In the log group list on the Log Management page, locate the target log group and click Delete in the Operation column.
- Enter DELETE and click OK.
Figure 2 Deleting a log group
+ Deleting a log group may lead to exceptions in related log tasks. In addition, deleted log groups cannot be restored.
+
+- In the log group list on the Log Management page, locate the target log group and click Delete in the Operation column.
- Enter DELETE in the text box or click Auto Enter, and click OK.
Figure 2 Deleting a log group
- Searching Log Groups/StreamsIn the log group list, you can set the following filter criteria:
- - Log group/stream
- Original log group/stream name
- Log group name/ID
- Log stream name/ID
- Log group tag
- Remarks
- Figure 3 Searching log groups/streams
+ Searching Log Groups/StreamsYou can search for log groups using the following filter criteria:
+ - Log Group/Log Stream: log group or stream name.
- Original Log Group Name/Original Log Stream Name: original name of a log group or log stream before the name is changed, that is, the name defined during creation.
- Log Group Name/ID: log group name or ID (hover your cursor over the log group name to view the ID)
- Log Stream Name/ID: log stream name or ID (hover your cursor over the log stream name to view the ID)
- Log Group Tag: tags set for a log group
- Remark: remarks customized during log group creation.
+ Figure 3 Searching log groups/streams
- Other Operations- To check the details of a log group, including the log group name, ID, and creation time, go to the log group list and click Details in the Operation column of the desired log group.
- To download all displayed information about a log group to the local PC, click
 next to the search box.
+ Other Operations- Viewing log group details: In the log group list, click Details in the Operation column of the desired log group to view its name, ID, and creation time.
- To download all displayed information about a log group to the local PC, click
 next to the search box.
@@ -69,3 +81,10 @@
+
+
\ No newline at end of file
diff --git a/docs/lts/umn/lts_04_0004.html b/docs/lts/umn/lts_04_0004.html
index 74db361fd..b84d54727 100644
--- a/docs/lts/umn/lts_04_0004.html
+++ b/docs/lts/umn/lts_04_0004.html
@@ -1,69 +1,85 @@
Managing Log Streams
- LTS manages logs by log stream. Collected logs of different types are classified and stored in different log streams for easier log management. If there are a large number of logs, you can create multiple log streams and name them for quick log search. For example, you can sort operation logs and access logs into different log streams, making it easier to find specific logs when you need them. You can add tags to log streams to help O&M personnel manage services.
+ LTS manages logs by log stream. Each log stream belongs to exactly one log group, while a log group can contain multiple log streams.
+ Collected logs of different types are classified and stored in different log streams for easier log management. If there are a large number of logs, you can create multiple log streams and name them for quick log search. For example, you can sort operation logs and access logs into different log streams, making it easier to find specific logs when you need them. You can add tags to log streams to help O&M personnel manage services.
A maximum of 100 log streams can be created in a log group. If you cannot create a log stream, delete unnecessary log streams and try again, or create log streams in another log group.
PrerequisitesYou have created a log group.
Creating a Log Stream- Log in to the management console and choose Management & Deployment > Log Tank Service.
- On the Log Management page, click
 on the left of the target log group. - Click Create Log Stream. On the displayed page, set log stream parameters by referring to Table 1.
- Table 1 Log stream parametersParameter
+Table 1 Log stream parametersParameter
|
-Description
+ | Description
|
|---|
-Log Group Name
+ | Log Group Name
|
-The name of the target log group is displayed by default.
+ | Defaults to name of the log group to which the log stream belongs and be unmodifiable.
|
-Log Stream Name
+ | Log Stream Name
|
-Enter 1 to 64 characters, including only letters, digits, hyphens (-), underscores (_), and periods (.). Do not start with a period or underscore or end with a period.
+ | LTS automatically generates a default log stream name. You are advised to customize one based on your service. You can also change it after the log stream is created. The naming rules are as follows:
+- Use only letters, digits, hyphens (-), underscores (_), and periods (.). Do not start with a period or underscore or end with a period.
- Enter 1 to 64 characters.
- Each log stream name must be unique.
|
-Enterprise Project Name
+ | Enterprise Project Name
|
-Select the required enterprise project. The default value is default. You can click View Enterprise Projects to view all enterprise projects.
+ | Select the required enterprise project. The default value is default. You can click View Enterprise Projects to view all enterprise projects.
|
-Log Retention (Days)
+ | Log Storage
|
-Specify the log retention period for the log stream, that is, how many days the logs will be stored in LTS after being reported to LTS.
+ | If this function is disabled, Log Retention (Days) cannot be enabled.
+- If this function is enabled, logs will be stored in the search engine and all log functions are available.
- If this function is disabled, logs will not be stored to LTS. This saves on index traffic and storage costs, but disables log search, analysis, alarm, consumption, and processing. You will only be allowed to use metric generation and log transfer functions.
+ |
+
+Log Retention (Days)
+ |
+Specify the log retention period for the log stream, that is, how many days the logs will be stored in LTS after being reported to LTS.
By default, logs are retained for 30 days. You can set the retention period to one to 365 days.
- If you enable Log Retention (Days) for the log stream, logs are retained for the period set for the log stream.
- If you disable Log Retention (Days) for the log stream, logs are retained for the period set for the log group.
- The logs that exceed the retention period will be automatically deleted. You can transfer logs to OBS buckets for long-term storage.
|
-Tag
+ | Tag
|
-You can tag log streams as required. Click Add Tags and enter a tag key and tag value.
-
-- To add more tags, repeat this step. A maximum of 20 tags can be added.
- To delete a tag, click Delete in the Operation column of the tag.
- A tag key can contain up to 128 characters, and a tag value can contain up to 255 characters.
- A tag key must be unique.
- If a tag is used by a transfer task, you need to modify the task configuration after deleting the tag.
+ | Tag the log stream as required. Click Add Tags and enter a tag key and value. To add more tags, repeat this step. A maximum of 20 tags can be added.
+Tag key restrictions:
+- A tag key can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.
- A tag key can contain up to 128 characters.
- Each tag key must be unique.
+Tag value restrictions:
+- A tag value can contain letters, digits, spaces, and the following special characters: _.:=+-@
- A tag value can contain up to 255 characters.
+Deleting a tag:
+Click Delete in the Operation column of the tag.
+ WARNING: Deleted tags cannot be recovered.
+ If a tag is used by a transfer task, you need to modify the task configuration after deleting the tag.
+
|
-Remark
+ | Remark
|
-Enter remarks. The value contains up to 1,024 characters.
+ | Enter remarks. The value contains up to 1,024 characters.
|
Figure 1 Creating a log stream
-- Click OK. In the log stream list, you can view information such as the log stream name and operations.
+Figure 1 Creating a log stream
+- Click OK. The created log stream will be displayed under the log group.
Modifying a Log StreamBy default, a log stream inherits the log retention setting from the log group it belongs to.
- - In the log stream list, locate the target log stream and click Modify in the Operation column.
- On the page displayed, modify the stream name, log retention period, and tags.
- Click OK.
- After the modification is successful, move the cursor over the log stream name. The new and original log stream names are displayed.
Figure 2 Log stream name
+- In the log stream list, locate the target log stream and click Modify in the Operation column.
- On the page displayed, modify the stream name, log retention period, and tags.
- Click OK.
- After the modification is successful, move the cursor over the log stream name to view the new and original names along with the log stream ID.
Figure 2 Log stream name
Deleting a Log StreamYou can delete a log stream that is no longer needed. Deleting a log stream will also delete the log data in the log stream. This may lead to exceptions in related tasks. In addition, deleted log streams cannot be restored. Exercise caution when performing this operation.
- - Before deleting a log stream, check whether any log collection task is configured for it. If there is a log collection task, deleting the log stream may affect log reporting.
- If you want to delete a log stream that is associated with a log transfer task, delete the task first.
- - In the log stream list, locate the target log stream and click Delete in the Operation column.
- Enter DELETE and click OK.
Figure 3 Deleting a log stream
+Deleting a Log StreamYou can delete a log stream that is no longer needed. Deleting a log stream will also delete the log data in the log stream.
+ Before deleting a log stream, check if it is being used by other services, such as log ingestion configurations, log transfer tasks, or log alarm rules. Deleting it while in use may interrupt log reporting.
+ Deleting a log stream may lead to exceptions in related log tasks. In addition, deleted log streams cannot be restored.
+
+ - In the log stream list, locate the target log stream and click Delete in the Operation column.
- Enter DELETE in the text box or click Auto Enter, and click OK.
Figure 3 Deleting a log stream
Other Operations- Adding a log stream to favorites
Click More > Edit in the Operation column of a log stream. On the displayed dialog box, enable My Favorites and/or My Favorites(Local Cache). The stream is then displayed in the My Favorites/My Favorites(Local Cache) list.
- - Viewing details
Click More > Details in the Operation column of a log stream to view its details, including its name, ID, and creation time.
-
+ Other Operations- Searching for log streams using the following filter criteria:
- Log Stream Name/ID: log stream name or ID (hover your cursor over the log stream name to view the ID)
- Original Log Stream Name/ID: original log stream name (defined during log group or log stream creation) and ID (hover your cursor over the log stream name to view the ID)
- Tag: tags set for a log stream
- Remark: remarks customized during log stream creation.
+ - Adding a log stream to favorites: Click More > Edit in the Operation column of a log stream. On the displayed dialog box, enable My Favorites and/or My Favorites(Local Cache). The stream is then displayed in the My Favorites/My Favorites(Local Cache) list.
- Viewing log stream details: Click More > Details in the Operation column of a log stream to view its details, including its name, ID, and creation time.
@@ -72,3 +88,10 @@
- Installing ICAgent (Extra-Region Hosts)
-- Managing ICAgent
+ - Managing ICAgent in Host Scenarios
+
+- Managing ICAgent in Container Scenarios
diff --git a/docs/lts/umn/lts_04_0041.html b/docs/lts/umn/lts_04_0041.html
index 8d488311f..3dba8f619 100644
--- a/docs/lts/umn/lts_04_0041.html
+++ b/docs/lts/umn/lts_04_0041.html
@@ -1,23 +1,23 @@
Transferring Logs to OBS
-You can transfer logs to OBS and download log files from the OBS console. You can choose scheduled or one-time transfers.
-
+ You can transfer logs to OBS for storage and download them from OBS Console. Transfers can be scheduled or done as a one-time event.
+
Prerequisites- Logs have been ingested to LTS. For details, see Log Ingestion.
- You have created an OBS bucket.
- Creating a Scheduled Log Transfer Task- To use this function, you must have the OBS Administrator permissions apart from the LTS permissions.
- LTS transfers only logs generated after the transfer task is configured, not historical logs.
+ Configuring a Scheduled Log Transfer Task- To use this function, you must have the OBS Administrator permissions apart from the LTS permissions.
- LTS transfers only logs generated after the transfer task is configured, not historical logs.
- Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Log Transfer in the navigation pane.
- Click Configure Log Transfer in the upper right corner.
- On the displayed page, configure the log transfer parameters.
Table 1 Transfer parametersParameter
|
Description
|
-Example
+ | Example Value
|
|---|
-Log Source Account
+ | Source Account
|
-- Current: Logs of the current account will be transferred.
- Other: Logs of the delegator account will be transferred. Ensure that the delegator has created an agency for log transfer delegation. For details, see section "Creating an Agency".
+ | - Current: Logs of the current account will be transferred.
- Other: Logs of the delegator account will be transferred. Ensure that the delegator has created an agency for log transfer delegation. For details, see section "Creating an Agency".
|
Current
|
@@ -32,7 +32,7 @@
Agency Name
|
-This parameter is required when Log Source Account is set to Other. Enter the name of the agency created by the delegator.
+ | This parameter is required when Log Source Account is set to Other. Enter the name of the agency created by the delegator.
|
-
|
@@ -53,7 +53,7 @@
Transfer Destination
|
-Select a cloud service for log transfer.
+ | Select a cloud service to which logs are transferred.
|
OBS
|
@@ -76,7 +76,7 @@
Log Stream Name
|
-Select a log stream. Log streams that have been configured with OBS transfer settings cannot be configured again.
+ | Select a log stream. Log streams that have been configured with OBS transfer settings cannot be selected.
|
-
|
@@ -84,7 +84,7 @@
OBS Bucket
|
- Select an OBS bucket.
- If no OBS buckets are available, click View OBS Bucket to access the OBS console and create an OBS bucket.
- - Currently, LTS supports only Standard OBS buckets.
+- LTS supports OBS buckets of the Standard storage class.
|
-
|
@@ -102,9 +102,9 @@
Log Prefix
|
-The file name prefix of the log files transferred to an OBS bucket
+ | Add a file name prefix to the log files transferred to an OBS bucket.
The prefix must meet the following requirements:
-- Can contain 0 to 64 characters.
- Can contain only letters, digits, hyphens (-), underscores (_), and periods (.).
+- Can contain up to 64 characters.
- Can contain only letters, digits, hyphens (-), underscores (_), and periods (.).
Example: If you enter LTS-log, the log file name will be LTS-log_Log file name.
|
LTS-log
@@ -121,7 +121,7 @@
| JSON
|
-Log Transfer Interval
+ | Transfer Interval
|
The interval for automatically transferring logs to OBS buckets. The value can be 2, 5, or 30 minutes, or 1, 3, 6, or 12 hours.
|
@@ -138,7 +138,7 @@
Filter by Tag Fields
|
During transfer, logs will be filtered by tag fields collected by ICAgent.
- |
Enabled
@@ -146,24 +146,24 @@
|
Compressed Format
|
-Non-compression and gzip/zip compression are supported.
+ | Non-compression and gzip/zip/snappy compression are supported.
|
-gzip
+ | GZIP
|
- Click OK. When the log transfer status changes to Normal, the transfer task has been created.
- Click the OBS bucket name in the Transfer Destination column to switch to the OBS console and view the transferred log files.
Transferred logs can be downloaded from OBS to your local computer for viewing. Logs stored in OBS are in raw or JSON format.
-Figure 1 Transferring logs to OBS
+ - Click OK. When the log transfer status changes to Normal, the transfer task has been created.
- Click the OBS bucket name in the Transfer Destination column to switch to OBS Console and view the transferred log files.
Transferred logs can be downloaded from OBS to your local PC for viewing. Logs stored in OBS are in raw or JSON format.
+Figure 1 Transferring logs to OBS
- Creating a One-off Log Transfer Task- Click Configure Log Transfer in the upper right corner.
- On the displayed page, configure the log transfer parameters.
+ Configuring a One-off Log Transfer Task- Click Configure Log Transfer in the upper right corner.
- On the displayed page, configure the log transfer parameters.
Table 2 Transfer parametersParameter
|
Description
|
-Example
+ | Example Value
|
|---|
@@ -176,7 +176,7 @@
Transfer Destination
|
-Select a cloud service for log transfer.
+ | Select a cloud service to which logs are transferred.
|
OBS
|
@@ -191,7 +191,7 @@
Enterprise Project Name
|
Select an enterprise project.
-- This parameter is displayed only when the enterprise project function is enabled for the current account.
- If the enterprise project function is enabled for the current account:
- All enterprise projects under the current account are displayed in the drop-down list when Log Source Account is set to Current.
- default is displayed when Log Source Account is set to Other and the enterprise project function is not enabled for the delegator account.
- All enterprise projects under the delegator account are displayed when Log Source Account is set to Other and the enterprise project function is enabled for the delegator account.
+- This parameter is displayed only when the enterprise project function is enabled for the current account.
- If the enterprise project function is enabled for the current account:
- All enterprise projects under the current account are displayed in the drop-down list when Log Source Account is set to Current.
- default is displayed when Log Source Account is set to Other and the enterprise project function is not enabled for the delegator account.
- All enterprise projects under the delegator account are displayed when Log Source Account is set to Other and the enterprise project function is enabled for the delegator account.
|
-
@@ -199,7 +199,7 @@
|
Log Stream Name
|
-Select a log stream. Log streams that have been configured with OBS transfer settings cannot be configured again.
+ | Select a log stream. Log streams that have been configured with OBS transfer settings cannot be selected.
|
-
|
@@ -221,7 +221,7 @@
Total Log Events
|
-Total number of log events.
+ | Total number of logs in the selected transfer time range.
|
-
|
@@ -243,9 +243,12 @@
Bucket Directory
|
-Directory of the OBS bucket. Do not start or end with a slash (/).
+ | OBS bucket directory. The value cannot start or end with a slash (/). It can contain only letters, digits, hyphens (-), underscores (_), and periods (.).
+You can obtain the bucket directory as follows:
+- In the bucket list on OBS Console, click the desired bucket to go to the Objects page.
- On the Objects page, locate the OBS folder to store LTS logs and click More > Copy Path in the Operation column. (The example is for reference only.)
If you want to save logs to the test/yicixing folder, test/yicixing will be copied. The copied path is the bucket directory.
+
|
--
+ | test/yicixing
|
Transfer File Name
@@ -269,19 +272,25 @@
|
- Click OK. When the log transfer status changes to Normal, the transfer task has been created.
- Click the OBS bucket name in the Transfer Destination column to switch to the OBS console and view the transferred log files.
- Download the transferred logs from OBS for viewing.
+ - Click OK. When the log transfer status changes to Normal, the transfer task has been created.
After a log transfer task is created, the parameters cannot be modified. Ensure that the parameters are correctly set.
+ - Click the OBS bucket name in the Transfer Destination column to switch to OBS Console and view the transferred log files.
Transferred logs can be downloaded from OBS to your local PC for viewing.
+
Modifying a Log Transfer Task- Locate the row that contains the target transfer task and click Modify in the Operation column.
- Click OK.
+ Modifying a Log Transfer TaskScheduled transfer tasks can be modified, but one-time transfer tasks cannot.
+ - Locate the row that contains the target transfer task and click Modify in the Operation column.
- Click OK.
- Viewing Transfer Details- Locate the target log transfer task and click More > Details in the row of the desired task to view its details.
- On the displayed Transfer Details page, you can view the log transfer details.
+ Viewing Transfer Details- Locate the target log transfer task and click More > Details in the same row to view its details.
- On the displayed Transfer Details page, you can view the log transfer details.
Deleting a Log Transfer TaskIf logs do not need to be transferred, you can delete the transfer task.
- - After a transfer task is deleted, log transfer will be stopped. Exercise caution when performing the deletion.
- After a transfer task is deleted, the logs that have been transferred remain in OBS.
- When you create a transfer task, OBS will grant read and write permissions to LTS for the selected bucket. To delete a transfer task that uses an OBS bucket, perform the following operations:
- If only one transfer task uses this OBS bucket, delete the bucket access permission granted to specific users on the Permissions > Bucket ACL tab page on the OBS console when you delete the transfer task.
- If multiple transfer tasks use this OBS bucket, do not delete the bucket access permission. Otherwise, data transfer will fail.
+ Deleting a transfer task will stop log transfer, and the deleted task cannot be restored. Exercise caution when performing this operation.
+
+- After a transfer task is deleted, the logs that have been transferred remain in OBS.
- When you create a transfer task, OBS will grant read and write permissions to LTS for the selected bucket. To delete a transfer task that uses an OBS bucket, perform the following operations:
- If only one transfer task uses this OBS bucket, delete the bucket access permission granted to specific users on the Permissions > Bucket ACL tab page on the OBS console when you delete the transfer task.
- If multiple transfer tasks use this OBS bucket, do not delete the bucket access permission. Otherwise, data transfer will fail.
-- Locate the row of the target transfer task and choose Delete in the Operation column.
- Click OK.
+- Delete a single transfer task:
- Click Delete in the Operation column of the target task.
- In the displayed dialog box, click OK.
+
Viewing Transfer StatusThe status of a transfer task can be Normal, Abnormal, or Closed.
- - Normal: The log transfer task works properly.
- Abnormal: An error occurred in the log transfer task. The possible cause is that the access control on the OBS bucket is configured incorrectly. Access the OBS console to correct the settings.
- Closed: The log transfer task is stopped.
+ - Normal: The log transfer task works properly.
- Abnormal: An error occurred in the log transfer task. The possible cause is that access control on the OBS bucket is configured incorrectly. Access the OBS console to correct the settings.
- Closed: The log transfer task is stopped.
@@ -290,3 +299,10 @@
You can configure delimiters to split log content into words, so you can search for logs by these words. LTS has preconfigured the following delimiters:
, '";=()[]{}@&<>/:\\?\n\t\r
If the default delimiters cannot meet your needs, you can set custom delimiters.
- Precautions- Your custom delimiters are applicable only to the log events generated after the delimiters are configured.
- The delimiter configured on the Delimiters tab page takes effect for all log streams in the current region. For details about how to configure delimiters for a single log stream, see Setting Indexes.
+ Precautions- Your custom delimiters are applicable only to the log events generated after the delimiters are configured.
- Delimiters configured on the Delimiters tab page take effect for all log streams in the current region. To configure delimiters for a single log stream, configure them on the Index Settings tab page.
Procedure- Log in to the management console and choose Management & Deployment > Log Tank Service.
- Choose Configuration Center in the navigation pane and click the Delimiters tab.
- Configure delimiters.
You can configure delimiters in either of the following ways. If you use both ways, the delimiters configured in the two ways will all take effect. - Common Delimiters: Click Edit and enter custom delimiters in the text box.
- ASCII Delimiters: Click Edit > Add ASCII Delimiter, and enter ASCII values by referring to ASCII Table.
|
|---|
|
|---|
|
|---|
| |
|---|
|
