diff options
Diffstat (limited to 'vespalog/src/main/java/com/yahoo/log')
21 files changed, 107 insertions, 17 deletions
diff --git a/vespalog/src/main/java/com/yahoo/log/DefaultLevelController.java b/vespalog/src/main/java/com/yahoo/log/DefaultLevelController.java index 58e93c96ec9..b90c63b185e 100644 --- a/vespalog/src/main/java/com/yahoo/log/DefaultLevelController.java +++ b/vespalog/src/main/java/com/yahoo/log/DefaultLevelController.java @@ -1,18 +1,22 @@ // Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. package com.yahoo.log; +import com.yahoo.log.impl.LogUtils; import java.util.logging.Level; /** * a levelcontroller that just implements a simple default * (possibly controlled by a system property or environment) - **/ + * @deprecated Should only be used internally in the log library + */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) class DefaultLevelController implements LevelController { private String levelstring; private Level levelLimit = LogLevel.EVENT; DefaultLevelController(String env) { - if (LogUtil.empty(env)) { + if (LogUtils.empty(env)) { env = "all -debug -spam"; } diff --git a/vespalog/src/main/java/com/yahoo/log/FileLogTarget.java b/vespalog/src/main/java/com/yahoo/log/FileLogTarget.java index 313fbbe074b..b4752c23b73 100644 --- a/vespalog/src/main/java/com/yahoo/log/FileLogTarget.java +++ b/vespalog/src/main/java/com/yahoo/log/FileLogTarget.java @@ -6,7 +6,10 @@ import java.io.*; /** * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) public class FileLogTarget implements LogTarget { private final File file; private FileOutputStream fileOutputStream; diff --git a/vespalog/src/main/java/com/yahoo/log/LevelController.java b/vespalog/src/main/java/com/yahoo/log/LevelController.java index 2a549c0dd4f..c710d5c60eb 100644 --- a/vespalog/src/main/java/com/yahoo/log/LevelController.java +++ b/vespalog/src/main/java/com/yahoo/log/LevelController.java @@ -10,7 +10,9 @@ import java.util.logging.Level; * * @author arnej27959 * + * @deprecated Should only be used internally in the log library */ +@Deprecated(since = "7", forRemoval = true) public interface LevelController { /** diff --git a/vespalog/src/main/java/com/yahoo/log/LevelControllerRepo.java b/vespalog/src/main/java/com/yahoo/log/LevelControllerRepo.java index 372b3d44e9e..ab70ecf2c96 100644 --- a/vespalog/src/main/java/com/yahoo/log/LevelControllerRepo.java +++ b/vespalog/src/main/java/com/yahoo/log/LevelControllerRepo.java @@ -7,7 +7,10 @@ package com.yahoo.log; * * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) public interface LevelControllerRepo { /** * Return the level controller for a given component. diff --git a/vespalog/src/main/java/com/yahoo/log/LogMessage.java b/vespalog/src/main/java/com/yahoo/log/LogMessage.java index f48ae97850a..e5a22f81ad9 100644 --- a/vespalog/src/main/java/com/yahoo/log/LogMessage.java +++ b/vespalog/src/main/java/com/yahoo/log/LogMessage.java @@ -21,6 +21,7 @@ import java.util.regex.Pattern; * @author Bjorn Borud * @author bjorncs */ +@SuppressWarnings("removal") public class LogMessage { private static Logger log = Logger.getLogger(LogMessage.class.getName()); @@ -188,7 +189,7 @@ public class LogMessage + component.length() + level.toString().length() + payload.length() - + 1) + + 7) .append(timeStr).append("\t") .append(host).append("\t") .append(threadProcess).append("\t") diff --git a/vespalog/src/main/java/com/yahoo/log/LogMessageTimeComparator.java b/vespalog/src/main/java/com/yahoo/log/LogMessageTimeComparator.java index 7132dbfbc7f..069a47b1efe 100644 --- a/vespalog/src/main/java/com/yahoo/log/LogMessageTimeComparator.java +++ b/vespalog/src/main/java/com/yahoo/log/LogMessageTimeComparator.java @@ -12,8 +12,7 @@ import java.util.Comparator; * This is due to only looking at the timestamp, so two different messages with * the same timestamp would appear "equal" to this comparator. * - * @author vlarsen - * + * @author Vidar Larsen */ public class LogMessageTimeComparator implements Comparator<LogMessage>, Serializable { private static final long serialVersionUID = 1L; diff --git a/vespalog/src/main/java/com/yahoo/log/LogSetup.java b/vespalog/src/main/java/com/yahoo/log/LogSetup.java index 932c993b19e..67fb7f71a2d 100644 --- a/vespalog/src/main/java/com/yahoo/log/LogSetup.java +++ b/vespalog/src/main/java/com/yahoo/log/LogSetup.java @@ -1,12 +1,20 @@ // Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. package com.yahoo.log; +import com.yahoo.log.impl.LogUtils; + import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.util.Enumeration; -import java.util.logging.*; import java.util.Timer; +import java.util.logging.FileHandler; +import java.util.logging.Filter; +import java.util.logging.Handler; +import java.util.logging.Level; +import java.util.logging.LogManager; +import java.util.logging.LogRecord; +import java.util.logging.Logger; /** * Sets up Vespa logging. Call a setup method to set up this. @@ -14,10 +22,16 @@ import java.util.Timer; * @author Bjorn Borud * @author arnej27959 */ +@SuppressWarnings("removal") public class LogSetup { private static Timer taskRunner = new Timer(true); - /** A global task thread */ + + /** + * A global task thread + * @deprecated Just construct a java.util.Timer instead + **/ + @Deprecated(since = "7", forRemoval = true) public static Timer getTaskRunner() { return taskRunner; } /** The log handler used by this */ @@ -25,6 +39,7 @@ public class LogSetup { private static ZooKeeperFilter zooKeeperFilter = null; + /** Clear all handlers registered in java.util.logging framework */ public static void clearHandlers () { Enumeration<String> names = LogManager.getLogManager().getLoggerNames(); while (names.hasMoreElements()) { @@ -155,14 +170,18 @@ public class LogSetup { Logger.getLogger("").addHandler(logHandler); } - /** Returns the log handler set up by this class */ + /** + * Returns the log handler set up by this class + * @deprecated Should only be used internally in the log library + */ + @Deprecated(since = "7", forRemoval = true) public static VespaLogHandler getLogHandler() { return logHandler; } - /** Returns the log handler set up by this class */ + /** perform cleanup */ public static void cleanup() { - if (zooKeeperFilter != null) + if (zooKeeperFilter != null) zooKeeperFilter.close(); } diff --git a/vespalog/src/main/java/com/yahoo/log/LogTarget.java b/vespalog/src/main/java/com/yahoo/log/LogTarget.java index 5cc5fd06137..ef5974259c8 100644 --- a/vespalog/src/main/java/com/yahoo/log/LogTarget.java +++ b/vespalog/src/main/java/com/yahoo/log/LogTarget.java @@ -6,7 +6,9 @@ import java.io.OutputStream; /** * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@Deprecated(since = "7", forRemoval = true) public interface LogTarget { /** * Opens an output stream for the target. If already open, the stream should be reopened. diff --git a/vespalog/src/main/java/com/yahoo/log/LogUtil.java b/vespalog/src/main/java/com/yahoo/log/LogUtil.java index 3b726d9acf8..2424aa9060f 100644 --- a/vespalog/src/main/java/com/yahoo/log/LogUtil.java +++ b/vespalog/src/main/java/com/yahoo/log/LogUtil.java @@ -4,7 +4,9 @@ package com.yahoo.log; /** * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@Deprecated(since = "7", forRemoval = true) class LogUtil { static boolean empty(String s) { return (s == null || s.equals("")); diff --git a/vespalog/src/main/java/com/yahoo/log/MappedLevelController.java b/vespalog/src/main/java/com/yahoo/log/MappedLevelController.java index b602de25c7f..b7e18c83997 100644 --- a/vespalog/src/main/java/com/yahoo/log/MappedLevelController.java +++ b/vespalog/src/main/java/com/yahoo/log/MappedLevelController.java @@ -9,7 +9,10 @@ import java.util.logging.Level; /** * a level controller that does lookup in a file via a memory-mapped * buffer for realtime logging control. - **/ + * @deprecated Should only be used internally in the log library + */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) class MappedLevelController implements LevelController { private static final int ONVAL = 0x20204f4e; // equals " ON" in file private static final int OFFVAL = 0x204f4646; // equals " OFF" in file diff --git a/vespalog/src/main/java/com/yahoo/log/MappedLevelControllerRepo.java b/vespalog/src/main/java/com/yahoo/log/MappedLevelControllerRepo.java index 1e074445b44..97c8aa8f70f 100644 --- a/vespalog/src/main/java/com/yahoo/log/MappedLevelControllerRepo.java +++ b/vespalog/src/main/java/com/yahoo/log/MappedLevelControllerRepo.java @@ -12,7 +12,10 @@ import java.util.Map; * * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) class MappedLevelControllerRepo { private final Map<String, LevelController> levelControllerMap = new HashMap<>(); private final MappedByteBuffer mapBuf; diff --git a/vespalog/src/main/java/com/yahoo/log/RejectFilter.java b/vespalog/src/main/java/com/yahoo/log/RejectFilter.java index c018645327a..b328073b20b 100644 --- a/vespalog/src/main/java/com/yahoo/log/RejectFilter.java +++ b/vespalog/src/main/java/com/yahoo/log/RejectFilter.java @@ -9,7 +9,9 @@ import java.util.List; * * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@Deprecated(since = "7", forRemoval = true) public class RejectFilter { private final List<String> rejectedMessages = new ArrayList<>(); diff --git a/vespalog/src/main/java/com/yahoo/log/StderrLogTarget.java b/vespalog/src/main/java/com/yahoo/log/StderrLogTarget.java index bc91d7e76b4..b1c245642ff 100644 --- a/vespalog/src/main/java/com/yahoo/log/StderrLogTarget.java +++ b/vespalog/src/main/java/com/yahoo/log/StderrLogTarget.java @@ -6,7 +6,10 @@ import java.io.OutputStream; /** * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) public class StderrLogTarget implements LogTarget { @Override diff --git a/vespalog/src/main/java/com/yahoo/log/StdoutLogTarget.java b/vespalog/src/main/java/com/yahoo/log/StdoutLogTarget.java index 6a1cd9ac672..e036e534e00 100644 --- a/vespalog/src/main/java/com/yahoo/log/StdoutLogTarget.java +++ b/vespalog/src/main/java/com/yahoo/log/StdoutLogTarget.java @@ -6,7 +6,10 @@ import java.io.OutputStream; /** * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) public class StdoutLogTarget implements LogTarget { @Override diff --git a/vespalog/src/main/java/com/yahoo/log/UncloseableOutputStream.java b/vespalog/src/main/java/com/yahoo/log/UncloseableOutputStream.java index 827c1c373f8..61e278ef93a 100644 --- a/vespalog/src/main/java/com/yahoo/log/UncloseableOutputStream.java +++ b/vespalog/src/main/java/com/yahoo/log/UncloseableOutputStream.java @@ -7,7 +7,9 @@ import java.io.OutputStream; /** * @author Simon Thoresen Hult * @since 5.1.14 + * @deprecated Should only be used internally in the log library */ +@Deprecated(since = "7", forRemoval = true) class UncloseableOutputStream extends OutputStream { private final OutputStream out; diff --git a/vespalog/src/main/java/com/yahoo/log/Util.java b/vespalog/src/main/java/com/yahoo/log/Util.java index bcbe5bbae4a..7a7ae5221c4 100644 --- a/vespalog/src/main/java/com/yahoo/log/Util.java +++ b/vespalog/src/main/java/com/yahoo/log/Util.java @@ -9,7 +9,9 @@ import static com.yahoo.vespa.defaults.Defaults.getDefaults; * @author arnej27959 * @author bjorncs * + * @deprecated Should only be used internally in the log library */ +@Deprecated(since = "7", forRemoval = true) public class Util { public static String getHostName () { diff --git a/vespalog/src/main/java/com/yahoo/log/VespaFormat.java b/vespalog/src/main/java/com/yahoo/log/VespaFormat.java index 19e898155f4..0ce3668223d 100644 --- a/vespalog/src/main/java/com/yahoo/log/VespaFormat.java +++ b/vespalog/src/main/java/com/yahoo/log/VespaFormat.java @@ -1,18 +1,23 @@ // Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. package com.yahoo.log; +import com.yahoo.log.impl.LogUtils; import java.time.Instant; import java.util.regex.Matcher; import java.util.regex.Pattern; /** * Vespa log formatting utility methods. - * Contains some code based on Util.java in Cloudname https://github.com/Cloudname/cloudname + * Contains some code based on LogUtils.java in Cloudname https://github.com/Cloudname/cloudname * written by Bjørn Borud, licensed under the Apache 2.0 license. - * + * * @author arnej27959 * @author bjorncs + * + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) public class VespaFormat { private static final Pattern special = Pattern.compile("[\r\\\n\\\t\\\\]+"); @@ -25,8 +30,8 @@ public class VespaFormat { private static final String processID; static { - hostname = Util.getHostName(); - processID = Util.getPID(); + hostname = LogUtils.getHostName(); + processID = LogUtils.getPID(); } /** diff --git a/vespalog/src/main/java/com/yahoo/log/VespaFormatter.java b/vespalog/src/main/java/com/yahoo/log/VespaFormatter.java index db4e131c530..c3fd97a5e7c 100644 --- a/vespalog/src/main/java/com/yahoo/log/VespaFormatter.java +++ b/vespalog/src/main/java/com/yahoo/log/VespaFormatter.java @@ -3,6 +3,7 @@ package com.yahoo.log; import com.yahoo.log.event.Event; +import com.yahoo.log.impl.LogUtils; import java.io.PrintWriter; import java.io.StringWriter; @@ -18,7 +19,10 @@ import java.util.regex.Pattern; * @author Bjorn Borud * @author arnej27959 * + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) public class VespaFormatter extends SimpleFormatter { private static final Pattern backSlash = Pattern.compile("\\\\"); @@ -34,8 +38,8 @@ public class VespaFormatter extends SimpleFormatter { public static final String serviceNameUnsetValue = "-"; static { - hostname = Util.getHostName(); - processID = Util.getPID(); + hostname = LogUtils.getHostName(); + processID = LogUtils.getPID(); } private String serviceName; diff --git a/vespalog/src/main/java/com/yahoo/log/VespaLevelControllerRepo.java b/vespalog/src/main/java/com/yahoo/log/VespaLevelControllerRepo.java index b1a3305daae..0163a68bf4c 100644 --- a/vespalog/src/main/java/com/yahoo/log/VespaLevelControllerRepo.java +++ b/vespalog/src/main/java/com/yahoo/log/VespaLevelControllerRepo.java @@ -17,7 +17,10 @@ import static java.nio.charset.StandardCharsets.US_ASCII; /** * @author Ulf Lilleengen * @since 5.1 + * @deprecated Should only be used internally in the log library */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) public class VespaLevelControllerRepo implements LevelControllerRepo { private RandomAccessFile ctlFile; diff --git a/vespalog/src/main/java/com/yahoo/log/VespaLogHandler.java b/vespalog/src/main/java/com/yahoo/log/VespaLogHandler.java index c0dac86dd26..d41ded6a9b4 100644 --- a/vespalog/src/main/java/com/yahoo/log/VespaLogHandler.java +++ b/vespalog/src/main/java/com/yahoo/log/VespaLogHandler.java @@ -10,6 +10,8 @@ import java.util.logging.StreamHandler; * @author Bjorn Borud * @author arnej27959 */ +@SuppressWarnings("removal") +@Deprecated(since = "7", forRemoval = true) class VespaLogHandler extends StreamHandler { private final LogTarget logTarget; diff --git a/vespalog/src/main/java/com/yahoo/log/impl/LogUtils.java b/vespalog/src/main/java/com/yahoo/log/impl/LogUtils.java new file mode 100644 index 00000000000..8c182625c85 --- /dev/null +++ b/vespalog/src/main/java/com/yahoo/log/impl/LogUtils.java @@ -0,0 +1,23 @@ +// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. +package com.yahoo.log.impl; + +import static com.yahoo.vespa.defaults.Defaults.getDefaults; + +/** + * @author Ulf Lilleengen + * @author Bjorn Borud + * @author arnej27959 + * @author bjorncs + * TODO remove "public" keyword, should be package private + */ +public class LogUtils { + public static boolean empty(String s) { + return (s == null || s.equals("")); + } + public static String getHostName () { + return getDefaults().vespaHostname(); + } + public static String getPID() { + return Long.toString(ProcessHandle.current().pid()); + } +} |