All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.solr.handler.admin.SystemInfoHandler Maven / Gradle / Ivy

Go to download

Apache Solr (module: core)

There is a newer version: 9.7.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.solr.handler.admin;

import static org.apache.solr.common.params.CommonParams.NAME;

import com.codahale.metrics.Gauge;
import java.io.File;
import java.io.IOException;
import java.lang.invoke.MethodHandles;
import java.lang.management.ManagementFactory;
import java.lang.management.OperatingSystemMXBean;
import java.lang.management.RuntimeMXBean;
import java.net.InetAddress;
import java.text.DecimalFormat;
import java.text.DecimalFormatSymbols;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.lucene.util.Version;
import org.apache.solr.api.AnnotatedApi;
import org.apache.solr.api.Api;
import org.apache.solr.common.cloud.ZkStateReader;
import org.apache.solr.common.util.SimpleOrderedMap;
import org.apache.solr.core.CoreContainer;
import org.apache.solr.core.NodeConfig;
import org.apache.solr.core.SolrCore;
import org.apache.solr.handler.RequestHandlerBase;
import org.apache.solr.handler.admin.api.NodeSystemInfoAPI;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.schema.IndexSchema;
import org.apache.solr.security.AuthorizationContext;
import org.apache.solr.security.AuthorizationPlugin;
import org.apache.solr.security.PKIAuthenticationPlugin;
import org.apache.solr.security.RuleBasedAuthorizationPluginBase;
import org.apache.solr.util.RTimer;
import org.apache.solr.util.stats.MetricUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This handler returns system info
 *
 * @since solr 1.2
 */
public class SystemInfoHandler extends RequestHandlerBase {
  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

  /**
   * Undocumented expert level system property to prevent doing a reverse lookup of our hostname.
   * This property will be logged as a suggested workaround if any problems are noticed when doing
   * reverse lookup.
   *
   * 
TODO: should we refactor this (and the associated logic) into a helper method for any other
   * places where DNS is used?
   *
   * @see #initHostname
   */
  private static final String PREVENT_REVERSE_DNS_OF_LOCALHOST_SYSPROP =
      "solr.dns.prevent.reverse.lookup";

  // on some platforms, resolving canonical hostname can cause the thread
  // to block for several seconds if nameservices aren't available
  // so resolve this once per handler instance
  // (ie: not static, so core reload will refresh)
  private String hostname = null;

  private CoreContainer cc;

  public SystemInfoHandler() {
    this(null);
  }

  public SystemInfoHandler(CoreContainer cc) {
    super();
    this.cc = cc;
    initHostname();
  }

  private void initHostname() {
    if (null != System.getProperty(PREVENT_REVERSE_DNS_OF_LOCALHOST_SYSPROP, null)) {
      log.info(
          "Resolving canonical hostname for local host prevented due to '{}' sysprop",
          PREVENT_REVERSE_DNS_OF_LOCALHOST_SYSPROP);
      hostname = null;
      return;
    }

    RTimer timer = new RTimer();
    try {
      InetAddress addr = InetAddress.getLocalHost();
      hostname = addr.getCanonicalHostName();
    } catch (Exception e) {
      log.warn(
          "Unable to resolve canonical hostname for local host, possible DNS misconfiguration. SET THE '{}' {}",
          PREVENT_REVERSE_DNS_OF_LOCALHOST_SYSPROP,
          " sysprop to true on startup to prevent future lookups if DNS can not be fixed.",
          e);
      hostname = null;
      return;
    }
    timer.stop();

    if (15000D < timer.getTime()) {
      String readableTime = String.format(Locale.ROOT, "%.3f", (timer.getTime() / 1000));
      log.warn(
          "Resolving canonical hostname for local host took {} seconds, possible DNS misconfiguration. Set the '{}' {}",
          readableTime,
          PREVENT_REVERSE_DNS_OF_LOCALHOST_SYSPROP,
          " sysprop to true on startup to prevent future lookups if DNS can not be fixed.");
    }
  }

