SoulLogger/com.lestere.opensource.logger/SoulLoggerPluginConfiguration

SoulLoggerPluginConfiguration

class SoulLoggerPluginConfiguration(source)

Configuration for SoulLogger plugin with environment variable support and Mode-based defaults.

Configuration resolution order (later overrides earlier):

Mode defaults (DEVELOPMENT/PRODUCTION)
application.conf (soul.logger.*)
Environment variables (SOUL_LOGGER_*)
DSL configuration in code

Author

LesterE

Since

1.0.0

Constructors

SoulLoggerPluginConfiguration

constructor()

Types

AnalysisConfiguration

class AnalysisConfiguration

Configuration for log file analysis.

Companion

object Companion

FilterConfiguration

class FilterConfiguration

Configuration for log filtering and sampling.

HealthCheckConfiguration

class HealthCheckConfiguration

PerformanceConfiguration

class PerformanceConfiguration

Configuration for performance optimization.

ReflexConfiguration

class ReflexConfiguration

Configuration for log route reflex.

ReportGenerationConfiguration

class ReportGenerationConfiguration

Configuration for report generation.

RotationConfiguration

class RotationConfiguration

Configuration for log file rotation.

RuntimeManagementConfiguration

class RuntimeManagementConfiguration

StreamConfiguration

class StreamConfiguration

Configuration for log streaming.

Properties

analysis

var analysis: SoulLoggerPluginConfiguration.AnalysisConfiguration

Analysis configuration.

analysisOutputDictionary

val analysisOutputDictionary: String

Analysis output dictionary.

cacheRootDictionary

var cacheRootDictionary: String

Cache root directory for logs and reports. Config: soul.logger.path Env: SOUL_LOGGER_PATH

enableConsole

var enableConsole: Boolean

Whether to enable console output. Config: soul.logger.console Env: SOUL_LOGGER_ENABLE_CONSOLE

enableFile

var enableFile: Boolean

Whether to enable file output. Config: soul.logger.file Env: SOUL_LOGGER_ENABLE_FILE

enableIntrospection

var enableIntrospection: Boolean

Whether to enable introspection routes (analysis, reflex). Config: soul.logger.introspection Env: SOUL_LOGGER_ENABLE_INTROSPECTION

enableLogback

var enableLogback: Boolean

Whether to use Logback for log output. Config: soul.logger.logback Env: SOUL_LOGGER_ENABLE_LOGBACK

enableMasking

var enableMasking: Boolean

Whether to enable sensitive data masking. Config: soul.logger.masking Env: SOUL_LOGGER_ENABLE_MASKING

healthCheck

var healthCheck: SoulLoggerPluginConfiguration.HealthCheckConfiguration

Health check configuration. Config: soul.logger.health.* Env: SOUL_LOGGER_HEALTH_*

httpFilter

var httpFilter: (ApplicationCall) -> Boolean

Filter calls that should be logged (HTTP filter).

level

var level: SoulLogger.Level

Minimum log level to record. Config: soul.logger.level Env: SOUL_LOGGER_LEVEL

logbackConfigPath

var logbackConfigPath: String?

Custom Logback configuration file path. Config: soul.logger.logback-config Env: SOUL_LOGGER_LOGBACK_CONFIG_PATH

logDictionary

val logDictionary: String

Log dictionary path.

logFilter

var logFilter: SoulLoggerPluginConfiguration.FilterConfiguration

Filter configuration for log sampling. Config: soul.logger.filter.* Env: SOUL_LOGGER_FILTER_*

maskingStrategy

var maskingStrategy: CompositeMaskingStrategy

Masking strategy for sensitive data.

maxFileSize

var maxFileSize: Long

Maximum file size per log file. Default: 2MB Config: soul.logger.max-file-size Env: SOUL_LOGGER_MAX_FILE_SIZE

mode

var mode: ApplicationMode

Application runtime mode. Determines default behaviors. Config: soul.logger.mode Env: SOUL_LOGGER_MODE

outputFormat

var outputFormat: LogFormat

Log output format. Config: soul.logger.format Env: SOUL_LOGGER_FORMAT

performance

var performance: SoulLoggerPluginConfiguration.PerformanceConfiguration

Performance configuration. Config: soul.logger.performance.* Env: SOUL_LOGGER_PERFORMANCE_*

queueCapacity

var queueCapacity: Int

Async queue capacity. Config: soul.logger.queue-capacity Env: SOUL_LOGGER_QUEUE_CAPACITY

reflex

var reflex: SoulLoggerPluginConfiguration.ReflexConfiguration

Reflex (log file access) configuration.

report

var report: SoulLoggerPluginConfiguration.ReportGenerationConfiguration

Report generation configuration.

reportGenerationDict

val reportGenerationDict: String

Report generation dictionary.

rotation

var rotation: SoulLoggerPluginConfiguration.RotationConfiguration

Rotation configuration for log files. Config: soul.logger.rotation.* Env: SOUL_LOGGER_ROTATION_*

runtimeManagement

var runtimeManagement: SoulLoggerPluginConfiguration.RuntimeManagementConfiguration

Runtime management configuration. Config: soul.logger.runtime.* Env: SOUL_LOGGER_RUNTIME_*

stream

var stream: SoulLoggerPluginConfiguration.StreamConfiguration

Stream configuration.

Functions

loadFromConfig

fun loadFromConfig(config: ApplicationConfig)

Load configuration from Ktor ApplicationConfig. This method is called automatically during plugin setup.