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 ******************************************************************************/
24 package org.onap.dmaap.datarouter.node;
26 import com.att.eelf.configuration.EELFLogger;
27 import com.att.eelf.configuration.EELFManager;
29 import java.io.FileOutputStream;
30 import java.io.IOException;
31 import java.io.OutputStream;
32 import java.nio.file.Files;
33 import java.nio.file.Paths;
34 import java.text.SimpleDateFormat;
35 import java.util.Date;
36 import java.util.regex.Matcher;
37 import java.util.regex.Pattern;
40 * Logging for data router delivery events (PUB/DEL/EXP).
42 public class StatusLog {
44 private static final String EXCEPTION = "Exception";
45 private static EELFLogger eelfLogger = EELFManager.getInstance().getLogger(StatusLog.class);
46 private static StatusLog instance = new StatusLog();
47 private SimpleDateFormat filedate = new SimpleDateFormat("-yyyyMMddHHmm");
49 private String prefix = "logs/events";
50 private String suffix = ".log";
51 private String plainfile;
52 private String curfile;
53 private long nexttime;
54 private OutputStream os;
56 private static NodeConfigManager config = NodeConfigManager.getInstance();
62 * Parse an interval of the form xxhyymzzs and round it to the nearest whole fraction of 24 hours.If no units are
63 * specified, assume seconds.
65 public static long parseInterval(String interval, int def) {
67 Matcher matcher = Pattern.compile("(?:(\\d+)[Hh])?(?:(\\d+)[Mm])?(?:(\\d+)[Ss]?)?").matcher(interval);
68 if (matcher.matches()) {
69 int dur = getDur(matcher);
71 int dist = best - dur;
75 best = getBest(dur, best, dist);
78 } catch (Exception e) {
79 eelfLogger.error(EXCEPTION, e);
84 private static int getBest(int dur, int best, int dist) {
86 for (int i = 0; i < 8; i++) {
89 for (int j = 0; j < 4; j++) {
92 for (int k = 0; k < 3; k++) {
95 int ndist = cur - dur;
109 private static int getDur(Matcher matcher) {
111 String match = matcher.group(1);
113 dur += 3600 * Integer.parseInt(match);
115 match = matcher.group(2);
117 dur += 60 * Integer.parseInt(match);
119 match = matcher.group(3);
121 dur += Integer.parseInt(match);
130 * Get the name of the current log file.
132 * @return The full path name of the current event log file
134 public static synchronized String getCurLogFile() {
136 instance.checkRoll(System.currentTimeMillis());
137 } catch (Exception e) {
138 eelfLogger.error(EXCEPTION, e);
140 return (instance.curfile);
144 * Log a received publication attempt.
146 * @param pubid The publish ID assigned by the node
147 * @param feedid The feed id given by the publisher
148 * @param requrl The URL of the received request
149 * @param method The method (DELETE or PUT) in the received request
150 * @param ctype The content type (if method is PUT and clen > 0)
151 * @param clen The content length (if method is PUT)
152 * @param srcip The IP address of the publisher
153 * @param user The identity of the publisher
154 * @param status The status returned to the publisher
156 public static void logPub(String pubid, String feedid, String requrl, String method, String ctype, long clen,
157 String srcip, String user, int status) {
159 "PUB|" + pubid + "|" + feedid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen + "|" + srcip
160 + "|" + user + "|" + status);
161 eelfLogger.info("PUB|" + pubid + "|" + feedid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen + "|" + srcip
162 + "|" + user + "|" + status);
166 * Log a data transfer error receiving a publication attempt.
168 * @param pubid The publish ID assigned by the node
169 * @param feedid The feed id given by the publisher
170 * @param requrl The URL of the received request
171 * @param method The method (DELETE or PUT) in the received request
172 * @param ctype The content type (if method is PUT and clen > 0)
173 * @param clen The expected content length (if method is PUT)
174 * @param rcvd The content length received
175 * @param srcip The IP address of the publisher
176 * @param user The identity of the publisher
177 * @param error The error message from the IO exception
179 public static void logPubFail(String pubid, String feedid, String requrl, String method, String ctype, long clen,
180 long rcvd, String srcip, String user, String error) {
181 instance.log("PBF|" + pubid + "|" + feedid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen + "|" + rcvd
182 + "|" + srcip + "|" + user + "|" + error);
183 eelfLogger.info("PBF|" + pubid + "|" + feedid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen + "|" + rcvd
184 + "|" + srcip + "|" + user + "|" + error);
188 * Log a delivery attempt.
190 * @param pubid The publish ID assigned by the node
191 * @param feedid The feed ID
192 * @param subid The (space delimited list of) subscription ID
193 * @param requrl The URL used in the attempt
194 * @param method The method (DELETE or PUT) in the attempt
195 * @param ctype The content type (if method is PUT, not metaonly, and clen > 0)
196 * @param clen The content length (if PUT and not metaonly)
197 * @param user The identity given to the subscriber
198 * @param status The status returned by the subscriber or -1 if an exeception occured trying to connect
199 * @param xpubid The publish ID returned by the subscriber
201 public static void logDel(String pubid, String feedid, String subid, String requrl, String method, String ctype,
202 long clen, String user, int status, String xpubid) {
203 if (feedid == null) {
207 "DEL|" + pubid + "|" + feedid + "|" + subid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen
208 + "|" + user + "|" + status + "|" + xpubid);
209 eelfLogger.info("DEL|" + pubid + "|" + feedid + "|" + subid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen
210 + "|" + user + "|" + status + "|" + xpubid);
214 * Log delivery attempts expired.
216 * @param pubid The publish ID assigned by the node
217 * @param feedid The feed ID
218 * @param subid The (space delimited list of) subscription ID
219 * @param requrl The URL that would be delivered to
220 * @param method The method (DELETE or PUT) in the request
221 * @param ctype The content type (if method is PUT, not metaonly, and clen > 0)
222 * @param clen The content length (if PUT and not metaonly)
223 * @param reason The reason the attempts were discontinued
224 * @param attempts The number of attempts made
226 public static void logExp(String pubid, String feedid, String subid, String requrl, String method, String ctype,
227 long clen, String reason, int attempts) {
228 if (feedid == null) {
232 "EXP|" + pubid + "|" + feedid + "|" + subid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen
233 + "|" + reason + "|" + attempts);
234 eelfLogger.info("EXP|" + pubid + "|" + feedid + "|" + subid + "|" + requrl + "|" + method + "|" + ctype + "|" + clen
235 + "|" + reason + "|" + attempts);
239 * Log extra statistics about unsuccessful delivery attempts.
241 * @param pubid The publish ID assigned by the node
242 * @param feedid The feed ID
243 * @param subid The (space delimited list of) subscription ID
244 * @param clen The content length
245 * @param sent The # of bytes sent or -1 if subscriber returned an error instead of 100 Continue, otherwise, the
246 * number of bytes sent before an error occurred.
248 public static void logDelExtra(String pubid, String feedid, String subid, long clen, long sent) {
249 if (feedid == null) {
252 instance.log("DLX|" + pubid + "|" + feedid + "|" + subid + "|" + clen + "|" + sent);
253 eelfLogger.info("DLX|" + pubid + "|" + feedid + "|" + subid + "|" + clen + "|" + sent);
256 private synchronized void checkRoll(long now) throws IOException {
257 if (now >= nexttime) {
262 intvl = parseInterval(config.getEventLogInterval(), 300000);
263 prefix = config.getEventLogPrefix();
264 suffix = config.getEventLogSuffix();
265 nexttime = now - now % intvl + intvl;
266 curfile = prefix + filedate.format(new Date(nexttime - intvl)) + suffix;
267 plainfile = prefix + suffix;
272 private synchronized void log(String string) {
274 long now = System.currentTimeMillis();
277 os = new FileOutputStream(curfile, true);
278 (new File(plainfile)).delete();
279 Files.createLink(Paths.get(plainfile), Paths.get(curfile));
281 os.write((NodeUtils.logts(new Date(now)) + '|' + string + '\n').getBytes());
283 } catch (IOException ioe) {
284 eelfLogger.error("IOException", ioe);