org.usefultoys.slf4j.meter

Class MeterConfig

java.lang.Object

org.usefultoys.slf4j.meter.MeterConfig

public class MeterConfig
extends Object

Centralized configuration holder for controlling the behavior of the Meter and MeterData.

This class exposes a set of flags and properties that determine the behavior of meters, such as progress reporting, logging categories, and encoded data handling. These properties can be configured at application startup or modified dynamically at 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.

Performance note: Some properties, such as progress reporting intervals, may impact performance if configured with very low values.

This class is a utility holder and should not be instantiated.

Author:

Daniel Felix Ferber

Field Summary

Fields

Modifier and Type	Field and Description
String	dataPrefix Prefix added to the logger name used for encoded data messages.
String	dataSuffix Suffix added to the logger name used for encoded data messages.
String	messagePrefix Prefix added to the logger name used for human-readable messages.
String	messageSuffix Suffix added to the logger name used for human-readable messages.
boolean	printCategory Whether the meter includes the category in readable messages.
boolean	printLoad Whether the meter includes the CPU load in readable messages.
boolean	printMemory Whether the meter includes the memory load in readable messages.
boolean	printPosition Whether the meter includes the position (event counter) in readable messages.
boolean	printStatus Whether the meter includes the status in readable messages.
long	progressPeriodMilliseconds Time to wait before reporting the next progress status, in milliseconds.
String	PROP_DATA_PREFIX
String	PROP_DATA_SUFFIX
String	PROP_MESSAGE_PREFIX
String	PROP_MESSAGE_SUFFIX
String	PROP_PRINT_CATEGORY
String	PROP_PRINT_LOAD
String	PROP_PRINT_MEMORY
String	PROP_PRINT_POSITION
String	PROP_PRINT_STATUS
String	PROP_PROGRESS_PERIOD

Constructor Summary

Constructors

Constructor and Description
MeterConfig()

Method Summary

Modifier and Type	Method and Description
void	init() Initializes the configuration attributes by reading the corresponding system properties.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_MESSAGE_SUFFIX

public final String PROP_MESSAGE_SUFFIX

See Also:

Constant Field Values

PROP_MESSAGE_PREFIX

public final String PROP_MESSAGE_PREFIX

See Also:

Constant Field Values

PROP_DATA_SUFFIX

public final String PROP_DATA_SUFFIX

See Also:

Constant Field Values

PROP_DATA_PREFIX

public final String PROP_DATA_PREFIX

See Also:

Constant Field Values

PROP_PRINT_MEMORY

public final String PROP_PRINT_MEMORY

See Also:

Constant Field Values

PROP_PRINT_CATEGORY

public final String PROP_PRINT_CATEGORY

See Also:

Constant Field Values

PROP_PRINT_LOAD

public final String PROP_PRINT_LOAD

See Also:

Constant Field Values

PROP_PROGRESS_PERIOD

public final String PROP_PROGRESS_PERIOD

See Also:

Constant Field Values

PROP_PRINT_POSITION

public final String PROP_PRINT_POSITION

See Also:

Constant Field Values

PROP_PRINT_STATUS

public final String PROP_PRINT_STATUS

See Also:

Constant Field Values

progressPeriodMilliseconds

public long progressPeriodMilliseconds

Time to wait before reporting the next progress status, in milliseconds.

Value is read from system property slf4jtoys.meter.progress.period, defaulting to 2000 (2 seconds). The value can be suffixed with ms, s, m, or h.

You may assign a new value at runtime.

printCategory

public boolean printCategory

Whether the meter includes the category in readable messages.

Value is read from system property slf4jtoys.meter.print.category, defaulting to false.

You may assign a new value at runtime.

printStatus

public boolean printStatus

Whether the meter includes the status in readable messages.

Value is read from system property slf4jtoys.meter.print.status, defaulting to true.

You may assign a new value at runtime.

printPosition

public boolean printPosition

Whether the meter includes the position (event counter) in readable messages.

Value is read from system property slf4jtoys.meter.print.position, defaulting to false.

You may assign a new value at runtime.

printLoad

public boolean printLoad

Whether the meter includes the CPU load in readable messages.

Value is read from system property slf4jtoys.meter.print.load, defaulting to false.

You may assign a new value at runtime.

printMemory

public boolean printMemory

Whether the meter includes the memory load in readable messages.

Value is read from system property slf4jtoys.meter.print.memory, defaulting to false.

You may assign a new value at runtime.

dataPrefix

public String dataPrefix

Prefix added to the logger name used for encoded data messages.

By default, encoded and human-readable messages are written to the same logger. Setting a prefix allows directing encoded data to a different logger.

Example: with prefix data., a logger a.b.c.MyClass becomes data.a.b.c.MyClass for encoded data.

Value is read from system property slf4jtoys.meter.data.prefix, defaulting to an empty string.

dataSuffix

public String dataSuffix

Suffix added to the logger name used for encoded data messages.

By default, encoded and human-readable messages are written to the same logger. Setting a suffix allows directing encoded data to a different logger.

Example: with suffix .data, a logger a.b.c.MyClass becomes a.b.c.MyClass.data for encoded data.

Value is read from system property slf4jtoys.meter.data.suffix, defaulting to an empty string.

messagePrefix

public String messagePrefix

Prefix added to the logger name used for human-readable messages.

By default, encoded and human-readable messages are written to the same logger. Setting a prefix allows directing readable messages to a different logger.

Example: with prefix message., a logger a.b.c.MyClass becomes message.a.b.c.MyClass for readable messages.

Value is read from system property slf4jtoys.meter.message.prefix, defaulting to an empty string.

messageSuffix

public String messageSuffix

Suffix added to the logger name used for human-readable messages.

By default, encoded and human-readable messages are written to the same logger. Setting a suffix allows directing readable messages to a different logger.

Example: with suffix .message, a logger a.b.c.MyClass becomes a.b.c.MyClass.message for readable messages.

Value is read from system property slf4jtoys.meter.message.suffix, defaulting to an empty string.

Constructor Detail

MeterConfig

public MeterConfig()

Method Detail

init

public void init()

Initializes the configuration attributes by reading the corresponding system properties. This method should be called before accessing any configuration attributes to ensure they are properly initialized.