CLS allows you to upload logs to CLS by using Log4j Appender.
Background
Log4j Appender is an open source project of Apache. It allows you to deliver logs to various destinations, including consoles, files, GUI components, and even socket servers, NT event loggers, and UNIX Syslog daemons. You can control the output format of each log. By defining the level of each log, you can further control the log generation process. In addition, you can have the flexibility to configure the logging behavior by editing a configuration file without modifying the application code.
Log4j Appender consists of the following components:
Log information priority
From high to low, log message priorities are ERROR, WARN, INFO, and DEBUG, which specify the importance of log messages.
Log information output destination
The output destination of a log specifies whether the log will be printed to the console or to a file.
Log information output format
The output format determines how log information is displayed.
Advantages
Logs are not stored on disks: generated log data is delivered to servers via the network.
No reconstruction is required: for applications that are using Log4j Appender, you only need to perform simple configuration to enable log collection.
Logs are delivered in async non-blocking mode: the high concurrency and backend async delivery design make Logback ideal for high write concurrency.
Resources are controllable: you can use parameters to control the size of the memory used by the producer to cache data to be sent and the number of threads used to execute data sending tasks.
Automatic retries: you can configure the number of retries for exceptions that allow retries.
Graceful shutdown: Log4j Appender will deliver logs in full mode before exiting.
Log reporting result response: exceptions that occur during running are recorded via org.apache.log4j.helpers.LogLog and, by default, will be output to the console.
Using Tencent CLS Log4j Appender
With Tencent CLS Log4j Appender, you can specify that logs are output to Tencent Cloud CLS in the format as shown in the figure below.
Field
Description
__SOURCE__
Source IP
__FILENAME__
File name
level
Log level
location
Code location of the log print statement
message
Log content
throwable
Log exception information (This field exists only when exception information is logged.)
thread
Thread name
time
Log print time (You can print the format and time zone via timeFormat and timeZone respectively.)
# Maximum time for blocking a caller from using the `send` method if the Producer has insufficient free space. The default value is 60 seconds. It is strongly recommended that this value be set to 0 in order not to block the log print thread.
log4j.appender.loghubAppender.maxBlockMs=0
# Size of the thread pool for executing log sending tasks. The default value is the number of available processors.
log4j.appender.loghubAppender.sendThreadCount=8
# When the size of logs cached in ProducerBatch is greater than or equal to `batchSizeThresholdInBytes`, the batch will be sent. The default value is 512 KB, and the maximum value can be set to 5 MB.
# When the number of logs cached in ProducerBatch is greater than or equal to `batchCountThreshold`, the batch will be sent. The default value is 4096, and the maximum value allowed is 40960.
Yes
No
Was this page helpful?