Package org.logevents.observers.file

Class FilenameFormatter

java.lang.Object

org.logevents.observers.file.FilenameFormatter

public class FilenameFormatter
extends Object

Creates, parses and scans for file names matching a specified pattern, such as logs/%mdc{tenant:-common}/%date{YYYY-'w'WW}/%application-%EE.log, which would expand to logs/example.org/2020-W01/myapplication-Mon.log if the MDC variable "tenant" was "example.org" and the date 2019/12/30 (which was the first week of the year 2020).

The following conversion words are supported in the filename:

• %date: The date and time of the log event. Optionally supports a date formatting pattern from DateTimeFormatter.ofPattern(java.lang.String) e.g. %date{DD-MMM HH:mm:ss}. Default format is yyyy-MM-dd HH:mm:ss.SSS.
• %marker[{defaultValue}]: Marker (if any)
• %mdc{key:-default}: the specified MDC variable or default value if not set
• %application: The value of Configuration.getApplicationName()
• %node: The value of Configuration.getNodeName() ()}

Constructor Summary

Constructors

Constructor	Description
FilenameFormatter(String filenamePattern)
FilenameFormatter(String filenamePattern, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
List<String>	findFileNames()
String	format(LogEvent logEvent)
String	generateName(ZonedDateTime fileTime)
String	generateName(org.logevents.observers.file.FileInfo fileInfo)
org.logevents.observers.file.FileInfo	parse(String filename)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilenameFormatter

public FilenameFormatter(String filenamePattern)

FilenameFormatter

public FilenameFormatter(String filenamePattern,
                         Configuration configuration)

Method Detail

findFileNames

public List<String> findFileNames()

format

public String format(LogEvent logEvent)

generateName

public String generateName(org.logevents.observers.file.FileInfo fileInfo)

generateName

public String generateName(ZonedDateTime fileTime)

parse

public org.logevents.observers.file.FileInfo parse(String filename)

toString

public String toString()

Overrides:

toString in class Object