Log4j基本使用方法

最新推荐文章于 2024-05-21 09:44:22 发布
最新推荐文章于 2024-05-21 09:44:22 发布
阅读量415 收藏
点赞数
分类专栏： Core Java 文章标签： log4j object layout date javadoc c

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、 WARN、INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日 志信息的显示内容。

3.1.定义配置文件

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：

  1. 配置根Logger，其语法为：

    log4j.rootLogger = [ level ] , appenderName, appenderName, …

    其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
    appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
  2. 配置日志信息输出目的地Appender，其语法为 
    log4j.appender.appenderName = fully.qualified.name.of.appender.class
    log4j.appender.appenderName.option1 = value1
    …
    log4j.appender.appenderName.option = valueN
    其中，Log4j提供的appender有以下几种：
    org.apache.log4j.ConsoleAppender（控制台），
    org.apache.log4j.FileAppender（文件），
    org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
    org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
  3. 配置日志信息的格式（布局），其语法为： 
    log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
    log4j.appender.appenderName.layout.option1 = value1
    …
    log4j.appender.appenderName.layout.option = valueN
    其中，Log4j提供的layout有以下几种：
    org.apache.log4j.HTMLLayout（以HTML表格形式布局），
    org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
    org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
    org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

3.2.在代码中使用Log4j

下面将讲述在程序代码中怎样使用Log4j。

3.2.1.得到记录器

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：

public static Logger getLogger( String name)，

通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ;

3.2.2.读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：
BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

3.2.3.插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：

Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;



Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
　　%m 输出代码中指定的消息
　　%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
　　%r 输出自应用启动到输出该log信息耗费的毫秒数
　　%c 输出所属的类目，通常就是所在类的全名
　　%t 输出产生该日志事件的线程名
　　%n 输出一个回车换行符，Windows平台为“/r/n”，Unix平台为“/n”
　　%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似： 2002年10月18日 22：10：28，921
　　%l 输出日志事件的发生位置，包括类目名,发生的线程，以及在代码中的行数。Testlog4.main(TestLog4.java:10)


log4j.rootLogger=INFO, A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n



### set log levels ###
log4j.rootLogger = debug ,  stdout ,  D ,  E

### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n

### 输出到日志文件 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 保存异常信息到单独文件 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/error.log ## 异常日志文件名
log4j.appender.D.Append = true
log4j.appender.D.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n 




日志类别补充
有时我们需要对某个特定的部分指定有别于根类别的日志类别，可以指定某个包的优先级
如：
log4j.category.com.neusoft.mbip.dm.util=ERROR ，其中com.neusoft.mbip.dm.util为我们需要特别指定日志类别的部分。

或者可以指定输出文件的优先级
log4j.appender.Errorlog.Threshold=ERROR


log4j.properties
### 设置org.ss域对应的级别INFO,DEBUG,WARN,ERROR和输出地A1，A2 ##
log4j.category.org.ss=ERROR,A1 
log4j.category.org.ss=INFO,A2 
log4j.appender.A1=org.apache.log4j.ConsoleAppender 
### 设置输出地A1，为ConsoleAppender(控制台) ##
log4j.appender.A1.layout=org.apache.log4j.PatternLayout 
### 设置A1的输出布局格式PatterLayout,(可以灵活地指定布局模式）##
log4j.appender.A1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n 
### 配置日志输出的格式##
log4j.appender.A2=org.apache.log4j.RollingFileAppender 
### 设置输出地A2到文件（文件大小到达指定尺寸的时候产生一个新的文件）##
log4j.appender.A2.File=/usr/study/log4j/s.html 
### 文件位置##
log4j.appender.A2.MaxFileSize=500KB 
### 文件大小##
log4j.appender.A2.MaxBackupIndex=1 
log4j.appender.A2.layout=org.apache.log4j.HTMLLayout 
##指定采用html方式输出


