Class LogFiles

Session log files: naming, pruning, listing and parsing the format written by FileLoggerProvider.

Inheritance
object
LogFiles
Inherited Members
Namespace: Uniform.Matrix.Hosting
Assembly: Uniform.Matrix.Hosting.dll
Syntax
public static class LogFiles

Fields

| Edit this page View Source

DefaultName

Name of a program's session logs when it gives none.

Declaration
public const string DefaultName = "client"
Field Value
Type Description
string

Methods

| Edit this page View Source

CreateSessionPath(string, DateTime, string)

Return a new file path for a session starting at started, e.g. logs/client-20261026-010536.log, named by name, such as server.

Declaration
public static string CreateSessionPath(string directory, DateTime started, string name = "client")
Parameters
Type Name Description
string directory
DateTime started
string name
Returns
Type Description
string
| Edit this page View Source

List(string, string?)

List session logs newest first, then the single log of older versions at legacyPath when it exists.

Declaration
public static IReadOnlyList<LogFileInfo> List(string directory, string? legacyPath = null)
Parameters
Type Name Description
string directory
string legacyPath
Returns
Type Description
IReadOnlyList<LogFileInfo>
| Edit this page View Source

Parse(IEnumerable<string>)

Group lines into entries: a line starting with time and level begins one, other lines continue it.

Declaration
public static IReadOnlyList<LogEntry> Parse(IEnumerable<string> lines)
Parameters
Type Name Description
IEnumerable<string> lines
Returns
Type Description
IReadOnlyList<LogEntry>
| Edit this page View Source

Prune(string, int, string?)

Delete the oldest session logs so that at most keep remain, never except.

Declaration
public static void Prune(string directory, int keep, string? except = null)
Parameters
Type Name Description
string directory
int keep
string except
| Edit this page View Source

Read(string)

Read a log file that may still be written to.

Declaration
public static IReadOnlyList<LogEntry> Read(string path)
Parameters
Type Name Description
string path
Returns
Type Description
IReadOnlyList<LogEntry>