Class ClazzStatistic

java.lang.Object

java.lang.Thread

clazzfish.monitor.util.Shutdowner

clazzfish.monitor.stat.ClazzStatistic

All Implemented Interfaces:

ClazzStatisticMBean, Shutdownable, Runnable

public class ClazzStatistic
extends Shutdowner
implements ClazzStatisticMBean

The ClazzStatistic collects classes and resources to find classes which are likely to be dead. At the end a little statistics is reported to a file 'clazzfish/a.b.MyMain/ClazzStatistic.csv' in the temp directory. If you want another directory or filename where this statistics should be stored you can use one of the system properties

1. clazzfish.dump.dir
2. clazzfish.statistics.file

Please use only one of this environment options.

As alternative you can set one of the two environment variables:

1. CLAZZFISH_STATISTICS_DIR
2. CLAZZFISH_STATISTICS_FILE

NOTE: If a system property like 'appname' is set which looks like a program name this property is used instead of the Main classname.

Since:

2.3 (25.11.24)

Author:

oboehm

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Method Summary

Modifier and Type	Method	Description
URI	exportCSV()	Exports the statistics of the collected classes to the default location.
URI	exportCSV(File csvFile)
URI	exportCSV(String filename)	Exports the statistics of the collected classes to the file with the given filename.
URI	exportCSV(URI uri)
SortedSet<ClazzRecord>	getAllClasses()
Set<URI>	getClasspathes()
URI	getExportURI()	Returns the URI where the statistic should be exported to.
static ClazzStatistic	getInstance()
SortedSet<ClazzRecord>	getStatistics()
void	importCSV(File csvFile)	Deprecated, for removal: This API element is subject to removal in a future version. use importCSV(URI) with csvFile.toURI() as parameter
void	importCSV(String filename)	Importes the statistics form the given filename or URI.
void	importCSV(URI csvURI)	Imports the statistics from the given URI.
void	logMe()	Prints the statistic as CSV to the log output.
void	registerMeAsMBean()
void	run()
String	toString()

Methods inherited from class clazzfish.monitor.util.Shutdowner

addMeAsShutdownHook, isShutdownHook, removeMeAsShutdownHook

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface clazzfish.monitor.util.Shutdownable

addMeAsShutdownHook, isShutdownHook, removeMeAsShutdownHook

Method Details

getInstance

public static ClazzStatistic getInstance()

registerMeAsMBean

public void registerMeAsMBean()

getAllClasses

public SortedSet<ClazzRecord> getAllClasses()

getStatistics

public SortedSet<ClazzRecord> getStatistics()

getClasspathes

public Set<URI> getClasspathes()

logMe

public void logMe()

Prints the statistic as CSV to the log output.

Specified by:

logMe in interface ClazzStatisticMBean

getExportURI

public URI getExportURI()

Description copied from interface: ClazzStatisticMBean

Returns the URI where the statistic should be exported to.

Specified by:

getExportURI in interface ClazzStatisticMBean

Returns:

export URI

exportCSV

public URI exportCSV()
              throws IOException

Description copied from interface: ClazzStatisticMBean

Exports the statistics of the collected classes to the default location.

Specified by:

exportCSV in interface ClazzStatisticMBean

Returns:

export file

Throws:

IOException - in case of I/O problems

exportCSV

public URI exportCSV(String filename)
              throws IOException

Description copied from interface: ClazzStatisticMBean

Exports the statistics of the collected classes to the file with the given filename.

Specified by:

exportCSV in interface ClazzStatisticMBean

Parameters:

filename - filename or URI, where the statistics should be exported to

Returns:

export URI

Throws:

IOException - in case of I/O problems

exportCSV

public URI exportCSV(File csvFile)
              throws IOException

Throws:

IOException

exportCSV

public URI exportCSV(URI uri)
              throws IOException

Throws:

IOException

importCSV

public void importCSV(String filename)

Importes the statistics form the given filename or URI.

Specified by:

importCSV in interface ClazzStatisticMBean

Parameters:

filename - filename or URI

Since:

2.7

importCSV

@Deprecated(forRemoval=true)
public void importCSV(File csvFile)

Deprecated, for removal: This API element is subject to removal in a future version.

use importCSV(URI) with csvFile.toURI() as parameter

Importes the statistics form the given file.

Parameters:

csvFile - import file

importCSV

public void importCSV(URI csvURI)

Imports the statistics from the given URI. With issue #26 an internal Map is now used to find a ClazzRecord. The speeds up the import by a factor of 5:

• import of 10,000 lines: 130 - 150 ms (old), 20 - 30 ms (now)
• import of 60,000 lines: 200 - 230 ms (old), 50 - 80 ms (now)

The times were measured on an MBP from 2020.

Parameters:

csvURI - URI where the statistic should be imported from

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

toString

public String toString()

Overrides:

toString in class Thread