log4j配置举例（properties）
#log4j.rootLogger = [ level ] , appenderName, appenderName, 
#类别level 为 OFF、FATAL、ERROR、WARN、INFO、DEBUG、log、ALL或自定义的优先级
#Log4j常用的优先级FATAL>ERROR>WARN>INFO>DEBUG
#stdout为控制台 ，Errorlog为错误记录日志 ，
log4j.rootCategory=INFO,stdout,Runlog,Errorlog

#输出的appender的格式为
#log4j.appender.appenderName = fully.qualified.name.of.appender.class 
#log4j.appender.appenderName.option1 = value1 
#log4j.appender.appenderName.option = valueN 
#Log4j中appender支持的输出
#org.apache.log4j.ConsoleAppender 控制台
#org.apache.log4j.FileAppender 文件
#org.apache.log4j.DailyRollingFileAppender 每天产生一个日志文件
#org.apache.log4j.RollingFileAppender （文件大小到达指定尺寸的时候产生一个新的文件），
#org.apache.log4j.WriterAppender （将日志信息以流格式发送到任意指定的地方） 
#org.apache.log4j.net.SMTPAppender 邮件
#org.apache.log4j.jdbc.JDBCAppender 数据库
＃定义输出的形式
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.Runlog=org.apache.log4j.DailyRollingFileAppender
log4j.appender.Errorlog=org.apache.log4j.DailyRollingFileAppender

#可以指定输出文件的优先级
log4j.appender.Errorlog.Threshold=ERROR
#指定输出的文件
log4j.appender.Runlog.File=/usr/UserInfoSyn/WebRoot/WEB-INF/runlogrunlog.log 
log4j.appender.Errorlog.File=/usr/UserInfoSyn/WebRoot/WEB-INF/errorlogerrorlog.log 

#Log4j的layout布局
#org.apache.log4j.HTMLLayout 以HTML表格形式布局
#org.apache.log4j.PatternLayout 可以灵活地指定布局模式
#org.apache.log4j.SimpleLayout 包含日志信息的级别和信息字符串
#org.apache.log4j.TTCCLayout 包含日志产生的时间、线程、类别等等信息
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.Runlog.layout=org.apache.log4j.PatternLayout
log4j.appender.Errorlog.layout=org.apache.log4j.PatternLayout
#输出格式,log4j javadoc org.apache.log4j.PatternLayout 
#-X号:X信息输出时左对齐；
#%p:日志信息级别
# %d{}:日志信息产生时间
# %c:日志信息所在地（类名）
# %m:产生的日志具体信息
# %n:%n:输出日志信息换行
log4j.appender.stdout.layout.ConversionPattern= %5p %d{yyyy-MM-dd HH:mm:ss} %c %m %n
log4j.appender.Runlog.layout.ConversionPattern= %5p %d{yyyy-MM-dd HH:mm:ss} %c %m %n
log4j.appender.Errorlog.layout.ConversionPattern= %5p %d{yyyy-MM-dd HH:mm:ss} %c %m %n
#指定某个包的优先级 
log4j.category.org.s.util=ERROR

#示例
###################
# Console Appender
###################
#log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
#log4j.appender.Threshold=DEBUG
#log4j.appender.CONSOLE.Target=System.out
#log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
#log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n