  @Override
  public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throws Exception {
    rsp.setHttpCaching(false);
    SolrCore core = req.getCore();
    if (AdminHandlersProxy.maybeProxyToNodes(req, rsp, getCoreContainer(req))) {
      return; // Request was proxied to other node
    }
    if (core != null) rsp.add("core", getCoreInfo(core, req.getSchema()));
    boolean solrCloudMode = getCoreContainer(req).isZooKeeperAware();
    rsp.add("mode", solrCloudMode ? "solrcloud" : "std");
    if (solrCloudMode) {
      rsp.add("zkHost", getCoreContainer(req).getZkController().getZkServerAddress());
    }
    if (cc != null) {
      rsp.add("solr_home", cc.getSolrHome());
      rsp.add("core_root", cc.getCoreRootDirectory().toString());
    }

    rsp.add("lucene", getLuceneInfo());
    NodeConfig nodeConfig = getCoreContainer(req).getNodeConfig();
    rsp.add("jvm", getJvmInfo(nodeConfig));
    rsp.add("security", getSecurityInfo(req));
    rsp.add("system", getSystemInfo());
    if (solrCloudMode) {
      rsp.add("node", getCoreContainer(req).getZkController().getNodeName());
    }
    SolrEnvironment env =
        SolrEnvironment.getFromSyspropOrClusterprop(
            solrCloudMode ? getCoreContainer(req).getZkController().zkStateReader : null);
    if (env.isDefined()) {
      rsp.add("environment", env.getCode());
      if (env.getLabel() != null) {
        rsp.add("environment_label", env.getLabel());
      }
      if (env.getColor() != null) {
        rsp.add("environment_color", env.getColor());
      }
    }
  }

  private CoreContainer getCoreContainer(SolrQueryRequest req) {
    CoreContainer coreContainer = req.getCoreContainer();
    return coreContainer == null ? cc : coreContainer;
  }

  /** Get system info */
  private SimpleOrderedMap getCoreInfo(SolrCore core, IndexSchema schema) {
    SimpleOrderedMap info = new SimpleOrderedMap<>();

    info.add("schema", schema != null ? schema.getSchemaName() : "no schema!");

    // Host
    info.add("host", hostname);

    // Now
    info.add("now", new Date());

    // Start Time
    info.add("start", core.getStartTimeStamp());

    // Solr Home
    SimpleOrderedMap dirs = new SimpleOrderedMap<>();
    dirs.add("cwd", new File(System.getProperty("user.dir")).getAbsolutePath());
    dirs.add("instance", core.getInstancePath().toString());
    try {
      dirs.add("data", core.getDirectoryFactory().normalize(core.getDataDir()));
    } catch (IOException e) {
      log.warn("Problem getting the normalized data directory path", e);
      dirs.add("data", "N/A");
    }
    dirs.add("dirimpl", core.getDirectoryFactory().getClass().getName());
    try {
      dirs.add("index", core.getDirectoryFactory().normalize(core.getIndexDir()));
    } catch (IOException e) {
      log.warn("Problem getting the normalized index directory path", e);
      dirs.add("index", "N/A");
    }
    info.add("directory", dirs);
    return info;
  }

  /** Get system info */
  public static SimpleOrderedMap getSystemInfo() {
    SimpleOrderedMap info = new SimpleOrderedMap<>();

    OperatingSystemMXBean os = ManagementFactory.getOperatingSystemMXBean();
    info.add(NAME, os.getName()); // add at least this one
    // add remaining ones dynamically using Java Beans API
    // also those from JVM implementation-specific classes
    MetricUtils.addMXBeanMetrics(
        os,
        MetricUtils.OS_MXBEAN_CLASSES,
        null,
        (name, metric) -> {
          if (info.get(name) == null) {
            info.add(name, ((Gauge) metric).getValue());
          }
        });

    return info;
  }

