- 动态与公告
- 新手指引
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 最佳实践
- 开发者指南
- API 文档
- History
- Introduction
- API Category
- Making API Requests
- Topic Management APIs
- Log Set Management APIs
- Index APIs
- Topic Partition APIs
- Machine Group APIs
- Collection Configuration APIs
- Log APIs
- Metric APIs
- Alarm Policy APIs
- Data Processing APIs
- Kafka Protocol Consumption APIs
- CKafka Shipping Task APIs
- Kafka Data Subscription APIs
- COS Shipping Task APIs
- SCF Delivery Task APIs
- Scheduled SQL Analysis APIs
- COS Data Import Task APIs
- Data Types
- Error Codes
- 常见问题
- 服务等级协议
- CLS 政策
- 联系我们
- 词汇表
- 动态与公告
- 新手指引
- 产品简介
- 购买指南
- 快速入门
- 操作指南
- 最佳实践
- 开发者指南
- API 文档
- History
- Introduction
- API Category
- Making API Requests
- Topic Management APIs
- Log Set Management APIs
- Index APIs
- Topic Partition APIs
- Machine Group APIs
- Collection Configuration APIs
- Log APIs
- Metric APIs
- Alarm Policy APIs
- Data Processing APIs
- Kafka Protocol Consumption APIs
- CKafka Shipping Task APIs
- Kafka Data Subscription APIs
- COS Shipping Task APIs
- SCF Delivery Task APIs
- Scheduled SQL Analysis APIs
- COS Data Import Task APIs
- Data Types
- Error Codes
- 常见问题
- 服务等级协议
- CLS 政策
- 联系我们
- 词汇表
简介
日志服务（Cloud Log Service，CLS）目前已支持使用 Log4j Appender 上传日志到 CLS。
背景信息
Log4j 是 Apache 的一个开源项目。通过使用 Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI 组件，甚至是套接口服务器、NT 的事件记录器、UNIX Syslog 守护进程等；我们可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们可以更加细致地控制日志的生成过程。此外，我们还可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。
Log4j 由三个重要的组件构成：
日志信息的优先级
日志信息的优先级从高到低分别为 ERROR、WARN、INFO和DEBUG，分别用来指定这条日志信息的重要程度。
日志信息的输出目的地
日志信息的输出目的地指定了日志将打印到控制台还是文件中。
日志信息的输出格式
输出格式控制了日志信息的显示内容。
功能优势
日志不落盘：产生数据通过网络发给服务端。
无需改造：对已使用 Log4J 应用，只需简单配置即可采集。
异步非阻塞：高并发设计，后台异步发送，适合高并发写入。
资源可控制：可以通过参数控制 producer 用于缓存待发送数据的内存大小，同时还可以配置用于执行数据发送任务的线程数量。
自动重试：对可重试的异常，支持配置重试次数。
优雅关闭：退出前会将日志全量进行发送。
感知日志上报结果：通过 org.apache.log4j.helpers.LogLog 记录运行过程中产生的异常，在默认情况下 LogLog 会将信息输出到控制台。
使用 Tencent CLS Log4j Appender
通过 Tencent CLS Log4j Appender，您可以控制日志的输出目的地为腾讯云日志服务。 写到日志服务中的日志的样式如下：
字段 | 简介 |
__SOURCE__ | 来源 IP |
__FILENAME__ | 文件名称 |
level | 日志级别 |
location | 日志打印语句的代码位置 |
message | 日志内容 |
throwable | 日志异常信息（只有记录了异常信息，这个字段才会出现） |
thread | 线程名称 |
time | 日志打印时间（可以通过 timeFormat 或 timeZone 配置 time 字段呈现的格式和时区） |
log | 自定义日志格式 |
工程引入和配置
maven 工程中引入依赖
<dependency><groupId>com.tencentcloudapi.cls</groupId><artifactId>tencentcloud-cls-log4j-appender</artifactId><version>1.0.2</version></dependency>
修改 Log4J 配置文件
#loghubAppenderlog4j.appender.loghubAppender=com.tencentcloudapi.cls.LoghubAppender#日志服务的 http 地址，必选参数log4j.appender.loghubAppender.endpoint=ap-guangzhou.cls.tencentcs.com#用户身份标识，必选参数log4j.appender.loghubAppender.accessKeyId=log4j.appender.loghubAppender.accessKeySecret=#设置log字段的格式，必选参数log4j.appender.loghubAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.loghubAppender.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n#指定日志主题，必选参数log4j.appender.loghubAppender.topicID =#指定日志来源，可选参数log4j.appender.loghubAppender.source =#单个 producer 实例能缓存的日志大小上限，默认为 100MB。log4j.appender.loghubAppender.totalSizeInBytes=104857600#如果 producer 可用空间不足，调用者在 send 方法上的最大阻塞时间，默认为 60 秒。为了不阻塞打印日志的线程，强烈建议将该值设置成 0。log4j.appender.loghubAppender.maxBlockMs=0#执行日志发送任务的线程池大小，默认为可用处理器个数。log4j.appender.loghubAppender.sendThreadCount=8#当一个 ProducerBatch 中缓存的日志大小大于等于 batchSizeThresholdInBytes 时，该 batch 将被发送，默认为 512 KB，最大可设置成 5MB。log4j.appender.loghubAppender.batchSizeThresholdInBytes=524288#当一个 ProducerBatch 中缓存的日志条数大于等于 batchCountThreshold 时，该 batch 将被发送，默认为 4096，最大可设置成 40960。log4j.appender.loghubAppender.batchCountThreshold=4096#一个 ProducerBatch 从创建到可发送的逗留时间，默认为 2 秒，最小可设置成 100 毫秒。log4j.appender.loghubAppender.lingerMs=2000#如果某个 ProducerBatch 首次发送失败，能够对其重试的次数，默认为 10 次。#如果 retries 小于等于 0，该 ProducerBatch 首次发送失败后将直接进入失败队列。log4j.appender.loghubAppender.retries=10#该参数越大能让您追溯更多的信息，但同时也会消耗更多的内存。log4j.appender.loghubAppender.maxReservedAttempts=11#首次重试的退避时间，默认为 100 毫秒。#Producer 采用指数退避算法，第 N 次重试的计划等待时间为 baseRetryBackoffMs * 2^(N-1)。log4j.appender.loghubAppender.baseRetryBackoffMs=100#重试的最大退避时间，默认为 50 秒。log4j.appender.loghubAppender.maxRetryBackoffMs=50000#设置时间格式，可选参数log4j.appender.loghubAppender.timeFormat=yyyy-MM-dd'T'HH:mm:ssZ#设置时区为东八区，可选参数log4j.appender.loghubAppender.timeZone=Asia/Shanghai#输出 DEBUG 级别及以上的消息log4j.appender.loghubAppender.Threshold=DEBUG
Log4j Appender SDK
Log4j 1.x版本：请使用 tencentcloud-cls-log4j-appender。
Log4j 2.x版本：请使用 tencentcloud-cls-log4j2-appender。
是
否
本页内容是否解决了您的问题？