1 /*******************************************************************************
2 * ============LICENSE_START==================================================
4 * * ===========================================================================
5 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 * * ===========================================================================
7 * * Licensed under the Apache License, Version 2.0 (the "License");
8 * * you may not use this file except in compliance with the License.
9 * * You may obtain a copy of the License at
11 * * http://www.apache.org/licenses/LICENSE-2.0
13 * * Unless required by applicable law or agreed to in writing, software
14 * * distributed under the License is distributed on an "AS IS" BASIS,
15 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * * See the License for the specific language governing permissions and
17 * * limitations under the License.
18 * * ============LICENSE_END====================================================
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 ******************************************************************************/
25 package org.onap.dmaap.datarouter.provisioning.utils;
27 import com.att.eelf.configuration.EELFLogger;
28 import com.att.eelf.configuration.EELFManager;
30 import java.io.FileInputStream;
31 import java.io.FileReader;
32 import java.io.IOException;
33 import java.io.InputStreamReader;
34 import java.io.LineNumberReader;
35 import java.io.Reader;
36 import java.nio.file.Files;
37 import java.sql.Connection;
38 import java.sql.PreparedStatement;
39 import java.sql.ResultSet;
40 import java.sql.SQLException;
41 import java.sql.Statement;
42 import java.text.ParseException;
43 import java.util.Date;
44 import java.util.HashMap;
45 import java.util.Iterator;
47 import java.util.TreeSet;
48 import java.util.zip.GZIPInputStream;
49 import org.onap.dmaap.datarouter.provisioning.BaseServlet;
50 import org.onap.dmaap.datarouter.provisioning.beans.DeliveryExtraRecord;
51 import org.onap.dmaap.datarouter.provisioning.beans.DeliveryRecord;
52 import org.onap.dmaap.datarouter.provisioning.beans.ExpiryRecord;
53 import org.onap.dmaap.datarouter.provisioning.beans.Loadable;
54 import org.onap.dmaap.datarouter.provisioning.beans.LogRecord;
55 import org.onap.dmaap.datarouter.provisioning.beans.Parameters;
56 import org.onap.dmaap.datarouter.provisioning.beans.PubFailRecord;
57 import org.onap.dmaap.datarouter.provisioning.beans.PublishRecord;
60 * This class provides methods that run in a separate thread, in order to process logfiles uploaded into the spooldir.
61 * These logfiles are loaded into the MariaDB LOG_RECORDS table. In a running provisioning server, there should only be
62 * two places where records can be loaded into this table; here, and in the method DB.retroFit4() which may be run at
63 * startup to load the old (1.0) style log tables into LOG_RECORDS;
64 * <p>This method maintains an {@link RLEBitSet} which can be used to easily see what records are presently in the
66 * This bit set is used to synchronize between provisioning servers.</p>
69 * @version $Id: LogfileLoader.java,v 1.22 2014/03/12 19:45:41 eby Exp $
71 public class LogfileLoader extends Thread {
73 * NOT USED: Percentage of free space required before old records are removed.
75 public static final int REQUIRED_FREE_PCT = 20;
78 * This is a singleton -- there is only one LogfileLoader object in the server.
80 private static LogfileLoader logfileLoader;
83 * The PreparedStatement which is loaded by a <i>Loadable</i>.
85 private static final String INSERT_SQL = "insert into LOG_RECORDS "
86 + "values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
88 * Each server can assign this many IDs.
90 private static final long SET_SIZE = (1L << 56);
92 private final EELFLogger logger;
94 private final String spooldir;
95 private final long setStart;
96 private final long setEnd;
97 private RLEBitSet seqSet;
101 private LogfileLoader() {
102 this.logger = EELFManager.getInstance().getLogger("InternalLog");
104 this.spooldir = db.getProperties().getProperty("org.onap.dmaap.datarouter.provserver.spooldir");
105 this.setStart = getIdRange();
106 this.setEnd = setStart + SET_SIZE - 1;
107 this.seqSet = new RLEBitSet();
110 this.setDaemon(true);
111 this.setName("LogfileLoader");
115 * Get the singleton LogfileLoader object, and start it if it is not running.
117 * @return the LogfileLoader
119 public static synchronized LogfileLoader getLoader() {
120 if (logfileLoader == null) {
121 logfileLoader = new LogfileLoader();
123 if (!logfileLoader.isAlive()) {
124 logfileLoader.start();
126 return logfileLoader;
129 private long getIdRange() {
131 if (BaseServlet.isInitialActivePOD()) {
133 } else if (BaseServlet.isInitialStandbyPOD()) {
138 String range = String.format("[%X .. %X]", size, size + SET_SIZE - 1);
139 logger.debug("This server shall assign RECORD_IDs in the range " + range);
144 * Return the bit set representing the record ID's that are loaded in this database.
146 * @return the bit set
148 public RLEBitSet getBitSet() {
153 * True if the LogfileLoader is currently waiting for work.
155 * @return true if idle
157 public boolean isIdle() {
162 * Run continuously to look for new logfiles in the spool directory and import them into the DB.
163 * The spool is checked once per second. If free space on the MariaDB filesystem falls below
164 * REQUIRED_FREE_PCT (normally 20%) then the oldest logfile entries are removed and the LOG_RECORDS
165 * table is compacted until free space rises above the threshold.
172 File dirfile = new File(spooldir);
174 runLogFileLoad(dirfile);
176 } catch (Exception e) {
177 logger.warn("PROV0020: Caught exception in LogfileLoader: " + e);
182 private void runLogFileLoad(File filesDir) {
183 File[] inFiles = filesDir.listFiles((dir, name) -> name.startsWith("IN."));
184 if (inFiles != null) {
185 if (inFiles.length == 0) {
189 } catch (InterruptedException e) {
190 Thread.currentThread().interrupt();
195 if (pruneRecords()) {
196 // Removed at least some entries, recompute the bit map
199 for (File file : inFiles) {
206 private void processFile(File infile) {
207 if (logger.isDebugEnabled()) {
208 logger.debug("PROV8001 Starting " + infile + " ...");
210 long time = System.currentTimeMillis();
211 int[] array = process(infile);
212 time = System.currentTimeMillis() - time;
213 logger.info(String.format("PROV8000 Processed %s in %d ms; %d of %d records.",
214 infile.toString(), time, array[0], array[1]));
216 Files.delete(infile.toPath());
217 } catch (IOException e) {
218 logger.info("PROV8001 failed to delete file " + infile.getName(), e);
222 boolean pruneRecords() {
223 boolean did1 = false;
224 long count = countRecords();
225 Parameters defaultLogRetention = Parameters.getParameter(Parameters.DEFAULT_LOG_RETENTION);
226 long threshold = (defaultLogRetention != null) ? Long.parseLong(defaultLogRetention.getValue()) : 1000000L;
227 Parameters provLogRetention = Parameters.getParameter(Parameters.PROV_LOG_RETENTION);
228 if (provLogRetention != null) {
230 long retention = Long.parseLong(provLogRetention.getValue());
231 // This check is to prevent inadvertent errors from wiping the table out
232 if (retention > 1000000L) {
233 threshold = retention;
235 } catch (NumberFormatException e) {
239 logger.debug("Pruning LOG_RECORD table: records in DB=" + count + ", threshold=" + threshold);
240 if (count > threshold) {
241 // we need to remove this many records
243 // histogram of records per day
244 Map<Long, Long> hist = getHistogram();
245 // Determine the cutoff point to remove the needed number of records
248 for (Long day : new TreeSet<>(hist.keySet())) {
249 sum += hist.get(day);
258 logger.debug(" Pruning records older than=" + (cutoff / 86400000L) + " (" + new Date(cutoff) + ")");
260 Connection conn = null;
262 // Limit to a million at a time to avoid typing up the DB for too long.
263 conn = db.getConnection();
264 try (PreparedStatement ps = conn.prepareStatement(
265 "DELETE from LOG_RECORDS where EVENT_TIME < ? limit 1000000")) {
266 ps.setLong(1, cutoff);
269 int dcount = ps.getUpdateCount();
271 logger.debug(" " + dcount + " rows deleted.");
272 did1 |= (dcount != 0);
274 count = 0; // prevent inf. loops
277 count = 0; // shouldn't happen!
281 try (Statement stmt = conn.createStatement()) {
282 stmt.execute("OPTIMIZE TABLE LOG_RECORDS");
284 } catch (SQLException e) {
285 logger.error("LogfileLoader.pruneRecords: " + e.getMessage(), e);
293 private long countRecords() {
295 try (Connection conn = db.getConnection();
296 Statement stmt = conn.createStatement()) {
297 try (ResultSet rs = stmt.executeQuery("SELECT COUNT(*) as COUNT from LOG_RECORDS")) {
299 count = rs.getLong("COUNT");
304 } catch (SQLException e) {
305 logger.error("LogfileLoader.countRecords: " + e.getMessage(), e);
310 private Map<Long, Long> getHistogram() {
311 Map<Long, Long> map = new HashMap<>();
312 try (Connection conn = db.getConnection();
313 Statement stmt = conn.createStatement()) {
314 logger.debug(" LOG_RECORD table histogram...");
315 try (ResultSet rs = stmt.executeQuery(
316 "SELECT FLOOR(EVENT_TIME/86400000) AS DAY, COUNT(*) AS COUNT FROM LOG_RECORDS GROUP BY DAY")) {
318 long day = rs.getLong("DAY");
319 long cnt = rs.getLong("COUNT");
321 logger.debug(" " + day + " " + cnt);
326 } catch (SQLException e) {
327 logger.error("LogfileLoader.getHistogram: " + e.getMessage(), e);
332 private void initializeNextid() {
333 Connection conn = null;
335 conn = db.getConnection();
336 RLEBitSet nbs = new RLEBitSet();
337 try (Statement stmt = conn.createStatement()) {
338 // Build a bitset of all records in the LOG_RECORDS table
339 // We need to run this SELECT in stages, because otherwise we run out of memory!
340 final long stepsize = 6000000L;
341 boolean goAgain = true;
342 for (long i = 0; goAgain; i += stepsize) {
343 String sql = String.format("select RECORD_ID from LOG_RECORDS LIMIT %d,%d", i, stepsize);
344 try (ResultSet rs = stmt.executeQuery(sql)) {
347 long recordId = rs.getLong("RECORD_ID");
355 // Compare with the range for this server
356 // Determine the next ID for this set of record IDs
357 RLEBitSet tbs = (RLEBitSet) nbs.clone();
358 RLEBitSet idset = new RLEBitSet();
359 idset.set(setStart, setStart + SET_SIZE);
361 long bitLength = tbs.length();
362 nextId = (bitLength == 0) ? setStart : (bitLength - 1);
363 if (nextId >= setStart + SET_SIZE) {
364 // Handle wraparound, when the IDs reach the end of our "range"
366 Iterator<Long[]> li = tbs.getRangeIterator();
367 while (li.hasNext()) {
371 tbs.clear(last[0], last[1] + 1);
372 bitLength = tbs.length();
373 nextId = (bitLength == 0) ? setStart : (bitLength - 1);
376 logger.debug(String.format("LogfileLoader.initializeNextid, next ID is %d (%x)", nextId, nextId));
377 } catch (SQLException e) {
378 logger.error("LogfileLoader.initializeNextid: " + e.getMessage(), e);
384 @SuppressWarnings("resource")
385 int[] process(File file) {
389 Connection conn = db.getConnection();
390 PreparedStatement ps = conn.prepareStatement(INSERT_SQL);
391 Reader reader = file.getPath().endsWith(".gz")
392 ? new InputStreamReader(new GZIPInputStream(new FileInputStream(file)))
393 : new FileReader(file);
394 try (LineNumberReader in = new LineNumberReader(reader)) {
396 while ((line = in.readLine()) != null) {
398 for (Loadable rec : buildRecords(line)) {
400 if (rec instanceof LogRecord) {
401 LogRecord lr = ((LogRecord) rec);
402 if (!seqSet.get(lr.getRecordId())) {
404 seqSet.set(lr.getRecordId());
406 logger.debug("Duplicate record ignored: " + lr.getRecordId());
409 if (++nextId > setEnd) {
412 ps.setLong(18, nextId);
416 ps.clearParameters();
419 } catch (SQLException e) {
420 logger.warn("PROV8003 Invalid value in record: " + line, e);
421 } catch (NumberFormatException e) {
422 logger.warn("PROV8004 Invalid number in record: " + line, e);
423 } catch (ParseException e) {
424 logger.warn("PROV8005 Invalid date in record: " + line, e);
425 } catch (Exception e) {
426 logger.warn("PROV8006 Invalid pattern in record: " + line, e);
433 } catch (SQLException | IOException e) {
434 logger.warn("PROV8007 Exception reading " + file + ": " + e);
436 return new int[]{ok, total};
439 Loadable[] buildRecords(String line) throws ParseException {
440 String[] pp = line.split("\\|");
441 if (pp != null && pp.length >= 7) {
442 String rtype = pp[1].toUpperCase();
443 if ("PUB".equals(rtype) && pp.length == 11) {
444 // Fields are: date|PUB|pubid|feedid|requrl|method|ctype|clen|srcip|user|status
445 return new Loadable[]{new PublishRecord(pp)};
447 if ("DEL".equals(rtype) && pp.length == 12) {
448 // Fields are: date|DEL|pubid|feedid|subid|requrl|method|ctype|clen|user|status|xpubid
449 String[] subs = pp[4].split("\\s+");
451 Loadable[] rv = new Loadable[subs.length];
452 for (int i = 0; i < subs.length; i++) {
453 // create a new record for each individual sub
455 rv[i] = new DeliveryRecord(pp);
460 if ("EXP".equals(rtype) && pp.length == 11) {
461 // Fields are: date|EXP|pubid|feedid|subid|requrl|method|ctype|clen|reason|attempts
462 ExpiryRecord expiryRecord = new ExpiryRecord(pp);
463 if ("other".equals(expiryRecord.getReason())) {
464 logger.info("Invalid reason '" + pp[9] + "' changed to 'other' for record: "
465 + expiryRecord.getPublishId());
467 return new Loadable[]{expiryRecord};
469 if ("PBF".equals(rtype) && pp.length == 12) {
470 // Fields are: date|PBF|pubid|feedid|requrl|method|ctype|clen-expected|clen-received|srcip|user|error
471 return new Loadable[]{new PubFailRecord(pp)};
473 if ("DLX".equals(rtype) && pp.length == 7) {
474 // Fields are: date|DLX|pubid|feedid|subid|clen-tosend|clen-sent
475 return new Loadable[]{new DeliveryExtraRecord(pp)};
477 if ("LOG".equals(rtype) && (pp.length == 19 || pp.length == 20)) {
478 // Fields are: date|LOG|pubid|feedid|requrl|method|ctype|clen|type|
479 // feedFileid|remoteAddr|user|status|subid|fileid|result|attempts|reason|record_id
480 return new Loadable[]{new LogRecord(pp)};
483 logger.warn("PROV8002 bad record: " + line);
484 return new Loadable[0];
488 * The LogfileLoader can be run stand-alone by invoking the main() method of this class.
492 public static void main(String[] str) throws InterruptedException {
493 LogfileLoader.getLoader();
494 Thread.sleep(200000L);