  /** Get JVM Info - including memory info */
  public static SimpleOrderedMap getJvmInfo(NodeConfig nodeConfig) {
    SimpleOrderedMap jvm = new SimpleOrderedMap<>();

    final String javaVersion = System.getProperty("java.specification.version", "unknown");
    final String javaVendor = System.getProperty("java.specification.vendor", "unknown");
    final String javaName = System.getProperty("java.specification.name", "unknown");
    final String jreVersion = System.getProperty("java.version", "unknown");
    final String jreVendor = System.getProperty("java.vendor", "unknown");
    final String vmVersion = System.getProperty("java.vm.version", "unknown");
    final String vmVendor = System.getProperty("java.vm.vendor", "unknown");
    final String vmName = System.getProperty("java.vm.name", "unknown");

    // Summary Info
    jvm.add("version", jreVersion + " " + vmVersion);
    jvm.add(NAME, jreVendor + " " + vmName);

    // details
    SimpleOrderedMap java = new SimpleOrderedMap<>();
    java.add("vendor", javaVendor);
    java.add(NAME, javaName);
    java.add("version", javaVersion);
    jvm.add("spec", java);
    SimpleOrderedMap jre = new SimpleOrderedMap<>();
    jre.add("vendor", jreVendor);
    jre.add("version", jreVersion);
    jvm.add("jre", jre);
    SimpleOrderedMap vm = new SimpleOrderedMap<>();
    vm.add("vendor", vmVendor);
    vm.add(NAME, vmName);
    vm.add("version", vmVersion);
    jvm.add("vm", vm);

    Runtime runtime = Runtime.getRuntime();
    jvm.add("processors", runtime.availableProcessors());

    // not thread safe, but could be thread local
    DecimalFormat df = new DecimalFormat("#.#", DecimalFormatSymbols.getInstance(Locale.ROOT));

    SimpleOrderedMap mem = new SimpleOrderedMap<>();
    SimpleOrderedMap raw = new SimpleOrderedMap<>();
    long free = runtime.freeMemory();
    long max = runtime.maxMemory();
    long total = runtime.totalMemory();
    long used = total - free;
    double percentUsed = ((double) (used) / (double) max) * 100;
    raw.add("free", free);
    mem.add("free", humanReadableUnits(free, df));
    raw.add("total", total);
    mem.add("total", humanReadableUnits(total, df));
    raw.add("max", max);
    mem.add("max", humanReadableUnits(max, df));
    raw.add("used", used);
    mem.add("used", humanReadableUnits(used, df) + " (%" + df.format(percentUsed) + ")");
    raw.add("used%", percentUsed);

    mem.add("raw", raw);
    jvm.add("memory", mem);

    // JMX properties -- probably should be moved to a different handler
    SimpleOrderedMap jmx = new SimpleOrderedMap<>();
    try {
      RuntimeMXBean mx = ManagementFactory.getRuntimeMXBean();
      if (mx.isBootClassPathSupported()) {
        jmx.add("bootclasspath", mx.getBootClassPath());
      }
      jmx.add("classpath", mx.getClassPath());

      // the input arguments passed to the Java virtual machine
      // which does not include the arguments to the main method.
      jmx.add("commandLineArgs", getInputArgumentsRedacted(nodeConfig, mx));

      jmx.add("startTime", new Date(mx.getStartTime()));
      jmx.add("upTimeMS", mx.getUptime());

    } catch (Exception e) {
      log.warn("Error getting JMX properties", e);
    }
    jvm.add("jmx", jmx);
    return jvm;
  }

