public class ReporterConfig extends Object
Reporter.
This class exposes a set of flags that determine which aspects of the runtime environment are included in a system report. These reports are typically used for diagnostics, debugging, or logging system context information at startup or during runtime.
These properties should ideally be defined before invoking any method from this library, to ensure consistent behavior. Some properties can be modified dynamically at runtime, although care should be taken in concurrent environments.
Security note: Some values retrieved from the environment (e.g., system properties, user information) may contain sensitive data. Consider sanitizing reports if logs are shared externally.
This class is a utility holder and should not be instantiated.
* @author Daniel Felix Ferber
| Modifier and Type | Field and Description |
|---|---|
String |
name
Defines the default name used for generated reports.
|
String |
PROP_CALENDAR |
String |
PROP_CHARSET |
String |
PROP_DEFAULT_TRUST_KEYSTORE |
String |
PROP_ENVIRONMENT |
String |
PROP_FILE_SYSTEM |
String |
PROP_LOCALE |
String |
PROP_MEMORY |
String |
PROP_NAME |
String |
PROP_NETWORK_INTERFACE |
String |
PROP_OPERATING_SYSTEM |
String |
PROP_PHYSICAL_SYSTEM |
String |
PROP_PROPERTIES |
String |
PROP_SSL_CONTEXT |
String |
PROP_USER |
String |
PROP_VM |
boolean |
reportCalendar
Whether the default report includes calendar, date, time, and timezone information.
|
boolean |
reportCharset
Whether the default report includes current and available character sets.
|
boolean |
reportDefaultTrustKeyStore
Whether the default report includes information about the default trusted keystore.
|
boolean |
reportEnvironment
Whether the default report includes environment variables.
|
boolean |
reportFileSystem
Whether the default report includes information about available and used disk space.
|
boolean |
reportLocale
Whether the default report includes current and available locales.
|
boolean |
reportMemory
Whether the default report includes memory usage information.
|
boolean |
reportNetworkInterface
Whether the default report includes network interface information.
|
boolean |
reportOperatingSystem
Whether the default report includes operating system information.
|
boolean |
reportPhysicalSystem
Whether the default report includes physical machine information.
|
boolean |
reportProperties
Whether the default report includes system properties.
|
boolean |
reportSSLContext
Whether the default report includes SSL context information.
|
boolean |
reportUser
Whether the default report includes current user information.
|
boolean |
reportVM
Whether the default report includes JVM information.
|
| Constructor and Description |
|---|
ReporterConfig() |
| Modifier and Type | Method and Description |
|---|---|
void |
init()
Initializes the configuration attributes by reading the corresponding system properties.
|
public final String PROP_VM
public final String PROP_FILE_SYSTEM
public final String PROP_MEMORY
public final String PROP_USER
public final String PROP_PROPERTIES
public final String PROP_ENVIRONMENT
public final String PROP_PHYSICAL_SYSTEM
public final String PROP_OPERATING_SYSTEM
public final String PROP_CALENDAR
public final String PROP_LOCALE
public final String PROP_CHARSET
public final String PROP_NETWORK_INTERFACE
public final String PROP_SSL_CONTEXT
public final String PROP_DEFAULT_TRUST_KEYSTORE
public final String PROP_NAME
public boolean reportVM
Controlled by the system property slf4jtoys.report.vm. Defaults to true. May be changed at
runtime.
public boolean reportFileSystem
Controlled by the system property slf4jtoys.report.fileSystem. Defaults to false. May be changed
at runtime.
public boolean reportMemory
Controlled by the system property slf4jtoys.report.memory. Defaults to true. May be changed at
runtime.
public boolean reportUser
Controlled by the system property slf4jtoys.report.user. Defaults to true. May be changed at
runtime.
public boolean reportProperties
Controlled by the system property slf4jtoys.report.properties. Defaults to true. May be changed
at runtime.
public boolean reportEnvironment
Controlled by the system property slf4jtoys.report.environment. Defaults to false. May be changed
at runtime.
public boolean reportPhysicalSystem
Controlled by the system property slf4jtoys.report.physicalSystem. Defaults to true. May be
changed at runtime.
public boolean reportOperatingSystem
Controlled by the system property slf4jtoys.report.operatingSystem. Defaults to true. May be
changed at runtime.
public boolean reportCalendar
Controlled by the system property slf4jtoys.report.calendar. Defaults to true. May be changed at
runtime.
public boolean reportLocale
Controlled by the system property slf4jtoys.report.locale. Defaults to true. May be changed at
runtime.
public boolean reportCharset
Controlled by the system property slf4jtoys.report.charset. Defaults to true. May be changed at
runtime.
public boolean reportNetworkInterface
This operation may block the thread for a significant amount of time. Controlled by the system property
slf4jtoys.report.networkInterface. Defaults to false. May be changed at runtime.
public boolean reportSSLContext
Controlled by the system property slf4jtoys.report.SSLContext. Defaults to false. May be changed
at runtime.
public boolean reportDefaultTrustKeyStore
Controlled by the system property slf4jtoys.report.defaultTrustKeyStore. Defaults to false. May
be changed at runtime.
public String name
Controlled by the system property slf4jtoys.report.name. Defaults to "report". May be changed at
runtime.
Copyright © 2010–2025. All rights reserved.