Skip to content
ConsoleMonster
Class

LogTailOptions

ConsoleMonster.Live.Tails

Namespace
ConsoleMonster.Live.Tails
Assembly
ConsoleMonster
Modifiers
sealed

Configuration for a synchronous, polling log-tail run.

Inheritance

  • object
  • LogTailOptions

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 1

Constructors

public LogTailOptions() #

Properties

public int Capacity { get; set; } #

Maximum retained history lines (default 1000; minimum 1). Pending source updates are lossless.

public long Count { get; set; } #

Source-read iterations; one processes one complete snapshot, zero follows until cancelled or quit.

public string? Filter { get; set; } #

Literal, ordinal case-insensitive substring required in the original line; null or empty accepts all.

public string? Highlight { get; set; } #

Literal, ordinal case-insensitive substring emphasized in live frames; plain lines stay unchanged.

public string? TimestampFormat { get; set; } #

Invariant source timestamp format, or null for HH:mm:ss, adding yyyy-MM-dd when retained source dates differ. Applies only to the live view, at every terminal width; plain original lines and source metadata are unchanged.

public TimeSpan PollInterval { get; set; } #

Time between source reads (default 250 milliseconds; positive and at most Int32.MaxValue milliseconds).

public bool Plain { get; set; } #

Forces literal line output without acquiring or reading keyboard input.

public Action<string>? WriteLine { get; set; } #

Receives each original line in plain mode, without a terminator. Null uses the core terminal writer.

public LiveMode Mode { get; set; } #

Live layout, full screen by default. Plain fallback ignores this setting.

public TerminalProfile? Profile { get; set; } #

Terminal profile override, or null for the current terminal target's profile.

public ITheme? Theme { get; set; } #

Theme override, or null for the current terminal target's theme.

public ITerminalOutput? Output { get; set; } #

Borrowed live output, or null for the core terminal output. A non-live output selects plain fallback.

public IInputSource? Input { get; set; } #

Borrowed input source leased through ConsoleInput, or null for the current target, input override or console.

public bool HandleCancelKey { get; set; } #

Whether to handle the console's Ctrl+C signal cooperatively (default true).