|
| 1 | +/* |
| 2 | + * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * This code is free software; you can redistribute it and/or modify it |
| 6 | + * under the terms of the GNU General Public License version 2 only, as |
| 7 | + * published by the Free Software Foundation. Oracle designates this |
| 8 | + * particular file as subject to the "Classpath" exception as provided |
| 9 | + * by Oracle in the LICENSE file that accompanied this code. |
| 10 | + * |
| 11 | + * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | + * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | + * accompanied this code). |
| 16 | + * |
| 17 | + * You should have received a copy of the GNU General Public License version |
| 18 | + * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | + * |
| 21 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| 22 | + * or visit www.oracle.com if you need additional information or have any |
| 23 | + * questions. |
| 24 | + */ |
| 25 | +package jdk.jfr.internal.consumer; |
| 26 | + |
| 27 | +import java.io.IOException; |
| 28 | +import java.io.PrintWriter; |
| 29 | +import java.io.Writer; |
| 30 | +import java.util.HashSet; |
| 31 | +import java.util.Set; |
| 32 | + |
| 33 | +import jdk.jfr.EventType; |
| 34 | +import jdk.jfr.FlightRecorder; |
| 35 | +import jdk.jfr.consumer.EventStream; |
| 36 | +import jdk.jfr.consumer.RecordedEvent; |
| 37 | +import jdk.jfr.internal.LogLevel; |
| 38 | +import jdk.jfr.internal.LogTag; |
| 39 | +import jdk.jfr.internal.Logger; |
| 40 | +import jdk.jfr.internal.PlatformEventType; |
| 41 | +import jdk.jfr.internal.PrivateAccess; |
| 42 | +import jdk.jfr.internal.tool.PrettyWriter; |
| 43 | + |
| 44 | + |
| 45 | +public final class EventLog { |
| 46 | + private static final class LogWriter extends Writer { |
| 47 | + private final StringBuilder builder = new StringBuilder(); |
| 48 | + private LogLevel level = LogLevel.WARN; |
| 49 | + private boolean system; |
| 50 | + |
| 51 | + public void setSystem(boolean system) { |
| 52 | + this.system = system; |
| 53 | + } |
| 54 | + |
| 55 | + public void setLevel(LogLevel level) { |
| 56 | + this.level = level; |
| 57 | + } |
| 58 | + |
| 59 | + @Override |
| 60 | + public void write(char[] buffer, int off, int len) throws IOException { |
| 61 | + builder.append(buffer, off, len); |
| 62 | + } |
| 63 | + |
| 64 | + @Override |
| 65 | + public void flush() throws IOException { |
| 66 | + String[] lines = builder.toString().split("\n"); |
| 67 | + builder.setLength(0); |
| 68 | + Logger.logEvent(level, lines, system); |
| 69 | + } |
| 70 | + |
| 71 | + @Override |
| 72 | + public void close() throws IOException { |
| 73 | + // ignore |
| 74 | + } |
| 75 | + } |
| 76 | + |
| 77 | + private static EventStream logStream; |
| 78 | + private static PrettyWriter prettyWriter; |
| 79 | + private static LogWriter logWriter; |
| 80 | + private static Set<Long> systemEventLookup; |
| 81 | + |
| 82 | + // 1) At least one disk recording must be running |
| 83 | + // before calling this method |
| 84 | + // 2) Caller must hold PlatformRecorder lock |
| 85 | + public static void update() { |
| 86 | + boolean shouldLog = shouldLog(); |
| 87 | + if (shouldLog && !isLogging()) { |
| 88 | + start(); |
| 89 | + return; |
| 90 | + } |
| 91 | + if (!shouldLog && isLogging()) { |
| 92 | + stop(); |
| 93 | + return; |
| 94 | + } |
| 95 | + } |
| 96 | + |
| 97 | + // 1) At least one disk recording must be running |
| 98 | + // before calling this method |
| 99 | + // 2) Caller must hold PlatformRecorder lock |
| 100 | + public static void start() { |
| 101 | + if (logStream != null) { |
| 102 | + return; |
| 103 | + } |
| 104 | + try { |
| 105 | + ensureSystemEventLookup(); |
| 106 | + logStream = EventStream.openRepository(); |
| 107 | + ((AbstractEventStream)logStream).setDaemon(true); |
| 108 | + logStream.onEvent(EventLog::log); |
| 109 | + logWriter = new LogWriter(); |
| 110 | + prettyWriter = new PrettyWriter(new PrintWriter(logWriter)); |
| 111 | + prettyWriter.setLineSeparator("\n"); |
| 112 | + logStream.startAsync(); |
| 113 | + Logger.log(LogTag.JFR_SYSTEM, LogLevel.DEBUG, "Log stream started"); |
| 114 | + } catch (Exception e) { |
| 115 | + Logger.log(LogTag.JFR_SYSTEM, LogLevel.WARN, "Unable to print events to the log"); |
| 116 | + } |
| 117 | + } |
| 118 | + |
| 119 | + // Caller must hold PlatformRecorder lock |
| 120 | + public static void stop() { |
| 121 | + if (logStream == null) { |
| 122 | + return; |
| 123 | + } |
| 124 | + try { |
| 125 | + logStream.close(); |
| 126 | + logStream = null; |
| 127 | + Logger.log(LogTag.JFR_SYSTEM, LogLevel.DEBUG, "Log stream stopped"); |
| 128 | + } catch (Exception e) { |
| 129 | + Logger.log(LogTag.JFR_SYSTEM, LogLevel.WARN, "Unable to stop printing events to the log"); |
| 130 | + } |
| 131 | + } |
| 132 | + |
| 133 | + public static boolean shouldLog() { |
| 134 | + if (Logger.shouldLog(LogTag.JFR_EVENT, LogLevel.DEBUG)) { |
| 135 | + return true; |
| 136 | + } |
| 137 | + if (Logger.shouldLog(LogTag.JFR_SYSTEM_EVENT, LogLevel.DEBUG)) { |
| 138 | + return true; |
| 139 | + } |
| 140 | + return false; |
| 141 | + } |
| 142 | + |
| 143 | + private static void log(RecordedEvent event) { |
| 144 | + boolean system = isSystemEvent(event); |
| 145 | + LogTag tag = system ? LogTag.JFR_SYSTEM_EVENT : LogTag.JFR_EVENT; |
| 146 | + LogLevel level = tag.level(); |
| 147 | + if (Logger.shouldLog(tag, LogLevel.TRACE)) { |
| 148 | + log(event, 64, level, system); |
| 149 | + return; |
| 150 | + } |
| 151 | + |
| 152 | + if (Logger.shouldLog(tag, LogLevel.DEBUG)) { |
| 153 | + log(event, 5, level, system); |
| 154 | + return; |
| 155 | + } |
| 156 | + } |
| 157 | + |
| 158 | + private static void log(RecordedEvent event, int stackDepth, LogLevel level, boolean system) { |
| 159 | + logWriter.setSystem(system); |
| 160 | + logWriter.setLevel(level); |
| 161 | + prettyWriter.setStackDepth(stackDepth); |
| 162 | + prettyWriter.print(event); |
| 163 | + prettyWriter.flush(true); |
| 164 | + try { |
| 165 | + logWriter.flush(); |
| 166 | + } catch (IOException e) { |
| 167 | + Logger.log(LogTag.JFR_SYSTEM, LogLevel.WARN, "Unable to print event to the log"); |
| 168 | + } |
| 169 | + } |
| 170 | + |
| 171 | + private static boolean isSystemEvent(RecordedEvent event) { |
| 172 | + return systemEventLookup.contains(event.getEventType().getId()); |
| 173 | + } |
| 174 | + |
| 175 | + // The file format doesn't contains information if an event is |
| 176 | + // from the JDK/JVM, besides the prefix "jdk." which is not reliable |
| 177 | + // Therefore, create a lookup by event type ID to see if is a JDK/JVM event. |
| 178 | + private static void ensureSystemEventLookup() { |
| 179 | + if (systemEventLookup == null) { |
| 180 | + systemEventLookup = new HashSet<>(); |
| 181 | + for (EventType type : FlightRecorder.getFlightRecorder().getEventTypes()) { |
| 182 | + PlatformEventType pe = PrivateAccess.getInstance().getPlatformEventType(type); |
| 183 | + if (pe.isSystem()) { |
| 184 | + systemEventLookup.add(pe.getId()); |
| 185 | + } |
| 186 | + } |
| 187 | + } |
| 188 | + } |
| 189 | + |
| 190 | + private static boolean isLogging() { |
| 191 | + return logStream != null; |
| 192 | + } |
| 193 | +} |
0 commit comments