Tencent Cloud Collector

[ 1 Overview ] [ 2 Devo collector features ] [ 3 Data sources ] [ 4 Flattening preprocessing ] [ 5 Vendor setup ] [ 6 Minimum configuration required for basic pulling ] [ 7 Accepted authentication methods ] [ 8 Run the collector ] [ 9 Collector services detail ] [ 10 Collector operations ] [ 11 Change log for v1.x.x ]

Refer to the Vendor setup section to know more about these configurations.

Overview

-

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server`
Populated Devo events	`table`
Flattening preprocessing	`no`

Data sources

Data source	Description	Collector service name	Devo table	Available from release

Data source	Description	Collector service name	Devo table	Available from release
logs_search	Returns all the tencent logs.	logs_search	cls.tencent.log.event	v1.0.0

Flattening preprocessing

Data source	Collector service	Optional	Flattening details

Data source	Collector service	Optional	Flattening details
logs_search	logs_search	yes	not required

Vendor setup

-

Minimum configuration required for basic pulling

Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.

This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting	Details

Setting	Details
secret_id	The secret id for authentication.
secret_key	The secret key for authentication.

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

Authentication method	secret_id	secret_key

Authentication method	secret_id	secret_key
API Key authentication	REQUIRED	REQUIRED

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

logs_search service

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component	Description

Component	Description
Setup	The setup module is in charge of authenticating the service and managing the token expiration when needed.
Puller	The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

2024-12-20T13:59:29.019    INFO OutputProcess::MainThread -> ConsoleSenderManagerMonitor(internal_senders,console_1) -> Starting thread (every 300 seconds)
2024-12-20T13:59:29.020    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_2) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-20T13:59:29.020    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_2) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-12-20T13:59:29.020    INFO OutputProcess::MainThread -> ConsoleSenderManager(internal_senders,manager,console_1) -> Starting thread
2024-12-20T13:59:29.021    INFO OutputProcess::ConsoleSenderManager(internal_senders,manager,console_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-20T13:59:29.022    INFO OutputProcess::ConsoleSenderManager(lookup_senders,manager,console_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-20T13:59:29.022    INFO OutputProcess::ConsoleSenderManager(lookup_senders,manager,console_1) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-12-20T13:59:29.022    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Recovering any available content from the persistence system
2024-12-20T13:59:29.022    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-20T13:59:29.022    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Elapsed seconds: 0.01
2024-12-20T13:59:29.023    INFO OutputProcess::MainThread -> OutputMetricsThread -> Started thread for updating metrics values (update_period=10.0)
2024-12-20T13:59:29.025    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-20T13:59:29.930    INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> [EMERGENCY_PERSISTENCE_SYSTEM] Nothing available in the persistence system
2024-12-20T13:59:31.017    INFO InputProcess::TencentCloudPullerSetup(tencent_cloud#84754,logs_search#predefined) -> Setup for module <TencentCloudPuller> has been successfully executed

Puller output

A successful initial run has the following output messages for the puller module:

2024-12-16T04:21:51.994    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> Pull Started
2024-12-16T04:21:51.995    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> Pulling data from 2024-12-06 17:30:00
2024-12-16T04:21:54.432    INFO InputProcess::Thread-11 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-0] consumer worker "396a2d51fdab9cea06bcec6dea82653e-consumer-0" start
2024-12-16T04:21:54.432    INFO InputProcess::Thread-12 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-0] heart beat start
2024-12-16T04:21:56.497    INFO InputProcess::Thread-12 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-0] partition reorganize, adding: ['55425710-150f-45c3-8b05-00c0c2b14115[0]'], removing: ['55425710-150f-45c3-8b05-00c0c2b14115[]']
2024-12-16T04:21:56.788    INFO InputProcess::Thread-13 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] consumer worker "396a2d51fdab9cea06bcec6dea82653e-consumer-1" start
2024-12-16T04:21:56.789    INFO InputProcess::Thread-14 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] heart beat start
2024-12-16T04:21:58.807    INFO InputProcess::Thread-14 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] partition reorganize, adding: [], removing: ['55425710-150f-45c3-8b05-00c0c2b14115[]']
2024-12-16T04:22:00.706    INFO InputProcess::Thread-14 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] partition reorganize, adding: [], removing: ['55425710-150f-45c3-8b05-00c0c2b14115[]']
2024-12-16T04:22:03.493    INFO InputProcess::Thread-14 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] partition reorganize, adding: [], removing: ['55425710-150f-45c3-8b05-00c0c2b14115[]']
2024-12-16T04:22:06.692    INFO InputProcess::Thread-14 -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] partition reorganize, adding: [], removing: ['55425710-150f-45c3-8b05-00c0c2b14115[]']
2024-12-16T04:22:06.800    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-0] try to stop heart beat
2024-12-16T04:22:06.800    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-0] get stop signal, start to stop consumer worker "396a2d51fdab9cea06bcec6dea82653e-consumer-0"
2024-12-16T04:22:06.801    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] try to stop heart beat
2024-12-16T04:22:06.801    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> [c21b76cb-c6fc-4235-930e-3b2ec599e93c/['55425710-150f-45c3-8b05-00c0c2b14115']/396a2d51fdab9cea06bcec6dea82653e/396a2d51fdab9cea06bcec6dea82653e-consumer-1] get stop signal, start to stop consumer worker "396a2d51fdab9cea06bcec6dea82653e-consumer-1"
2024-12-16T04:22:06.955    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> Updating the persistence
2024-12-16T04:22:07.073    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734322911982):Number of requests made: 1; Number of events received: 2016; Number of duplicated events filtered out: 0; Number of events generated and sent: 2016; Average of events per second: 133.699.

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

2024-12-16T04:37:32.272    INFO InputProcess::TencentCloudPuller(tencent_cloud#15884,logs_search#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1734322911982):Number of requests made: 85; Number of events received: 149586; Number of duplicated events filtered out: 0; Number of events generated and sent: 149586; Average of events per second: 159.087.

This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:

Edit the configuration file.
Change the value of the initial_start_time_in_utc_value parameter to a different one.
Save the changes.
Restart the collector.

The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Error Type	Error Id	Error Message	Cause	Solution

Error Type	Error Id	Error Message	Cause	Solution
InitVariablesError	1	initial_start_time_in_utc is not set as per the datetime_format : {datetime_format}	The date in config is not as per required format	Ensure the date format is correct.

InitVariablesError	2	Date {initial_start_time_str} is in the future	The date in config is greater than current time	Ensure the datetime is less than current time
PullError	300	Some error :{e} occurred while fetching tencent logs	Tencent API call is failing	Check the credentials and ensure that the collector has the necessary permissions to access the Lark API.
PullError	301	Some error :{e} occurred while fetching tencent logs	Tencent API call is failing	Contact the developer with exact error message.

Collector operations

This section is intended to explain how to proceed with specific operations of this collector.

Initialization

The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.

A successful run has the following output messages for the initializer module:

Events delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.

A successful run has the following output messages for the initializer module:

Sender services

The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (internal, standard, and lookup). This collector uses the following Sender Services:

Sender services	Description

Sender services	Description
`internal_senders`	In charge of delivering internal metrics to Devo such as logging traces or metrics.
`standard_senders`	In charge of delivering pulled events to Devo.

Sender statistics

Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:

Logging trace	Description

Logging trace

Description

Number of available senders: 1

Displays the number of concurrent senders available for the given Sender Service.

sender manager internal queue size: 0

Displays the items available in the internal sender queue.

Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 seconds)

Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:

44 events were sent to Devo since the collector started.
The last checkpoint timestamp was 2022-06-28 10:39:22.511671+00:00.
21 events where sent to Devo between the last UTC checkpoint and now.
Those 21 events required 0.007 seconds to be delivered.

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.
The global pressure of the available memory is displayed in the global value.
All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory

Change log for v1.x.x

Release	Released on	Release type	Details	Recommendations

Release	Released on	Release type	Details	Recommendations
`v1.0.0`	Dec 20, 2024	NEW FEATURE	New collector	Latest version to be used