#####################
# File Appender
#####################
#log4j.appender.FILE=org.apache.log4j.FileAppender
#log4j.appender.FILE.File=file.log
#log4j.appender.FILE.Append=false
#log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
#log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
# Use this layout for LogFactor 5 analysis
########################
# Rolling File RollingFileAppender
########################
#log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender
#log4j.appender.ROLLING_FILE.Threshold=ERROR
# 文件位置
#log4j.appender.ROLLING_FILE.File=rolling.log
#log4j.appender.ROLLING_FILE.Append=true
#文件大小
#log4j.appender.ROLLING_FILE.MaxFileSize=10KB
#指定采用输出布局和输出格式
#log4j.appender.ROLLING_FILE.MaxBackupIndex=1
#log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout
#log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
####################
# Socket Appender
####################
#log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender
#log4j.appender.SOCKET.RemoteHost=localhost
#log4j.appender.SOCKET.Port=5001
#log4j.appender.SOCKET.LocationInfo=true
# Set up for Log Facter 5
#log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout
#log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n
########################
# SMTP Appender
#######################
#log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
#log4j.appender.MAIL.Threshold=FATAL
#log4j.appender.MAIL.BufferSize=10
#log4j.appender.MAIL.From=se@s.com
#log4j.appender.MAIL.SMTPHost=mail.s.com
#log4j.appender.MAIL.Subject=Log4J Message
#log4j.appender.MAIL.To=se@s.com
#log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout
#log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
########################
# JDBC Appender
#######################
#log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender
#log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test
#log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver
#log4j.appender.DATABASE.user=root
#log4j.appender.DATABASE.password=p
#log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')
#log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout
#log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
########################
# Log Factor 5 Appender
########################
#log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
#log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
###################
#自定义Appender
###################
#log4j.appender.im = org.s.util.logger.appender.IMAppender
#log4j.appender.im.host = mail.s.net
#log4j.appender.im.username = username
#log4j.appender.im.password = password
#log4j.appender.im.recipient = s@s.org
#log4j.appender.im.layout=org.apache.log4j.PatternLayout
#log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

