2 Star 0 Fork 0

mirrors_vy/log4j2-redis-appender

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Actions Status Maven Central License

RedisAppender plugin provides a Log4j 2.x appender for Redis in-memory data structure store. The plugin uses Jedis as a client for Redis.

Usage

Add the log4j2-redis-appender dependency to your POM file

<dependency>
    <groupId>com.vlkan.log4j2</groupId>
    <artifactId>log4j2-redis-appender</artifactId>
    <version>${log4j2-redis-appender.version}</version>
</dependency>

together with a valid log4j-core dependency:

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>${log4j2.version}</version>
</dependency>

Below you can find a sample log4j2.xml snippet employing RedisAppender.

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <Appenders>
        <RedisAppender name="REDIS"
                       key="log4j2-messages"
                       host="localhost"
                       port="6379">
            <PatternLayout pattern="%level %msg"/>
            <RedisConnectionPoolConfig testWhileIdle="true"
                                       minEvictableIdleTimeMillis="60000"
                                       timeBetweenEvictionRunsMillis="30000"
                                       numTestsPerEvictionRun="-1"/>
            <RedisThrottlerConfig bufferSize="500"
                                  batchSize="100"
                                  flushPeriodMillis="1000"
                                  maxEventCountPerSecond="100"
                                  maxByteCountPerSecond="4194304"
                                  maxErrorCountPerSecond="0.003"/>
        </RedisAppender>
    </Appenders>
    <Loggers>
        <Root level="all">
            <AppenderRef ref="REDIS"/>
        </Root>
    </Loggers>
</Configuration>

One can make RedisAppender work against a sentinel setup using sentinelNodes and sentinelMaster parameters:

<RedisAppender name="REDIS"
               key="log4j2-messages"
               sentinelNodes="localhost:63791,localhost:63792"
               sentinelMaster="mymaster">
...
</RedisAppender>

Note that sentinelNodes and sentinelMaster have priority over host and port parameters.

RedisAppender is configured with the following parameters:

Parameter Name Type Default Description
charset String UTF-8 output charset
database int 0 Redis logical database
key String Redis queue key
host String localhost Redis host
port int 6379 Redis port
sentinelNodes String null Redis sentinel nodes as comma-separated list, e.g., host1:port1,host2:port2. If specified, host and port parameters are ignored.
sentinelMaster String null Redis sentinel master name
username String default Redis username
password String null Redis password
command String rpush Redis command for writing to the queue. Accepts rpush (default) and publish.
connectionTimeoutSeconds int 2 initial connection timeout in seconds
socketTimeoutSeconds int 2 socket timeout in seconds
ignoreExceptions boolean true Enabling causes exceptions encountered while appending events to be internally logged and then ignored. When set to false, exceptions will be propagated to the caller, instead. You must set this to false when wrapping this appender in a FailoverAppender.
Layout Layout PatternLayout used to format the LogEvents
RedisConnectionPoolConfig RedisConnectionPoolConfig Redis connection pool configuration
RedisThrottlerConfig RedisThrottlerConfig Redis throttler configuration

Redis Connection Pool

RedisConnectionPoolConfig is a wrapper for JedisPoolConfig which extends GenericObjectPoolConfig of Apache Commons Pool. Below is a complete list of available RedisConnectionPoolConfig attributes.

Parameter Name Type Default
maxTotal int 8
maxIdle int 8
minIdle int 0
lifo boolean true
fairness boolean false
maxWaitMillis long -1
minEvictableIdleTimeMillis long 1000 * 60
softMinEvictableIdleTimeMillis long -1
numTestsPerEvictionRun int -1
testOnCreate boolean false
testOnBorrow boolean false
testOnReturn boolean false
testWhileIdle boolean true
timeBetweenEvictionRunsMillis long 1000 * 30
evictionPolicyClassName String org.apache.commons.pool2.impl.DefaultEvictionPolicy
blockWhenExhausted boolean true
jmxEnabled boolean true
jmxNameBase String null
jmxNamePrefix String com.vlkan.log4j2.redis.appender.JedisConnectionPool

Redis Throttler

While Log4j 2 provides utilities like BurstFilter and AsyncAppender that you can wrap around any appender to facilitate throttling, the appender API falls short of communicating this intent. Hence, RedisAppender provides its own throttling mechanics to exploit batch pushes available in Redis RPUSH. This feature is configured by RedisThrottlerConfig element using the following attributes:

