Transferring Logs to DMS
You can use DMS APIs to retrieve logs in real time.
Currently, this function is available only to whitelisted users. To use it, submit a service ticket.
Prerequisites
- Logs have been ingested to LTS.
- You have purchased a DMS instance.
- Before registering a DMS Kafka instance, configure an inbound rule to allow access from 198.19.128.0/17 over port 9011. If DMS's subnet is associated with a network ACL, you need to configure an inbound rule for the network ACL. For this rule, set the protocol to TCP, the source IP address to 198.19.128.0/17, the port number range to 1 to 65535, and the destination port to 9011, and allow the destination IP address.
Transferring Logs to DMS
- Log in to the LTS console and choose Log Transfer in the navigation pane on the left.
- Click Configure Log Transfer in the upper right corner.
- On the displayed page, configure the log transfer parameters.
Table 1 Transfer parameters Parameter
Description
Example
Log 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 Creating an Agency.
Current
Agency Name
This parameter is required when Log Source Account is set to Other. Enter the name of the IAM agency created by the delegator.
-
Delegator Account Name
This parameter is required when Log Source Account is set to Other. Enter the account name of the delegator.
-
Enable Transfer
Enabled by default.
Enabled
Transfer Destination
Select a cloud service for log transfer.
DMS
Log Group Name
Select a log group.
N/A
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.
-
Log Stream Name
Select a log stream.
NOTE:Log streams that have been configured with DMS transfer settings cannot be configured again.
-
Kafka Instance
Select a Kafka instance. If no instances are available, click View Kafka Instances to access the DMS console and create a Kafka instance.
If a Kafka instance has been registered, you can modify it. For details about how to register a Kafka instance, see Registering a Kafka Instance.
NOTE:When creating a Kafka instance, set the instance access mode as follows: Enable ciphertext access for private network access, set the kafka security protocol to SASL_SSL, set the username and password, and enable SASL/PLAIN. For details, see Buying a Kafka Instance.
-
Topic
Select a topic for the Kafka instance. If no topics are available, access the DMS console and create a topic for the Kafka premium instance.
topic-01
Format
The storage format of logs. The value can be Raw Log Format or JSON.
- Example of the raw log format:
- Example of the JSON format:
{"host_name":"ecs-bd70","ip":"192.168.0.54","line_no":249,"message":"Sep 30 14:40:01 ecs-bd70 CRON[4363]: (root) CMD (/opt/oss/servicemgr/ICAgent/bin/manual/mstart.sh > /dev/null 2>&1)\n","path":"/var/log/syslog","time":1569825602303}
Raw Log Format
Log Transfer Interval
Logs are transferred to the Kafka instance in real time.
Real time
Log Stream Fields
This parameter is available when Format is set to JSON.
It is used to enable the function of transferring log fields.
All: transfers all fields in a log. Specified: transfers only manually configured ones.
-
Built-in Fields and Custom Tags
This parameter is available when Format is set to JSON.
It is used to enable the function of transferring built-in fields and custom tags.
All: transfers all built-in and specified fields in a log. Specified: transfers only manually configured ones.
-
Stream Tag Fields
This parameter is available when Format is set to JSON.
It is used to enable the function of transferring stream tag fields. You can select All or Specified as required.
All: transfers all stream tag fields in a log. Specified: transfers only manually configured ones. For details about how to set tags, see Managing Log Streams.
-
More Settings
This parameter is available when Format is set to JSON.
If no value in the log corresponds to the configured key, an invalid field is used.
-
- Click OK. When the log transfer status changes to Normal, the transfer task has been created. If you transfer logs of another account, the log group and stream belong to the delegator. When you click the name of the delegator's log group or stream on the Log Transfer page, you will be directed to the log group or stream through the agency.
- Click the Kafka premium instance in the Transfer Destination column to access its basic information page.
After a transfer task is created, you can view, modify, and delete it.
- 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 DMS.
Registering a Kafka Instance
- If you select a Kafka instance that is not registered, access the page for registering the Kafka instance.
- Configure the parameters for registering a Kafka instance.
Table 2 Parameters Parameter
Description
Example
Kafka Instance
DMS instance name.
Kafka-01
Create DMS Network
Connect the Kafka instance to LTS so that LTS can send data through this network.
-
Username
If SASL authentication is enabled for the Kafka instance, enter the username for SASL authentication.
DMS
Password
If SASL authentication is enabled for the Kafka instance, enter the password for SASL authentication.
-
- Click OK.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
