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

com.aspectran.daemon.command.builtins.SysInfoCommand Maven / Gradle / Ivy

There is a newer version: 8.1.5
Show newest version
/*
 * Copyright (c) 2008-2024 The Aspectran Project
 *
 * Licensed 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 com.aspectran.daemon.command.builtins;

import com.aspectran.core.context.resource.SiblingClassLoader;
import com.aspectran.daemon.command.AbstractCommand;
import com.aspectran.daemon.command.CommandParameters;
import com.aspectran.daemon.command.CommandRegistry;
import com.aspectran.daemon.command.CommandResult;
import com.aspectran.utils.StringUtils;
import com.aspectran.utils.annotation.jsr305.NonNull;

import java.io.File;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.management.ManagementFactory;
import java.lang.management.RuntimeMXBean;
import java.net.URL;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

public class SysInfoCommand extends AbstractCommand {

    private static final String NAMESPACE = "builtins";

    private static final String COMMAND_NAME = "sysinfo";

    private final CommandDescriptor descriptor = new CommandDescriptor();

    public SysInfoCommand(CommandRegistry registry) {
        super(registry);
    }

    @Override
    public CommandResult execute(CommandParameters parameters) {
        try  {
            Object[] args = parameters.getArguments();
            Writer writer = new StringWriter();
            PrintWriter printWriter = new PrintWriter(writer);
            Set done = new HashSet<>();
            if (args != null) {
                for (Object arg : args) {
                    if (!done.contains(arg)) {
                        if (!done.isEmpty()) {
                            printWriter.println();
                        }
                        if ("props".equals(arg)) {
                            printSysProperties(printWriter);
                        } else if ("cp".equals(arg)) {
                            printClasspath(printWriter);
                        } else if ("mem".equals(arg)) {
                            mem(false, printWriter);
                        } else if ("gc".equals(arg)) {
                            mem(true, printWriter);
                        }
                    }
                    done.add(arg);
                }
            }
            return success(writer.toString());
        } catch (Exception e) {
            return failed(e);
        }
    }

    private void printSysProperties(@NonNull PrintWriter printWriter) {
        printWriter.println("---------------------");
        printWriter.println("JVM system properties");
        printWriter.println("---------------------");
        for (Map.Entry entry : System.getProperties().entrySet()) {
            String value = entry.getValue() != null ? escape(entry.getValue().toString()) : null;
            printWriter.format("%s=%s", entry.getKey(), StringUtils.nullToEmpty(value)).println();
        }
    }

    private void printClasspath(@NonNull PrintWriter printWriter) {
        printWriter.println("-------------------------");
        printWriter.println("JVM classpath information");
        printWriter.println("-------------------------");
        RuntimeMXBean bean = ManagementFactory.getRuntimeMXBean();
        for (String line : StringUtils.split(bean.getClassPath(), File.pathSeparator)) {
            printWriter.println(line);
        }
        if (isServiceAvailable()) {
            ClassLoader classLoader = getDaemonService().getServiceClassLoader();
            if (classLoader instanceof SiblingClassLoader scl) {
                Enumeration urls = scl.getAllResources();
                while (urls.hasMoreElements()) {
                    URL url = urls.nextElement();
                    printWriter.println(url.toString());
                }
            }
        }
    }

    /**
     * Prints memory usage.
     * @param gc true if performing garbage collection; false otherwise
     */
    private void mem(boolean gc, @NonNull PrintWriter printWriter) {
        long max = Runtime.getRuntime().maxMemory();
        long total = Runtime.getRuntime().totalMemory();
        long free = Runtime.getRuntime().freeMemory();

        printWriter.println("------------------------------------");
        printWriter.println("Memory information about current JVM");
        printWriter.println("------------------------------------");
        printWriter.format("%-23s %12s", "Available memory", StringUtils.convertToHumanFriendlyByteSize(max)).println();
        printWriter.format("%-23s %12s", "Total memory", StringUtils.convertToHumanFriendlyByteSize(total)).println();
        printWriter.format("%-23s %12s", "Used memory", StringUtils.convertToHumanFriendlyByteSize(total - free)).println();

        if (gc) {
            // Let the finalizer finish its work and remove objects from its queue
            System.gc(); // asynchronous garbage collector might already run
            System.gc(); // to make sure it does a full gc call it twice
            System.runFinalization();
            try {
                Thread.sleep(100);
            } catch (InterruptedException e) {
                // do nothing
            }

            long after = Runtime.getRuntime().freeMemory();

            printWriter.format("%-23s %12s", "Free memory before GC", StringUtils.convertToHumanFriendlyByteSize(free)).println();
            printWriter.format("%-23s %12s", "Free memory after GC", StringUtils.convertToHumanFriendlyByteSize(after)).println();
            printWriter.format("%-23s %12s", "Memory gained with GC", StringUtils.convertToHumanFriendlyByteSize(after - free)).println();
        } else {
            printWriter.format("%-23s %12s", "Free memory", StringUtils.convertToHumanFriendlyByteSize(free)).println();
        }
        printWriter.println("------------------------------------");
    }

    @NonNull
    private String escape(@NonNull String s){
        return s.replace("\t", "\\t")
                .replace("\b", "\\b")
                .replace("\n", "\\n")
                .replace("\r", "\\r")
                .replace("\f", "\\f");
    }

    @Override
    public Descriptor getDescriptor() {
        return descriptor;
    }

    private static class CommandDescriptor implements Descriptor {

        @Override
        public String getNamespace() {
            return NAMESPACE;
        }

        @Override
        public String getName() {
            return COMMAND_NAME;
        }

        @Override
        @NonNull
        public String getDescription() {
            return "Prints current JVM runtime information";
        }

    }

}