  /** Get Security Info */
  public SimpleOrderedMap getSecurityInfo(SolrQueryRequest req) {
    SimpleOrderedMap info = new SimpleOrderedMap<>();

    if (cc != null) {
      if (cc.getAuthenticationPlugin() != null) {
        info.add("authenticationPlugin", cc.getAuthenticationPlugin().getName());
      }
      if (cc.getAuthorizationPlugin() != null) {
        info.add("authorizationPlugin", cc.getAuthorizationPlugin().getClass().getName());
      }
    }

    if (req.getUserPrincipal() != null
        && req.getUserPrincipal() != PKIAuthenticationPlugin.CLUSTER_MEMBER_NODE) {
      // User principal
      info.add("username", req.getUserPrincipal().getName());

      // Mapped roles for this principal
      @SuppressWarnings("resource")
      AuthorizationPlugin auth = cc == null ? null : cc.getAuthorizationPlugin();
      if (auth instanceof RuleBasedAuthorizationPluginBase) {
        RuleBasedAuthorizationPluginBase rbap = (RuleBasedAuthorizationPluginBase) auth;
        Set roles = rbap.getUserRoles(req.getUserPrincipal());
        info.add("roles", roles);
        if (roles == null) {
          info.add("permissions", Set.of());
        } else {
          info.add(
              "permissions",
              rbap.getPermissionNamesForRoles(
                  Stream.concat(roles.stream(), Stream.of("*", null)).collect(Collectors.toSet())));
        }
      }
    }

    if (cc != null && cc.getZkController() != null) {
      String urlScheme =
          cc.getZkController().zkStateReader.getClusterProperty(ZkStateReader.URL_SCHEME, "http");
      info.add("tls", ZkStateReader.HTTPS.equals(urlScheme));
    }

    return info;
  }

  private static SimpleOrderedMap getLuceneInfo() {
    SimpleOrderedMap info = new SimpleOrderedMap<>();

    Package p = SolrCore.class.getPackage();

    info.add("solr-spec-version", p.getSpecificationVersion());
    info.add("solr-impl-version", p.getImplementationVersion());

    info.add("lucene-spec-version", Version.LATEST.toString());
    info.add("lucene-impl-version", Version.getPackageImplementationVersion());

    return info;
  }

  //////////////////////// SolrInfoMBeans methods //////////////////////

  @Override
  public String getDescription() {
    return "Get System Info";
  }

  @Override
  public Category getCategory() {
    return Category.ADMIN;
  }

  private static final long ONE_KB = 1024;
  private static final long ONE_MB = ONE_KB * ONE_KB;
  private static final long ONE_GB = ONE_KB * ONE_MB;

  /** Return good default units based on byte size. */
  private static String humanReadableUnits(long bytes, DecimalFormat df) {
    String newSizeAndUnits;

    if (bytes / ONE_GB > 0) {
      newSizeAndUnits = String.valueOf(df.format((float) bytes / ONE_GB)) + " GB";
    } else if (bytes / ONE_MB > 0) {
      newSizeAndUnits = String.valueOf(df.format((float) bytes / ONE_MB)) + " MB";
    } else if (bytes / ONE_KB > 0) {
      newSizeAndUnits = String.valueOf(df.format((float) bytes / ONE_KB)) + " KB";
    } else {
      newSizeAndUnits = String.valueOf(bytes) + " bytes";
    }

    return newSizeAndUnits;
  }

  private static List getInputArgumentsRedacted(NodeConfig nodeConfig, RuntimeMXBean mx) {
    List list = new ArrayList<>();
    for (String arg : mx.getInputArguments()) {
      if (arg.startsWith("-D")
          && arg.contains("=")
          && nodeConfig.isSysPropHidden(arg.substring(2, arg.indexOf('=')))) {
        list.add(
            String.format(
                Locale.ROOT,
                "%s=%s",
                arg.substring(0, arg.indexOf('=')),
                NodeConfig.REDACTED_SYS_PROP_VALUE));
      } else {
        list.add(arg);
      }
    }
    return list;
  }

  @Override
  public Collection getApis() {
    return AnnotatedApi.getApis(new NodeSystemInfoAPI(this));
  }

  @Override
  public Boolean registerV2() {
    return Boolean.TRUE;
  }

  @Override
  public Name getPermissionName(AuthorizationContext request) {
    return Name.CONFIG_READ_PERM;
  }
}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy