Repository: incubator-rocketmq-site Updated Branches: refs/heads/asf-site 162796040 -> c1717b629
[ROCKETMQ-194]Add logappender example closes apache/incubator-rocketmq-site#18 Project: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/commit/b23e4998 Tree: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/tree/b23e4998 Diff: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/diff/b23e4998 Branch: refs/heads/asf-site Commit: b23e4998a4bf53aab68148533527dd127415fe9f Parents: 8be3859 Author: lindzh <[email protected]> Authored: Tue Jun 13 17:06:32 2017 +0800 Committer: dongeforever <[email protected]> Committed: Tue Jun 13 17:06:32 2017 +0800 ---------------------------------------------------------------------- _data/navigation.yml | 2 + _docs/20-logappender-example.md | 80 ++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/b23e4998/_data/navigation.yml ---------------------------------------------------------------------- diff --git a/_data/navigation.yml b/_data/navigation.yml index cc6c8cd..7385b8c 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -35,6 +35,8 @@ docs: url: /docs/batch-example/ - title: "Filter Example" url: /docs/filter-by-sql92-example/ + - title: "Logappender Example" + url: /docs/logappender-example/ - title: "FAQ" url: /docs/faq/ http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/b23e4998/_docs/20-logappender-example.md ---------------------------------------------------------------------- diff --git a/_docs/20-logappender-example.md b/_docs/20-logappender-example.md new file mode 100644 index 0000000..fb1956d --- /dev/null +++ b/_docs/20-logappender-example.md @@ -0,0 +1,80 @@ +--- +title: "Logappender Example" +permalink: /docs/logappender-example/ +excerpt: "How to use logappender in RocketMQ." +modified: 2017-06-08T21:01:43-04:00 +--- + +{% include toc %} + +RocketMQ logappender provides log4j appender, log4j2 appender and logback appender for bussiness to use, below are config examples. + +#### log4j + +When using log4j properties config file,config as below. + +``` +log4j.appender.mq=org.apache.rocketmq.logappender.log4j.RocketmqLog4jAppender +log4j.appender.mq.Tag=yourTag +log4j.appender.mq.Topic=yourLogTopic +log4j.appender.mq.ProducerGroup=yourLogGroup +log4j.appender.mq.NameServerAddress=yourRocketmqNameserverAddress +log4j.appender.mq.layout=org.apache.log4j.PatternLayout +log4j.appender.mq.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-4r [%t] (%F:%L) %-5p - %m%n +``` + +When using log4j xml config file,config it as this and also add a async appender: + +``` +<appender name="mqAppender1" class="org.apache.rocketmq.logappender.log4j.RocketmqLog4jAppender"> + <param name="Tag" value="yourTag" /> + <param name="Topic" value="yourLogTopic" /> + <param name="ProducerGroup" value="yourLogGroup" /> + <param name="NameServerAddress" value="yourRocketmqNameserverAddress"/> + <layout class="org.apache.log4j.PatternLayout"> + <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss}-%p %t %c - %m%n" /> + </layout> +</appender> + +<appender name="mqAsyncAppender1" class="org.apache.log4j.AsyncAppender"> + <param name="BufferSize" value="1024" /> + <param name="Blocking" value="false" /> + <appender-ref ref="mqAppender1"/> +</appender> +``` + +#### log4j2 +When using log4j2,config as this.If you want noneblock,just config an asyncAppender for ref. + +``` +<RocketMQ name="rocketmqAppender" producerGroup="yourLogGroup" nameServerAddress="yourRocketmqNameserverAddress" + topic="yourLogTopic" tag="yourTag"> + <PatternLayout pattern="%d [%p] hahahah %c %m%n"/> +</RocketMQ> + +``` + +#### logback +When using logback,an asyncAppender also needed. + +``` +<appender name="mqAppender1" class="org.apache.rocketmq.logappender.logback.RocketmqLogbackAppender"> + <tag>yourTag</tag> + <topic>yourLogTopic</topic> + <producerGroup>yourLogGroup</producerGroup> + <nameServerAddress>yourRocketmqNameserverAddress</nameServerAddress> + <layout> + <pattern>%date %p %t - %m%n</pattern> + </layout> +</appender> + +<appender name="mqAsyncAppender1" class="ch.qos.logback.classic.AsyncAppender"> + <queueSize>1024</queueSize> + <discardingThreshold>80</discardingThreshold> + <maxFlushTime>2000</maxFlushTime> + <neverBlock>true</neverBlock> + <appender-ref ref="mqAppender1"/> +</appender> + +``` +
