TIKA-4809: Rename logLevel, drop the no-op -a flag, fix --help exit, delete orphan config

Author: tballison

docs/modules/ROOT/pages/using-tika/server/index.adoc

@@ -92,11 +92,8 @@ The server starts on `localhost:9998` by default.
 |`-c <file>` or `--config <file>`
 |Path to `tika-config.json`. See <<_configuration,Configuration>> below.
 
-|`-a <file>` or `--pluginsConfig <file>`
-|Path to the Tika Pipes plugins configuration file.
-
 |`-i <id>` or `--id <id>`
-|Server ID, surfaced in the `/status` endpoint and in logs.
+|Server ID, written to the startup log. Defaults to a random UUID.
 
 |`-?` or `--help`
 |Print the usage message.
@@ -182,7 +179,7 @@ curl -T document.pdf http://localhost:9998/meta/Content-Type   # single field
 === Other endpoints
 
 * `/version` — server version
-* `/status` — health/status (includes server ID)
+* `/status` — health/status: state, active task count, files processed
 * `/parsers` and `/parsers/details` — registered parsers
 * `/detectors` — registered detectors
 * `/mime-types` — known MIME types

tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerCli.java

@@ -43,8 +43,6 @@ private static Options getOptions() {
                 "listen port (default = 9998)\n");
         options.addOption("?", "help", false, "this help message");
         options.addOption("c", "config", true, "tika-config file");
-        options.addOption("a", "pluginsConfig", true, "tike pipes config");
-
         options.addOption("i", "id", true, "id to use for server in" + " the server status endpoint and logging");
         return options;
     }
@@ -69,7 +67,7 @@ public static void main(String[] args) {
     private static void usage(Options options) throws IOException {
         HelpFormatter helpFormatter = HelpFormatter.builder().get();
         helpFormatter.printHelp("tikaserver", null, options, null, true);
-        System.exit(-1);
+        System.exit(0);
     }
 
 }

tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerConfig.java

@@ -39,7 +39,6 @@ public class TikaServerConfig {
 
     public static final int DEFAULT_PORT = 9998;
     public static final String DEFAULT_HOST = "localhost";
-    public static final Set<String> LOG_LEVELS = new HashSet<>(Arrays.asList("debug", "info"));
     private static final Logger LOG = LoggerFactory.getLogger(TikaServerConfig.class);
     /**
      * Endpoints that expose the pipes/fetch machinery (process-isolated pipes
@@ -75,8 +74,7 @@ public class TikaServerConfig {
             .toString();
     private int port = DEFAULT_PORT;
     private String host = DEFAULT_HOST;
-    //debug or info only
-    private String logLevel = "";
+    private String requestLogLevel = "";
     private Path configPath;
     private ArrayList<String> endpoints = new ArrayList<>();
 
@@ -93,7 +91,6 @@ public static TikaServerConfig load(CommandLine commandLine) throws IOException,
 
         TikaServerConfig config = null;
         Set<String> settings = new HashSet<>();
-        Path pluginsConfig = null;
 
         if (commandLine.hasOption("c")) {
             config = load(Paths.get(commandLine.getOptionValue("c")), commandLine, settings);
@@ -201,15 +198,19 @@ public void setHost(String host) {
         this.host = host;
     }
 
-    public String getLogLevel() {
-        return logLevel;
+    /**
+     * Severity at which each request URI is logged. Empty (the default) disables
+     * request logging entirely; this does not change the log level of anything else.
+     */
+    public String getRequestLogLevel() {
+        return requestLogLevel;
     }
 
-    public void setLogLevel(String level) throws TikaConfigException {
+    public void setRequestLogLevel(String level) throws TikaConfigException {
         if (level.equals("debug") || level.equals("info")) {
-            this.logLevel = level;
+            this.requestLogLevel = level;
         } else {
-            throw new TikaConfigException("log level must be one of: 'debug' or 'info'");
+            throw new TikaConfigException("requestLogLevel must be one of: 'debug' or 'info'");
         }
     }
 

tika-server/tika-server-core/src/main/java/org/apache/tika/server/core/TikaServerProcess.java

@@ -22,14 +22,11 @@
 import java.nio.file.Path;
 import java.security.GeneralSecurityException;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.CommandLineParser;
@@ -100,7 +97,6 @@
 public class TikaServerProcess {
 
 
-    public static final Set<String> LOG_LEVELS = new HashSet<>(Arrays.asList("debug", "info"));
     public static final int BIND_EXCEPTION = 42;
     private static final Logger LOG = LoggerFactory.getLogger(TikaServerProcess.class);
     public static int DO_NOT_RESTART_EXIT_VALUE = -100;
@@ -110,7 +106,6 @@ private static Options getOptions() {
         options.addOption("h", "host", true, "host name, use * for all)");
         options.addOption("p", "port", true, "listen port");
         options.addOption("c", "config", true, "Tika Configuration xml file to override default config with.");
-        options.addOption("a", "pluginsConfig", true, "Tika Configuration json for pluginscomponents");
         options.addOption("i", "id", true, "id to use for server in server status endpoint");
         options.addOption("?", "help", false, "this help message");
         return options;
@@ -316,16 +311,12 @@ private static void loadAllProviders(TikaServerConfig tikaServerConfig, ServerSt
         // Add ConfigEndpointSecurityFilter to gate /config endpoints
         writers.add(new ConfigEndpointSecurityFilter(tikaServerConfig.isAllowPerRequestConfig()));
 
+        // setRequestLogLevel rejects anything but debug/info, so no validation needed here.
         TikaLoggingFilter logFilter = null;
-        if (!StringUtils.isBlank(tikaServerConfig.getLogLevel())) {
-            String logLevel = tikaServerConfig.getLogLevel();
-            if (LOG_LEVELS.contains(logLevel)) {
-                boolean isInfoLevel = "info".equals(logLevel);
-                logFilter = new TikaLoggingFilter(isInfoLevel);
-                writers.add(logFilter);
-            } else {
-                LOG.warn("Unsupported request URI log level: {}", logLevel);
-            }
+        String requestLogLevel = tikaServerConfig.getRequestLogLevel();
+        if (!StringUtils.isBlank(requestLogLevel)) {
+            logFilter = new TikaLoggingFilter("info".equals(requestLogLevel));
+            writers.add(logFilter);
         }
 
         CrossOriginResourceSharingFilter corsFilter = null;