Parameter Name Type Description
bufferSize int LogEvent buffer size (defaults to 500)
batchSize int size of batches fed into Redis RPUSH (defaults to 100)
flushPeriodMillis long buffer flush period (defaults to 1000)
maxEventCountPerSecond double allowed maximum number of events per second (defaults to 0, that is, unlimited)
maxByteCountPerSecond double allowed maximum number of bytes per second (defaults to 0, that is, unlimited)
maxErrorCountPerSecond double allowed maximum number of errors per second propagated (defaults to 0.003, that is, approximately once every 5 minutes)
jmxBeanName String RedisThrottlerJmxBean name (defaults to org.apache.logging.log4j2:type=<loggerContextName>,component=Appenders,name=<appenderName>,subtype=RedisThrottler)

The buffer is flushed if either there are more than batchSize events queued in the buffer, or the last flush was older than flushPeriodMillis.

maxErrorCountPerSecond is there to avoid flooding logs if the application is suffering a shortage of memory, or the Redis server is unreachable.

Fat JAR

Project also contains a log4j2-redis-appender-fatjar artifact which includes all its transitive dependencies in a separate shaded package (to avoid the JAR Hell) with the exception of log4j-core, that you need to include separately.

This might come handy if you want to use this plugin along with already compiled applications, e.g., Elasticsearch 5.x, which requires Log4j 2.x.

F.A.Q.

  • How can I connect to multiple Redis servers for failover? You can define multiple Redis appenders nested under a FailoverAppender. (Don't forget to turn off ignoreExceptions flag.)

  • How can I avoid getting AccessControlException exceptions? If you are using the plugin in a security manager enabled Java application (for instance, which is the case for Elasticsearch since version 2.3), you might be getting AccessControlException exceptions as follows:

    [2017-06-23T11:25:35,644][WARN ][o.e.b.ElasticsearchUncaughtExceptionHandler] [tst-store-001.data] uncaught exception in thread [commons-pool-EvictionTimer]
    java.security.AccessControlException: access denied ("java.lang.RuntimePermission" "setContextClassLoader")
            at java.security.AccessControlContext.checkPermission(AccessControlContext.java:472) ~[?:1.8.0_131]
            at java.security.AccessController.checkPermission(AccessController.java:884) ~[?:1.8.0_131]
            at java.lang.SecurityManager.checkPermission(SecurityManager.java:549) ~[?:1.8.0_131]
            at java.lang.Thread.setContextClassLoader(Thread.java:1474) [?:1.8.0_131]
            at org.apache.commons.pool2.impl.BaseGenericObjectPool$Evictor.run(BaseGenericObjectPool.java:1052) ~[log4j2-redis-appender.jar:?]
            at java.util.TimerThread.mainLoop(Timer.java:555) ~[?:1.8.0_131]
            at java.util.TimerThread.run(Timer.java:505) ~[?:1.8.0_131]
    

    To alleviate this, you need to grant necessary permissions using a policy file:

    grant {
        permission java.lang.RuntimePermission "setContextClassLoader";
    };
    

    Then you can activate this policy for your application via either placing it under one of default policy file locations (e.g., $JAVA_HOME/lib/security/java.policy) or providing it as an argument at runtime, that is, -Djava.security.policy=someURL.

  • How can I access JMX bean of an appender? Once you have a reference to the relevant LoggerContext, you can access the instance of the appender and its JMX bean by its name as follows:

    Appender appender = loggerContext.getConfiguration().getAppender("REDIS");
    RedisThrottlerJmxBean jmxBean = ((RedisAppender) appender).getJmxBean();
    

    You can either create your own LoggerContext:

    LoggerContextResource loggerContextResource = new LoggerContextResource("/path/to/log4j2.xml");
    LoggerContext loggerContext = loggerContextResource.getLoggerContext();
    

    or get a handle to an existing one:

     LoggerContext logContext = (LoggerContext) LogManager.getContext(false);
    

    Here note that you should be using org.apache.logging.log4j.core.LoggerContext, not org.apache.logging.log4j.spi.LoggerContext.

Contributors

Security policy

If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to the volkan@yazi.ci email address.

License

Copyright © 2017-2024 Volkan Yazıcı

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Apache License Version 2.0, January 2004 https://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
README
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

语言

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/mirrors_vy/log4j2-redis-appender.git
git@gitee.com:mirrors_vy/log4j2-redis-appender.git
mirrors_vy
log4j2-redis-appender
log4j2-redis-appender
master

搜索帮助