-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
LogCleanupCommand.java
304 lines (273 loc) · 16.3 KB
/
LogCleanupCommand.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
/*
* Copyright 2017 Red Hat, Inc. and/or its affiliates.
*
* 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
*
* http://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.
*/
package org.jbpm.executor.commands;
import java.text.SimpleDateFormat;
import java.time.Duration;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import javax.persistence.EntityManagerFactory;
import org.jbpm.executor.impl.jpa.ExecutorJPAAuditService;
import org.jbpm.process.core.timer.DateTimeUtils;
import org.jbpm.runtime.manager.impl.jpa.EntityManagerFactoryManager;
import org.kie.api.executor.Command;
import org.kie.api.executor.CommandContext;
import org.kie.api.executor.ExecutionResults;
import org.kie.api.executor.Reoccurring;
import org.kie.api.executor.STATUS;
import org.kie.api.runtime.process.ProcessInstance;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Log clean up command that aims at doing house keeping of audit/log tables used in jBPM:
* <ul>
* <li>process related audit logs (process instance, node instance, variables)</li>
* <li>task related audit logs (audit task, task events)</li>
* <li>executor related data (requests and errors)</li>
* </ul>
* Command by default is auto configured to run once a day from the time it was initially scheduled though it can be reconfigured
* in terms of frequency when it is executed and if it shall run multiple times at all.<br/>
* Following is a complete list of accepted parameters:
* <ul>
* <li>SkipProcessLog - indicates if clean up of process logs should be omitted (true|false)</li>
* <li>SkipTaskLog - indicates if clean up of task logs should be omitted (true|false)</li>
* <li>SkipExecutorLog - indicates if clean up of executor logs should be omitted (true|false)</li>
* <li>DateFormat - date format for further date related params - if not given yyyy-MM-dd is used (pattern of SimpleDateFormat class)</li>
* <li>EmfName - name of entity manager factory to be used for queries (valid persistence unit name)</li>
* <li>SingleRun - indicates if execution should be single run only (true|false)</li>
* <li>RepeatMode - defines how the next execution time is calculated
* <ul>
* <li>FIXED - Scheduled time + NextRun parameter value</li>
* <li>INTERVAL (or not present) - End of execution + NextRun parameter value (default)</li>
* </ul>
* </li>
* <li>NextRun - provides next execution time (valid time expression e.g. 1d, 5h, etc)</li>
* <li>OlderThan - indicates what logs should be deleted - older than given date</li>
* <li>OlderThanPeriod - indicated what logs should be deleted older than given time expression (valid time expression e.g. 1d, 5h, etc)</li>
* <li>ForProcess - indicates logs to be deleted only for given process definition</li>
* <li>ForDeployment - indicates logs to be deleted that are from given deployment id</li>
* <li>RecordsPerTransaction - indicates number of records to be included in each DB transaction (default is 0 which means do the delete in one single transaction)</li>
* </ul>
*/
public class LogCleanupCommand implements Command, Reoccurring {
private static final Logger logger = LoggerFactory.getLogger(LogCleanupCommand.class);
protected final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
public static final String RECORDS_PER_TRANSACTION = "RecordsPerTransaction";
private long nextScheduleTimeAdd;
private boolean mightBeMore;
@Override
public Date getScheduleTime() {
Date nextSchedule;
if (mightBeMore) {
// if there are pending records, reexecute immediately
nextSchedule = Date.from(Instant.now().plus(Duration.ofMillis(100)));
}
else {
if (nextScheduleTimeAdd <= 0) {
return null;
}
nextSchedule = Date.from(Instant.now().plus(nextScheduleTimeAdd, ChronoUnit.MILLIS));
}
logger.debug("Next schedule for job {} is set to {}", this.getClass().getSimpleName(), nextSchedule);
return nextSchedule;
}
protected int readInt(Map<String, Object> params, String propName, int defaultValue) {
Object value = params.get(propName);
if (value instanceof Number) {
return ((Number) value).intValue();
} else if (value != null){
try {
return Integer.parseInt(value.toString());
} catch (NumberFormatException ex) {
// will return default
}
}
return defaultValue;
}
@Override
public ExecutionResults execute(CommandContext ctx) throws Exception {
boolean skipProcessLog = ctx.getData().containsKey("SkipProcessLog") ? Boolean.parseBoolean((String) ctx.getData("SkipProcessLog")) : false;
boolean skipTaskLog = ctx.getData().containsKey("SkipTaskLog") ? Boolean.parseBoolean((String) ctx.getData("SkipTaskLog")) : false;
boolean skipExecutorLog = ctx.getData().containsKey("SkipExecutorLog") ? Boolean.parseBoolean((String) ctx.getData("SkipExecutorLog")) : false;
int recordsPerTransaction = readInt(ctx.getData(), RECORDS_PER_TRANSACTION, 0);
mightBeMore = false;
SimpleDateFormat formatToUse = dateFormat;
String dataFormat = (String) ctx.getData("DateFormat");
if (dataFormat != null) {
formatToUse = new SimpleDateFormat(dataFormat);
}
ExecutionResults executionResults = new ExecutionResults();
String emfName = (String) ctx.getData("EmfName");
if (emfName == null) {
emfName = "org.jbpm.domain";
}
nextScheduleTimeAdd = TimeUnit.DAYS.toMillis(1);
// get hold of persistence and create instance of audit service
EntityManagerFactory emf = EntityManagerFactoryManager.get().getOrCreate(emfName);
ExecutorJPAAuditService auditLogService = new ExecutorJPAAuditService(emf);
// collect parameters
String olderThan = (String) ctx.getData("OlderThan");
String olderThanPeriod = (String) ctx.getData("OlderThanPeriod");
String forProcess = (String) ctx.getData("ForProcess");
String forDeployment = (String) ctx.getData("ForDeployment");
String statusFilter = (String) ctx.getData("Status");
Integer[] status = null;
if (statusFilter != null) {
status = Arrays.stream(statusFilter.split(",")).map(e -> Integer.parseInt(e)).toArray(Integer[]::new);
}
if (olderThanPeriod != null) {
long olderThanDuration = DateTimeUtils.parseDateAsDuration(olderThanPeriod);
Date olderThanDate = new Date(System.currentTimeMillis() - olderThanDuration);
olderThan = formatToUse.format(olderThanDate);
}
if (!skipExecutorLog) {
// executor tables
int errorInfoLogsRemoved = auditLogService.errorInfoLogDeleteBuilder()
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(errorInfoLogsRemoved, recordsPerTransaction);
logger.info("ErrorInfoLogsRemoved {}", errorInfoLogsRemoved);
executionResults.setData("ErrorInfoLogsRemoved", errorInfoLogsRemoved);
int requestInfoLogsRemoved = auditLogService.requestInfoLogDeleteBuilder()
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.logBelongsToProcessInStatus(status)
.status(STATUS.CANCELLED, STATUS.DONE, STATUS.ERROR)
.build()
.execute();
this.mightBeMore|= mightBeMore(requestInfoLogsRemoved, recordsPerTransaction);
logger.info("RequestInfoLogsRemoved {}", requestInfoLogsRemoved);
executionResults.setData("RequestInfoLogsRemoved", requestInfoLogsRemoved);
int executionErrorInfoLogsRemoved = auditLogService.executionErrorInfoDeleteBuilder()
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(executionErrorInfoLogsRemoved, recordsPerTransaction);
logger.info("ExecutionErrorInfoLogsRemoved {}", executionErrorInfoLogsRemoved);
executionResults.setData("ExecutionErrorInfoLogsRemoved", executionErrorInfoLogsRemoved);
}
if (!skipTaskLog) {
// task tables
int taLogsRemoved = auditLogService.auditTaskDelete()
.processId(forProcess)
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.deploymentId(forDeployment)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(taLogsRemoved, recordsPerTransaction);
logger.info("TaskAuditLogRemoved {}", taLogsRemoved);
executionResults.setData("TaskAuditLogRemoved", taLogsRemoved);
int teLogsRemoved = auditLogService.taskEventInstanceLogDelete()
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(teLogsRemoved, recordsPerTransaction);
logger.info("TaskEventLogRemoved {}", teLogsRemoved);
executionResults.setData("TaskEventLogRemoved", teLogsRemoved);
int tvLogsRemoved = auditLogService.taskVariableInstanceLogDelete()
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(tvLogsRemoved, recordsPerTransaction);
logger.info("TaskVariableLogRemoved {}", tvLogsRemoved);
executionResults.setData("TaskVariableLogRemoved", tvLogsRemoved);
}
if (!skipProcessLog) {
// process tables
int niLogsRemoved = auditLogService.nodeInstanceLogDelete()
.processId(forProcess)
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.externalId(forDeployment)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(niLogsRemoved, recordsPerTransaction);
logger.info("NodeInstanceLogRemoved {}", niLogsRemoved);
executionResults.setData("NodeInstanceLogRemoved", niLogsRemoved);
int viLogsRemoved = auditLogService.variableInstanceLogDelete()
.processId(forProcess)
.dateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.externalId(forDeployment)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(viLogsRemoved, recordsPerTransaction);
logger.info("VariableInstanceLogRemoved {}", viLogsRemoved);
executionResults.setData("VariableInstanceLogRemoved", viLogsRemoved);
if (!mightBeMore) {
int piLogsRemoved = auditLogService.processInstanceLogDelete()
.processId(forProcess)
.status(ProcessInstance.STATE_COMPLETED, ProcessInstance.STATE_ABORTED)
.endDateRangeEnd(olderThan == null ? null : formatToUse.parse(olderThan))
.recordsPerTransaction(recordsPerTransaction)
.externalId(forDeployment)
.logBelongsToProcessInStatus(status)
.build()
.execute();
this.mightBeMore|= mightBeMore(piLogsRemoved, recordsPerTransaction);
logger.info("ProcessInstanceLogRemoved {}", piLogsRemoved);
executionResults.setData("ProcessInstanceLogRemoved", piLogsRemoved);
}
}
calculateNextRun(ctx);
executionResults.setData("BAMLogRemoved", 0L);
return executionResults;
}
private static boolean mightBeMore (int deleted, int recordPerTransaction) {
return recordPerTransaction > 0 && deleted >= recordPerTransaction;
}
private void calculateNextRun(CommandContext ctx) {
String singleRun = (String) ctx.getData("SingleRun");
if ("true".equalsIgnoreCase(singleRun)) {
// disable rescheduling
nextScheduleTimeAdd = -1;
return;
}
String nextRun = (String) ctx.getData("NextRun");
if (nextRun != null) {
// if calculated next execution time is negative, schedule next run for immediate execution
nextScheduleTimeAdd = Math.max(DateTimeUtils.parseDateAsDuration(nextRun) - calculateExecutionTimeInMillis(ctx), 100);
}
}
private long calculateExecutionTimeInMillis(CommandContext ctx) {
long executionTimeInMillis = 0;
String repeatMode = (String) ctx.getData("RepeatMode");
if( "fixed".equalsIgnoreCase(repeatMode) ) {
// return diff between scheduled time and actual time
Date scheduledExecutionTime = (Date) ctx.getData("scheduledExecutionTime");
executionTimeInMillis = Instant.now().minus(scheduledExecutionTime.toInstant().toEpochMilli(), ChronoUnit.MILLIS).toEpochMilli();
logger.debug("Calculated execution time {}ms, based on scheduled execution time {}", executionTimeInMillis, scheduledExecutionTime);
}
// no calculation required for interval (or empty) mode
return executionTimeInMillis;
}
}