SOLR-17638 Some CLI errors not logged when starting prometheus exporter

Author: stillalex

solr/CHANGES.txt

@@ -213,6 +213,8 @@ Bug Fixes
   occur at the same time. (Houston Putman)
 
 
+* SOLR-17638: Some CLI errors not logged when starting prometheus exporter (Alex Deparvu)
+
 Dependency Upgrades
 ---------------------
 * SOLR-17471: Upgrade Lucene to 9.12.1. (Pierre Salagnac, Christine Poerschke)

solr/packaging/test/bats_helper.bash

@@ -64,7 +64,9 @@ shutdown_all() {
 
 shutdown_exporter(){
   EXPORTER_PID=$(ps auxww | grep org.apache.solr.prometheus.exporter.SolrExporter | awk "/-classpath/"' {print $2}' | sort -r)
-  kill -9 $EXPORTER_PID
+  if [[ -n $EXPORTER_PID ]]; then
+    kill -9 $EXPORTER_PID
+  fi
 }
 
 delete_all_collections() {

solr/packaging/test/test_prometheus.bats

@@ -48,3 +48,9 @@ teardown() {
   assert_output --partial 'core="COLL_NAME"'
   assert_output --partial 'bats-test'
 }
+
+@test "unrecognized option logging" {
+  run ! solr-exporter --unknown-option unknown-option
+
+  assert_output --partial 'Unrecognized option: --unknown-option'
+}

solr/prometheus-exporter/src/java/org/apache/solr/prometheus/exporter/SolrExporter.java

@@ -22,6 +22,7 @@
 import java.lang.invoke.MethodHandles;
 import java.net.InetSocketAddress;
 import java.nio.file.Paths;
+import java.util.Locale;
 import java.util.concurrent.ExecutorService;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.CommandLineParser;
@@ -31,9 +32,11 @@
 import org.apache.commons.cli.Options;
 import org.apache.commons.cli.ParseException;
 import org.apache.commons.codec.digest.DigestUtils;
+import org.apache.solr.common.util.EnvUtils;
 import org.apache.solr.common.util.ExecutorUtil;
 import org.apache.solr.common.util.IOUtils;
 import org.apache.solr.common.util.SolrNamedThreadFactory;
+import org.apache.solr.common.util.SuppressForbidden;
 import org.apache.solr.prometheus.collector.MetricsCollectorFactory;
 import org.apache.solr.prometheus.collector.SchedulerMetricsCollector;
 import org.apache.solr.prometheus.scraper.SolrCloudScraper;
@@ -47,8 +50,7 @@ public class SolrExporter {
   private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
   private static final int DEFAULT_PORT = 8989;
-  private static final String DEFAULT_BASE_URL = "http://localhost:8983/solr";
-  private static final String DEFAULT_ZK_HOST = "";
+  private static final String DEFAULT_BASE_URL = getDefaultSolrUrl();
   private static final String DEFAULT_CONFIG = "solr-exporter-config.xml";
   private static final int DEFAULT_SCRAPE_INTERVAL = 60;
   private static final Integer DEFAULT_NUM_THREADS = 1;
@@ -138,17 +140,20 @@ private SolrScraper createScraper(
     }
   }
 
+  @SuppressForbidden(reason = "For use in command line tools only")
   public static void main(String[] args) {
     Options mainOptions = new Options();
 
     Option solrUrlOption =
         Option.builder("s")
             .longOpt("solr-url")
             .hasArg()
-            .argName("BASE_URL")
+            .argName("HOST")
             .type(String.class)
             .desc(
-                "Specify the Solr base URL when connecting to Solr in standalone mode. If omitted both the -b parameter and the -z parameter, connect to http://localhost:8983/solr. For example 'http://localhost:8983/solr'.")
+                "Specify the Solr base URL when connecting to Solr in standalone mode. If omitted both the -s parameter and the -z parameter, connect to "
+                    + DEFAULT_BASE_URL
+                    + ".")
             .build();
     mainOptions.addOption(solrUrlOption);
 
@@ -241,7 +246,9 @@ public static void main(String[] args) {
             .argName("ZK_HOST")
             .type(String.class)
             .desc(
-                "Specify the ZooKeeper connection string when connecting to Solr in SolrCloud mode. If omitted both the -b parameter and the -z parameter, connect to http://localhost:8983/solr. For example 'localhost:2181/solr'.")
+                "Specify the ZooKeeper connection string when connecting to Solr in SolrCloud mode. If omitted both the -s parameter and the -z parameter, connect to "
+                    + DEFAULT_BASE_URL
+                    + ".")
             .build();
     mainOptions.addOption(zkHostOption);
 
@@ -259,24 +266,27 @@ public static void main(String[] args) {
         return;
       }
 
-      SolrScrapeConfiguration scrapeConfiguration = null;
-
-      String defaultClusterId = "";
-      if (commandLine.hasOption(zkHostOption)) {
-        String zkHost = commandLine.getOptionValue(zkHostOption, DEFAULT_ZK_HOST);
+      final SolrScrapeConfiguration scrapeConfiguration;
+      final String defaultClusterId;
+      String zkHost = getZkHost(commandLine, zkHostOption);
+      if (zkHost != null && !zkHost.isBlank()) {
         defaultClusterId = makeShortHash(zkHost);
         scrapeConfiguration = SolrScrapeConfiguration.solrCloud(zkHost);
       } else if (commandLine.hasOption(solrUrlOption)) {
         String baseUrl = commandLine.getOptionValue(solrUrlOption);
         defaultClusterId = makeShortHash(baseUrl);
         scrapeConfiguration = SolrScrapeConfiguration.standalone(baseUrl);
-      }
-
-      if (scrapeConfiguration == null) {
-        log.error(
-            "Must provide either --{} or --{}",
-            solrUrlOption.getLongOpt(),
-            zkHostOption.getLongOpt());
+      } else {
+        String baseUrl = DEFAULT_BASE_URL;
+        if (log.isInfoEnabled()) {
+          log.info(
+              "Neither --{} or --{} parameters provided so assuming solr url is {}",
+              solrUrlOption.getLongOpt(),
+              zkHostOption.getLongOpt(),
+              baseUrl);
+        }
+        defaultClusterId = makeShortHash(baseUrl);
+        scrapeConfiguration = SolrScrapeConfiguration.standalone(baseUrl);
       }
 
       int port = commandLine.getParsedOptionValue(portOption, DEFAULT_PORT);
@@ -321,9 +331,11 @@ public static void main(String[] args) {
           clusterId,
           scrapeConfiguration);
     } catch (IOException e) {
-      log.error("Failed to start Solr Prometheus Exporter: ", e);
+      System.err.println("Failed to start Solr Prometheus Exporter: " + e.getMessage());
+      exit(1);
     } catch (ParseException e) {
-      log.error("Failed to parse command line arguments: ", e);
+      System.err.println("Failed to parse command line arguments: " + e.getMessage());
+      exit(1);
     }
   }
 
@@ -349,4 +361,31 @@ private static MetricsConfiguration loadMetricsConfiguration(String configPath)
   private static String getSystemVariable(String name) {
     return System.getProperty(name, System.getenv(name));
   }
+
+  // copied over from CLIUtils
+  public static void exit(int exitStatus) {
+    try {
+      System.exit(exitStatus);
+    } catch (java.lang.SecurityException secExc) {
+      if (exitStatus != 0)
+        throw new RuntimeException("SolrExporter failed to exit with status " + exitStatus);
+    }
+  }
+
+  // copied over from CLIUtils
+  private static String getDefaultSolrUrl() {
+    // note that ENV_VAR syntax (and the env vars too) are mapped to env.var sys props
+    String scheme = EnvUtils.getProperty("solr.url.scheme", "http");
+    String host = EnvUtils.getProperty("solr.host", "localhost");
+    String port = EnvUtils.getProperty("jetty.port", "8983"); // from SOLR_PORT env
+    return String.format(Locale.ROOT, "%s://%s:%s", scheme.toLowerCase(Locale.ROOT), host, port);
+  }
+
+  public static String getZkHost(CommandLine cli, Option option) {
+    String zkHost = cli.getOptionValue(option);
+    if (zkHost != null && !zkHost.isBlank()) {
+      return zkHost;
+    }
+    return EnvUtils.getProperty("zkHost");
+  }
 }