gorm.tools.utils.BenchmarkHelper.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gorm-tools Show documentation
gorm-tools core
There is a newer version: 7.3.74
/*
* Copyright 2022 Yak.Works - Licensed under the Apache License, Version 2.0 (the "License")
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*/
package gorm.tools.utils

import java.text.DecimalFormat

import groovy.transform.CompileStatic

@CompileStatic
@SuppressWarnings(['Println']) //for now
class BenchmarkHelper {

    private static final ThreadLocal START_TIME_HOLDER = new ThreadLocal()

    static void printMemory(){
        int mb = 1024*1024;

        //Getting the runtime reference from system
        Runtime runtime = Runtime.getRuntime();

        println("---- Heap utilization statistics [MB] -----")

        //Print used memory
        println("Used Memory:" + (runtime.totalMemory() - runtime.freeMemory()) / mb)

        //Print free memory
        println("Free Memory:" + runtime.freeMemory() / mb)

        //Print total available memory
        println("Total Memory:" + runtime.totalMemory() / mb)

        //Print Maximum available memory
        println("Max Memory:" + runtime.maxMemory() / mb)
    }

    static void printUsedMem(){
        int mb = 1024*1024;

        //Getting the runtime reference from system
        Runtime runtime = Runtime.getRuntime();
        //Print used memory
        println("Used Memory:" + (runtime.totalMemory() - runtime.freeMemory()) / mb)
    }

    /**
     * returns the currentTimeMillis and sets it in a ThreadLocal so ti can be used in endTime if not passed
     */
    static Long startTime(){
        Long startTime = System.currentTimeMillis()
        START_TIME_HOLDER.set(startTime)
        return startTime
    }

    /**
     * clears the START_TIME_HOLDER thread local
     *
     * @param msg the message to append the calced time to
     * @param startTime optional if startTime()
     * @return the mesage
     */
    static String endTimeMsg(String msg, Long startTime = null){
        if(startTime == null) startTime = START_TIME_HOLDER.get()
        DecimalFormat decFmt = new DecimalFormat("0.0")
        BigDecimal endTime = (System.currentTimeMillis() - startTime) / 1000
        String timing = "${decFmt.format(endTime)}s"
        START_TIME_HOLDER.remove()
        return "$msg -- $timing"
    }

    /**
     * does a println with endTimeMsg. Quick way to get message but not recomended in produciton code
     * recomended to wrap endTimeMsg in log.debug or other logger
     * example:
     *   BenchmarkHelper.startTime()
     *   log.debug( BenchmarkHelper.endTimeMsg("foo completed in ) )
     */
    static String printEndTimeMsg(String msg, Long startTime = null){
        def emsg = endTimeMsg(msg, startTime)
        println emsg
        return emsg
    }

    /**
     * formatted elapsed time from startTime to now in seconds
     */
    static String elapsedTime(Long startTime){
        BigDecimal endTime = (System.currentTimeMillis() - startTime) / 1000
        return new DecimalFormat("#0.0s").format(endTime)
    }

    /**
     * format used mem in GB
     */
    static String getUsedMem(){
        int gb = 1024*1024*1024;

        //Getting the runtime reference from system
        Runtime runtime = Runtime.getRuntime()
        BigDecimal mem = (runtime.totalMemory() - runtime.freeMemory()) / gb
        return new DecimalFormat("#0.0GB").format(mem)
    }
}