org.usefultoys.slf4j.report

Class Reporter

java.lang.Object

org.usefultoys.slf4j.report.Reporter

All Implemented Interfaces:

Serializable

public class Reporter
extends Object
implements Serializable

Produces diagnostic reports about system resources and the current runtime environment.

Reports are logged as information-level messages using SLF4J. The set of reports to be generated is controlled by ReporterConfig, including which sections are enabled and the default logger name (unless overridden).

This is useful for troubleshooting or recording system configuration at application startup or runtime.

Author:

Daniel Felix Ferber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Executor	sameThreadExecutor An Executor that runs tasks synchronously on the current thread.

Constructor Summary

Constructors

Constructor and Description
Reporter() Creates a new Reporter using the logger defined by ReporterConfig.name.
Reporter(org.slf4j.Logger logger) Creates a new Reporter instance that logs messages to the specified Logger.

Method Summary

Modifier and Type	Method and Description
void	logDefaultReports(@NonNull Executor executor) Runs only the reports that are enabled in ReporterConfig and logs them as information-level messages.
static void	runDefaultReport() Runs the default report on the current thread using sameThreadExecutor.

Methods inherited from class java.lang.Object

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

Field Detail

sameThreadExecutor

public static final Executor sameThreadExecutor

An Executor that runs tasks synchronously on the current thread. Useful for environments where multithreading is restricted or undesired.

Constructor Detail

Reporter

public Reporter()

Creates a new Reporter using the logger defined by ReporterConfig.name.

Reporter

public Reporter(org.slf4j.Logger logger)

Creates a new Reporter instance that logs messages to the specified Logger.

Parameters:

logger - the SLF4J logger to use for reporting

Method Detail

runDefaultReport

public static void runDefaultReport()

Runs the default report on the current thread using sameThreadExecutor.

Intended for simple applications or environments where blocking the current thread is acceptable. May not be suitable for JavaEE or reactive environments that restrict long-running tasks on request threads.

logDefaultReports

public void logDefaultReports(@NonNull
                              @NonNull Executor executor)

Runs only the reports that are enabled in ReporterConfig and logs them as information-level messages.

Each enabled report is executed via the provided Executor.

Parameters:

executor - the executor used to run each report