diymaster
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
log4j漏洞扫描工具带详细教程和用法
01-27
python环境下执行，可批量扫描url，可扫描本地，可绕过waf测试，fuzzing测试
新鲜出炉的，针对Log4j核弹级漏洞的扫描工具
一个爱上护士的猿
12-16 4219
背景 近日，网络上出现 Apache Log4j2 远程代码执行漏洞。攻击者可利用该漏洞构造特殊的数据请求包，最终触发远程代码执行。由于该漏洞影响范围极广，建议广大用户及时排查相关漏洞，经过白帽汇安全研究院分析确认，目前市面有多款流行的系统都受影响。 log4j作为众多软件广泛引入的类库，漏洞影响范围太大了，据说各大厂程序员半夜被叫起来加班加点修复。 漏洞描述 Apache Log4j2 是一个基于 Java 的日志记录工具。该工具重写了 Log4j 框架，并且引入了大量丰富的特性。该日志框架被大量用于业务
推荐开源项目：Log4j 扫描工具 - FullHunt Log4j-Scan
gitblog_00053的博客
04-25 429
推荐开源项目：Log4j 扫描工具 - FullHunt Log4j-Scan 项目地址:https://gitcode.com/fullhunt/log4j-scan FullHunt Log4j-Scan 是一个强大的自动化扫描工具，专为检测和缓解 Apache Log4j 的漏洞（CVE-2021-44228）而设计。此项目利用先进的静态代码分析技术和网络爬虫技术，帮助开发人员、安全团队和 ...
log4j漏洞扫描工具
01-20
适用于windows 运行命令：.\log4jscanner.exe ./ 参数为扫描Jar文件所在目录 扫描到漏洞的Jar文件会打印在控制台
全自动查找log4j RCE漏洞的工具
m0_58596609的博客
12-17 2670
全自动查找log4j RCE漏洞的工具
log4j日志的基本使用
09-27
通过截图详细记载了log4j的基本使用，log4j三个重要组件：loggers 日志记录器 Appenders 输出端 Layout日志格式化器
log4j-2.18.0
08-04
1. 确认当前使用的log4j2版本，如果是在受影响范围内，立即停止使用并准备升级。 2. 下载并部署log4j-2.18.0的更新版本，替换原有的库文件。 3. 配置更新后的log4j2，禁用可能导致问题的JNDI查找功能，增强系统安全...
Java日志软件Log4j的基本使用教程
09-03
【Java日志软件Log4j的基本使用教程】 在Java开发中，日志记录扮演着至关重要的角色，用于追踪代码执行过程、记录系统状态变化以及辅助调试。Log4j，作为一个强大的开源日志管理工具，提供了丰富的功能来满足这些...
log4j基本使用方法.doc
03-09
总结来说，Log4j的基本使用包括以下步骤： 1. 引入Log4j的jar包到项目中。 2. 创建Logger实例并调用相应的方法记录日志。 3. 编写`log4j.properties`配置文件，设定日志级别、输出目的地和格式。 4. 根据需要调整...
推荐开源项目：log4jScanner——及时发现并应对log4j漏洞的利器
最新发布
gitblog_00005的博客
05-21 405
推荐开源项目：log4jScanner——及时发现并应对log4j漏洞的利器 项目地址:https://gitcode.com/proferosec/log4jScanner 1、项目介绍 在网络安全领域，快速响应和排查潜在的安全风险至关重要。log4jScanner正是这样一款工具，专为检测内部网络中的log4j漏洞而设计。它通过扫描指定子网内的Web服务，利用JNDI payload尝试探测...
推荐开源项目：Log4j Scanner
gitblog_00036的博客
05-14 324
推荐开源项目：Log4j Scanner 项目地址:https://gitcode.com/cisagov/log4j-scanner 在网络安全的世界里，及时发现和修复漏洞至关重要。这就是为什么我们今天要向您推荐一个名为Log4j Scanner的开源项目。这个工具旨在帮助开发者和安全团队检测Apache Log4j框架中的远程代码执行漏洞（CVE-2021-44228 和 CVE-2021-...
如何使用Log4j？
master_yao的博客
07-04 479
如何使用Log4j？
Log4j2 漏洞检测工具清单
01-17 1万+
距离Log4j2漏洞公开已经过去一个月了，它所造成的严重影响已经不需要我们重复提及了。随着时间的推移，新的漏洞会不断出现，旧的漏洞会不断消失，而这个Log4j2中的RCE漏洞可能需要好几年...
Log4j 漏洞修复检测 附检测工具
cnsre运维博客
12-13 1万+
作者：SRE运维博客 博客地址：https://www.cnsre.cn/ 文章地址：https://www.cnsre.cn/posts/211213210004/ 相关话题：https://www.cnsre.cn/tags/Log4j/ 近日的Log4j2，可是非常的火啊，我也是加班加点把补丁给打上了次安心。Apache Log4j2存在远程代码执行漏洞，经验证，该漏洞允许攻击者在目标服务器上执行任意代码，可导致服务器被黑客控制。由于Apache Log4j 2应用较为广泛，建议使用该组件的用..
log4j配置文件中的additivity属性
热门推荐
junshao90的专栏
12-21 7万+
最新写程序，需要采用log4j来收集日志，这样就需要把程序运行日志和收集的日志区分开来。 开始一直没有找到可以配置log4j让其独立输出到指定日志文件，于是采用了划分Log4j的等级来解决这个问题； 具体实施方案是将父Logger的输出等级设置的高一点，而用来收集日志的Logger的输出等级设置低一点，采用trace方法来打日志； 后来找到了log4j的additiv
使用log4j2实现日志数据脱敏
dongping8887的专栏
05-08 1万+
我们在JAVA项目中，通常会使用日志组件打印日志。但是，在日志中不能打印出用户的敏感信息。比如账户号码、群组号码、密码、IP地址等。而在当前的日志中，存在了大量这样的信息，用于定位问题。我们使用的是log4j2组件（log4j 2.7）。如果需要去除这些有敏感信息的打印项，存在几个问题：一、浪费人力，需要逐一去排查；二、去除时，去不干净或者在后续的工作中，又无意识的添加打印了一些敏感信息，不好根除
Log4j入门与配置详解
通过以上介绍，你已经对log4j有了基本的了解。在实际开发中，你可以根据项目的需要，配置更复杂的appender组合，如将日志同时输出到文件和网络，或者使用自定义的日志布局模式，以达到最佳的日志管理效果。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值