1 /*******************************************************************************
\r
2 * ============LICENSE_START==================================================
\r
4 * * ===========================================================================
\r
5 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
\r
6 * * ===========================================================================
\r
7 * * Licensed under the Apache License, Version 2.0 (the "License");
\r
8 * * you may not use this file except in compliance with the License.
\r
9 * * You may obtain a copy of the License at
\r
11 * * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * * Unless required by applicable law or agreed to in writing, software
\r
14 * * distributed under the License is distributed on an "AS IS" BASIS,
\r
15 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
16 * * See the License for the specific language governing permissions and
\r
17 * * limitations under the License.
\r
18 * * ============LICENSE_END====================================================
\r
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
\r
22 ******************************************************************************/
\r
25 package org.onap.dmaap.datarouter.provisioning.utils;
\r
27 import java.io.File;
\r
28 import java.io.FileInputStream;
\r
29 import java.io.FileNotFoundException;
\r
30 import java.io.FileReader;
\r
31 import java.io.FilenameFilter;
\r
32 import java.io.IOException;
\r
33 import java.io.InputStreamReader;
\r
34 import java.io.LineNumberReader;
\r
35 import java.io.Reader;
\r
36 import java.sql.Connection;
\r
37 import java.sql.PreparedStatement;
\r
38 import java.sql.ResultSet;
\r
39 import java.sql.SQLException;
\r
40 import java.sql.Statement;
\r
41 import java.text.ParseException;
\r
42 import java.util.Date;
\r
43 import java.util.HashMap;
\r
44 import java.util.Iterator;
\r
45 import java.util.Map;
\r
46 import java.util.TreeSet;
\r
47 import java.util.zip.GZIPInputStream;
\r
49 import org.apache.log4j.Logger;
\r
50 import org.onap.dmaap.datarouter.provisioning.BaseServlet;
\r
51 import org.onap.dmaap.datarouter.provisioning.beans.DeliveryExtraRecord;
\r
52 import org.onap.dmaap.datarouter.provisioning.beans.DeliveryRecord;
\r
53 import org.onap.dmaap.datarouter.provisioning.beans.ExpiryRecord;
\r
54 import org.onap.dmaap.datarouter.provisioning.beans.Loadable;
\r
55 import org.onap.dmaap.datarouter.provisioning.beans.LogRecord;
\r
56 import org.onap.dmaap.datarouter.provisioning.beans.Parameters;
\r
57 import org.onap.dmaap.datarouter.provisioning.beans.PubFailRecord;
\r
58 import org.onap.dmaap.datarouter.provisioning.beans.PublishRecord;
\r
61 * This class provides methods that run in a separate thread, in order to process logfiles uploaded into the spooldir.
\r
62 * These logfiles are loaded into the MariaDB LOG_RECORDS table. In a running provisioning server, there should only be
\r
63 * two places where records can be loaded into this table; here, and in the method DB.retroFit4() which may be run at
\r
64 * startup to load the old (1.0) style log tables into LOG_RECORDS;
\r
65 * <p>This method maintains an {@link RLEBitSet} which can be used to easily see what records are presently in the
\r
67 * This bit set is used to synchronize between provisioning servers.</p>
\r
69 * @author Robert Eby
\r
70 * @version $Id: LogfileLoader.java,v 1.22 2014/03/12 19:45:41 eby Exp $
\r
72 public class LogfileLoader extends Thread {
\r
74 * Default number of log records to keep when pruning. Keep 10M by default.
\r
76 public static final long DEFAULT_LOG_RETENTION = 10000000L;
\r
78 * NOT USED: Percentage of free space required before old records are removed.
\r
80 public static final int REQUIRED_FREE_PCT = 20;
\r
83 * This is a singleton -- there is only one LogfileLoader object in the server
\r
85 private static LogfileLoader p;
\r
88 * Get the singleton LogfileLoader object, and start it if it is not running.
\r
90 * @return the LogfileLoader
\r
92 public static synchronized LogfileLoader getLoader() {
\r
94 p = new LogfileLoader();
\r
101 * The PreparedStatement which is loaded by a <i>Loadable</i>.
\r
103 public static final String INSERT_SQL = "insert into LOG_RECORDS values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
\r
105 * Each server can assign this many IDs
\r
107 private static final long SET_SIZE = (1L << 56);
\r
109 private final Logger logger;
\r
110 private final DB db;
\r
111 private final String spooldir;
\r
112 private final long set_start;
\r
113 private final long set_end;
\r
114 private RLEBitSet seq_set;
\r
115 private long nextid;
\r
116 private boolean idle;
\r
118 private LogfileLoader() {
\r
119 this.logger = Logger.getLogger("org.onap.dmaap.datarouter.provisioning.internal");
\r
120 this.db = new DB();
\r
121 this.spooldir = db.getProperties().getProperty("org.onap.dmaap.datarouter.provserver.spooldir");
\r
122 this.set_start = getIdRange();
\r
123 this.set_end = set_start + SET_SIZE - 1;
\r
124 this.seq_set = new RLEBitSet();
\r
128 // This is a potentially lengthy operation, so has been moved to run()
\r
129 //initializeNextid();
\r
130 this.setDaemon(true);
\r
131 this.setName("LogfileLoader");
\r
134 private long getIdRange() {
\r
136 if (BaseServlet.isInitialActivePOD())
\r
138 else if (BaseServlet.isInitialStandbyPOD())
\r
142 String r = String.format("[%X .. %X]", n, n + SET_SIZE - 1);
\r
143 logger.debug("This server shall assign RECORD_IDs in the range " + r);
\r
148 * Return the bit set representing the record ID's that are loaded in this database.
\r
150 * @return the bit set
\r
152 public RLEBitSet getBitSet() {
\r
157 * True if the LogfileLoader is currently waiting for work.
\r
159 * @return true if idle
\r
161 public boolean isIdle() {
\r
166 * Run continuously to look for new logfiles in the spool directory and import them into the DB.
\r
167 * The spool is checked once per second. If free space on the MariaDB filesystem falls below
\r
168 * REQUIRED_FREE_PCT (normally 20%) then the oldest logfile entries are removed and the LOG_RECORDS
\r
169 * table is compacted until free space rises above the threshold.
\r
172 public void run() {
\r
173 initializeNextid(); // moved from the constructor
\r
176 File dirfile = new File(spooldir);
\r
178 // process IN files
\r
179 File[] infiles = dirfile.listFiles(new FilenameFilter() {
\r
181 public boolean accept(File dir, String name) {
\r
182 return name.startsWith("IN.");
\r
186 if (infiles.length == 0) {
\r
189 Thread.sleep(1000L);
\r
190 } catch (InterruptedException e) {
\r
195 if (pruneRecords()) {
\r
196 // Removed at least some entries, recompute the bit map
\r
197 initializeNextid();
\r
200 // Process incoming logfiles
\r
201 for (File f : infiles) {
\r
202 if (logger.isDebugEnabled())
\r
203 logger.debug("PROV8001 Starting " + f + " ...");
\r
204 long time = System.currentTimeMillis();
\r
205 int[] n = process(f);
\r
206 time = System.currentTimeMillis() - time;
\r
208 .format("PROV8000 Processed %s in %d ms; %d of %d records.",
\r
209 f.toString(), time, n[0], n[1]));
\r
214 } catch (Exception e) {
\r
215 logger.warn("PROV0020: Caught exception in LogfileLoader: " + e);
\r
216 e.printStackTrace();
\r
221 private boolean pruneRecords() {
\r
222 boolean did1 = false;
\r
223 long count = countRecords();
\r
224 long threshold = DEFAULT_LOG_RETENTION;
\r
225 Parameters param = Parameters.getParameter(Parameters.PROV_LOG_RETENTION);
\r
226 if (param != null) {
\r
228 long n = Long.parseLong(param.getValue());
\r
229 // This check is to prevent inadvertent errors from wiping the table out
\r
232 } catch (NumberFormatException e) {
\r
236 logger.debug("Pruning LOG_RECORD table: records in DB=" + count + ", threshold=" + threshold);
\r
237 if (count > threshold) {
\r
238 count -= threshold; // we need to remove this many records;
\r
239 Map<Long, Long> hist = getHistogram(); // histogram of records per day
\r
240 // Determine the cutoff point to remove the needed number of records
\r
243 for (Long day : new TreeSet<Long>(hist.keySet())) {
\r
244 sum += hist.get(day);
\r
250 cutoff *= 86400000L; // convert day to ms
\r
251 logger.debug(" Pruning records older than=" + (cutoff / 86400000L) + " (" + new Date(cutoff) + ")");
\r
253 Connection conn = null;
\r
255 // Limit to a million at a time to avoid typing up the DB for too long.
\r
256 conn = db.getConnection();
\r
257 PreparedStatement ps = conn.prepareStatement("DELETE from LOG_RECORDS where EVENT_TIME < ? limit 1000000");
\r
258 ps.setLong(1, cutoff);
\r
259 while (count > 0) {
\r
260 if (!ps.execute()) {
\r
261 int dcount = ps.getUpdateCount();
\r
263 logger.debug(" " + dcount + " rows deleted.");
\r
264 did1 |= (dcount != 0);
\r
266 count = 0; // prevent inf. loops
\r
268 count = 0; // shouldn't happen!
\r
272 Statement stmt = conn.createStatement();
\r
273 stmt.execute("OPTIMIZE TABLE LOG_RECORDS");
\r
275 } catch (SQLException e) {
\r
276 System.err.println(e);
\r
277 e.printStackTrace();
\r
285 private long countRecords() {
\r
287 Connection conn = null;
\r
289 conn = db.getConnection();
\r
290 Statement stmt = conn.createStatement();
\r
291 ResultSet rs = stmt.executeQuery("SELECT COUNT(*) as COUNT from LOG_RECORDS");
\r
293 count = rs.getLong("COUNT");
\r
297 } catch (SQLException e) {
\r
298 System.err.println(e);
\r
299 e.printStackTrace();
\r
306 private Map<Long, Long> getHistogram() {
\r
307 Map<Long, Long> map = new HashMap<Long, Long>();
\r
308 Connection conn = null;
\r
310 logger.debug(" LOG_RECORD table histogram...");
\r
311 conn = db.getConnection();
\r
312 Statement stmt = conn.createStatement();
\r
313 ResultSet rs = stmt.executeQuery("SELECT FLOOR(EVENT_TIME/86400000) AS DAY, COUNT(*) AS COUNT FROM LOG_RECORDS GROUP BY DAY");
\r
314 while (rs.next()) {
\r
315 long day = rs.getLong("DAY");
\r
316 long cnt = rs.getLong("COUNT");
\r
318 logger.debug(" " + day + " " + cnt);
\r
322 } catch (SQLException e) {
\r
323 System.err.println(e);
\r
324 e.printStackTrace();
\r
331 private void initializeNextid() {
\r
332 Connection conn = null;
\r
334 conn = db.getConnection();
\r
335 Statement stmt = conn.createStatement();
\r
336 // Build a bitset of all records in the LOG_RECORDS table
\r
337 // We need to run this SELECT in stages, because otherwise we run out of memory!
\r
338 RLEBitSet nbs = new RLEBitSet();
\r
339 final long stepsize = 6000000L;
\r
340 boolean go_again = true;
\r
341 for (long i = 0; go_again; i += stepsize) {
\r
342 String sql = String.format("select RECORD_ID from LOG_RECORDS LIMIT %d,%d", i, stepsize);
\r
343 ResultSet rs = stmt.executeQuery(sql);
\r
345 while (rs.next()) {
\r
346 long n = rs.getLong("RECORD_ID");
\r
355 // Compare with the range for this server
\r
356 // Determine the next ID for this set of record IDs
\r
357 RLEBitSet tbs = (RLEBitSet) nbs.clone();
\r
358 RLEBitSet idset = new RLEBitSet();
\r
359 idset.set(set_start, set_start + SET_SIZE);
\r
361 long t = tbs.length();
\r
362 nextid = (t == 0) ? set_start : (t - 1);
\r
363 if (nextid >= set_start + SET_SIZE) {
\r
364 // Handle wraparound, when the IDs reach the end of our "range"
\r
365 Long[] last = null;
\r
366 Iterator<Long[]> li = tbs.getRangeIterator();
\r
367 while (li.hasNext()) {
\r
370 if (last != null) {
\r
371 tbs.clear(last[0], last[1] + 1);
\r
373 nextid = (t == 0) ? set_start : (t - 1);
\r
376 logger.debug(String.format("initializeNextid, next ID is %d (%x)", nextid, nextid));
\r
377 } catch (SQLException e) {
\r
378 System.err.println(e);
\r
379 e.printStackTrace();
\r
385 @SuppressWarnings("resource")
\r
386 private int[] process(File f) {
\r
387 int ok = 0, total = 0;
\r
389 Connection conn = db.getConnection();
\r
390 PreparedStatement ps = conn.prepareStatement(INSERT_SQL);
\r
391 Reader r = f.getPath().endsWith(".gz")
\r
392 ? new InputStreamReader(new GZIPInputStream(new FileInputStream(f)))
\r
393 : new FileReader(f);
\r
394 LineNumberReader in = new LineNumberReader(r);
\r
396 while ((line = in.readLine()) != null) {
\r
398 for (Loadable rec : buildRecords(line)) {
\r
400 if (rec instanceof LogRecord) {
\r
401 LogRecord lr = ((LogRecord) rec);
\r
402 if (!seq_set.get(lr.getRecordId())) {
\r
403 ps.executeUpdate();
\r
404 seq_set.set(lr.getRecordId());
\r
406 logger.debug("Duplicate record ignored: " + lr.getRecordId());
\r
408 if (++nextid > set_end)
\r
409 nextid = set_start;
\r
410 ps.setLong(18, nextid);
\r
411 ps.executeUpdate();
\r
412 seq_set.set(nextid);
\r
414 ps.clearParameters();
\r
417 } catch (SQLException e) {
\r
418 logger.warn("PROV8003 Invalid value in record: " + line);
\r
420 e.printStackTrace();
\r
421 } catch (NumberFormatException e) {
\r
422 logger.warn("PROV8004 Invalid number in record: " + line);
\r
424 e.printStackTrace();
\r
425 } catch (ParseException e) {
\r
426 logger.warn("PROV8005 Invalid date in record: " + line);
\r
428 e.printStackTrace();
\r
429 } catch (Exception e) {
\r
430 logger.warn("PROV8006 Invalid pattern in record: " + line);
\r
432 e.printStackTrace();
\r
440 } catch (FileNotFoundException e) {
\r
441 logger.warn("PROV8007 Exception reading " + f + ": " + e);
\r
442 } catch (IOException e) {
\r
443 logger.warn("PROV8007 Exception reading " + f + ": " + e);
\r
444 } catch (SQLException e) {
\r
445 logger.warn("PROV8007 Exception reading " + f + ": " + e);
\r
447 return new int[]{ok, total};
\r
450 private Loadable[] buildRecords(String line) throws ParseException {
\r
451 String[] pp = line.split("\\|");
\r
452 if (pp != null && pp.length >= 7) {
\r
453 String rtype = pp[1].toUpperCase();
\r
454 if (rtype.equals("PUB") && pp.length == 11) {
\r
455 // Fields are: date|PUB|pubid|feedid|requrl|method|ctype|clen|srcip|user|status
\r
456 return new Loadable[]{new PublishRecord(pp)};
\r
458 if (rtype.equals("DEL") && pp.length == 12) {
\r
459 // Fields are: date|DEL|pubid|feedid|subid|requrl|method|ctype|clen|user|status|xpubid
\r
460 String[] subs = pp[4].split("\\s+");
\r
461 if (subs != null) {
\r
462 Loadable[] rv = new Loadable[subs.length];
\r
463 for (int i = 0; i < subs.length; i++) {
\r
464 // create a new record for each individual sub
\r
466 rv[i] = new DeliveryRecord(pp);
\r
471 if (rtype.equals("EXP") && pp.length == 11) {
\r
472 // Fields are: date|EXP|pubid|feedid|subid|requrl|method|ctype|clen|reason|attempts
\r
473 ExpiryRecord e = new ExpiryRecord(pp);
\r
474 if (e.getReason().equals("other"))
\r
475 logger.info("Invalid reason '" + pp[9] + "' changed to 'other' for record: " + e.getPublishId());
\r
476 return new Loadable[]{e};
\r
478 if (rtype.equals("PBF") && pp.length == 12) {
\r
479 // Fields are: date|PBF|pubid|feedid|requrl|method|ctype|clen-expected|clen-received|srcip|user|error
\r
480 return new Loadable[]{new PubFailRecord(pp)};
\r
482 if (rtype.equals("DLX") && pp.length == 7) {
\r
483 // Fields are: date|DLX|pubid|feedid|subid|clen-tosend|clen-sent
\r
484 return new Loadable[]{new DeliveryExtraRecord(pp)};
\r
486 if (rtype.equals("LOG") && (pp.length == 19 || pp.length == 20)) {
\r
487 // Fields are: date|LOG|pubid|feedid|requrl|method|ctype|clen|type|feedFileid|remoteAddr|user|status|subid|fileid|result|attempts|reason|record_id
\r
488 return new Loadable[]{new LogRecord(pp)};
\r
491 logger.warn("PROV8002 bad record: " + line);
\r
492 return new Loadable[0];
\r
496 * The LogfileLoader can be run stand-alone by invoking the main() method of this class.
\r
499 * @throws InterruptedException
\r
501 public static void main(String[] a) throws InterruptedException {
\r
502 LogfileLoader.getLoader();
\r
503 Thread.sleep(200000L);
\r