1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.appender.routing;
18
19 import java.util.Map.Entry;
20 import java.util.concurrent.ConcurrentHashMap;
21 import java.util.concurrent.ConcurrentMap;
22 import java.util.concurrent.ScheduledFuture;
23 import java.util.concurrent.TimeUnit;
24
25 import org.apache.logging.log4j.core.AbstractLifeCycle;
26 import org.apache.logging.log4j.core.Core;
27 import org.apache.logging.log4j.core.LogEvent;
28 import org.apache.logging.log4j.core.config.Configuration;
29 import org.apache.logging.log4j.core.config.ConfigurationScheduler;
30 import org.apache.logging.log4j.core.config.Scheduled;
31 import org.apache.logging.log4j.core.config.plugins.Plugin;
32 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
33 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
34 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
35
36
37
38
39 @Plugin(name = "IdlePurgePolicy", category = Core.CATEGORY_NAME, printObject = true)
40 @Scheduled
41 public class IdlePurgePolicy extends AbstractLifeCycle implements PurgePolicy, Runnable {
42
43 private final long timeToLive;
44 private final long checkInterval;
45 private final ConcurrentMap<String, Long> appendersUsage = new ConcurrentHashMap<>();
46 private RoutingAppender routingAppender;
47 private final ConfigurationScheduler scheduler;
48 private volatile ScheduledFuture<?> future;
49
50 public IdlePurgePolicy(final long timeToLive, final long checkInterval, final ConfigurationScheduler scheduler) {
51 this.timeToLive = timeToLive;
52 this.checkInterval = checkInterval;
53 this.scheduler = scheduler;
54 }
55
56 @Override
57 public void initialize(@SuppressWarnings("hiding") final RoutingAppender routingAppender) {
58 this.routingAppender = routingAppender;
59 }
60
61 @Override
62 public boolean stop(final long timeout, final TimeUnit timeUnit) {
63 setStopping();
64 final boolean stopped = stop(future);
65 setStopped();
66 return stopped;
67 }
68
69
70
71
72 @Override
73 public void purge() {
74 final long createTime = System.currentTimeMillis() - timeToLive;
75 for (final Entry<String, Long> entry : appendersUsage.entrySet()) {
76 if (entry.getValue() < createTime) {
77 LOGGER.debug("Removing appender " + entry.getKey());
78 if (appendersUsage.remove(entry.getKey(), entry.getValue())) {
79 routingAppender.deleteAppender(entry.getKey());
80 }
81 }
82 }
83 }
84
85 @Override
86 public void update(final String key, final LogEvent event) {
87 final long now = System.currentTimeMillis();
88 appendersUsage.put(key, now);
89 if (future == null) {
90 synchronized (this) {
91 if (future == null) {
92 scheduleNext();
93 }
94 }
95 }
96
97 }
98
99 @Override
100 public void run() {
101 purge();
102 scheduleNext();
103 }
104
105 private void scheduleNext() {
106 long updateTime = Long.MAX_VALUE;
107 for (final Entry<String, Long> entry : appendersUsage.entrySet()) {
108 if (entry.getValue() < updateTime) {
109 updateTime = entry.getValue();
110 }
111 }
112
113 if (updateTime < Long.MAX_VALUE) {
114 final long interval = timeToLive - (System.currentTimeMillis() - updateTime);
115 future = scheduler.schedule(this, interval, TimeUnit.MILLISECONDS);
116 } else {
117
118 future = scheduler.schedule(this, checkInterval, TimeUnit.MILLISECONDS);
119 }
120 }
121
122
123
124
125
126
127
128
129
130 @PluginFactory
131 public static PurgePolicy createPurgePolicy(
132 @PluginAttribute("timeToLive") final String timeToLive,
133 @PluginAttribute("checkInterval") final String checkInterval,
134 @PluginAttribute("timeUnit") final String timeUnit,
135 @PluginConfiguration final Configuration configuration) {
136
137 if (timeToLive == null) {
138 LOGGER.error("A timeToLive value is required");
139 return null;
140 }
141 TimeUnit units;
142 if (timeUnit == null) {
143 units = TimeUnit.MINUTES;
144 } else {
145 try {
146 units = TimeUnit.valueOf(timeUnit.toUpperCase());
147 } catch (final Exception ex) {
148 LOGGER.error("Invalid timeUnit value {}. timeUnit set to MINUTES", timeUnit, ex);
149 units = TimeUnit.MINUTES;
150 }
151 }
152
153 long ttl = units.toMillis(Long.parseLong(timeToLive));
154 if (ttl < 0) {
155 LOGGER.error("timeToLive must be positive. timeToLive set to 0");
156 ttl = 0;
157 }
158
159 long ci;
160 if (checkInterval == null) {
161 ci = ttl;
162 } else {
163 ci = units.toMillis(Long.parseLong(checkInterval));
164 if (ci < 0) {
165 LOGGER.error("checkInterval must be positive. checkInterval set equal to timeToLive = {}", ttl);
166 ci = ttl;
167 }
168 }
169
170 return new IdlePurgePolicy(ttl, ci, configuration.getScheduler());
171 }
172
173 @Override
174 public String toString() {
175 return "timeToLive=" + timeToLive;
176 }
177
178 }