OutWit.Shared.Logging.Provider.File 1.0.0

.NET 10.0

dotnet add package OutWit.Shared.Logging.Provider.File --version 1.0.0

NuGet\Install-Package OutWit.Shared.Logging.Provider.File -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="OutWit.Shared.Logging.Provider.File" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="OutWit.Shared.Logging.Provider.File" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="OutWit.Shared.Logging.Provider.File" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add OutWit.Shared.Logging.Provider.File --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: OutWit.Shared.Logging.Provider.File, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package OutWit.Shared.Logging.Provider.File@1.0.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=OutWit.Shared.Logging.Provider.File&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=OutWit.Shared.Logging.Provider.File&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

OutWit.Shared.Logging.Provider.File

File-scanning log query plugin for OutWit hosts — the "no external account needed" fallback. Reads the host's Serilog NDJSON files in-place and exposes them through the neutral ILogQueryProvider interface — the same shape NewRelic and Loki providers expose.

Where the logs come from

The plugin reads files from the directory the host writes them to. The host registers an OutWit.Shared.Logging.Providers.HostLoggingInfo singleton in DI before invoking the plugin's Initialize, and the plugin picks it up at first query. This avoids duplicating the Serilog path into two places.

// Host wiring (e.g. WitIdentity Startup):
services.AddSingleton(new HostLoggingInfo
{
    LogsPath    = "/app/logs",
    FilePattern = "log-*.json"
});
plugin.Initialize(services);   // ← FileLogProviderPlugin

When the host did not register a HostLoggingInfo, the plugin falls back to its own File:FallbackLogsPath / File:FallbackFilePattern settings.

Configuration

Plugin reads its own appsettings.json from inside the deployed module folder:

{
  "File": {
    "MaxScannedEntries": 50000,
    "FallbackLogsPath": "logs",
    "FallbackFilePattern": "log-*.json"
  }
}

Setting	Default	Description
`MaxScannedEntries`	`50000`	Maximum number of lines parsed per query. Caps the work each request can do regardless of how much history sits on disk.
`FallbackLogsPath`	`logs`	Directory used only when the host did not register a `HostLoggingInfo`. Relative paths resolve under the plugin's base directory.
`FallbackFilePattern`	`log-*.json`	Glob pattern used only when the host did not register a `HostLoggingInfo`.

Standard env-var override convention applies (File__MaxScannedEntries=200000).

Supported JSON formats

The parser is defensive about field names — supports both the NewRelic log enricher format (the WitIdentity production default — timestamp / log.level / message / service.name / hostname …) and Serilog's compact JSON shape (@t / @l / @mt / @x). Mixing files of different shapes in the same directory works.

Honest limitations

Limitation	Why	Workaround
Only sees this host's logs	Files live on local disk	For multi-replica, mount a shared volume or switch to NewRelic / Loki
O(scan) per query	Full file scan filtered in-memory	`MaxScannedEntries` caps work per request; cap your time range
Loses old logs on rotation	Serilog `retainedFileCountLimit` is the upper bound	Increase the limit or ship to a log service
No live tail	Files are scanned, not subscribed	Refresh the page; latency = polling interval

Practical for: single-instance deployments, air-gapped installs, development, disaster fallback if NerdGraph / Loki is unreachable. Not suitable for distributed / high-volume deployments — use a real log backend there.

Installation

dotnet add package OutWit.Shared.Logging.Provider.File

The plugin's build/.targets auto-copies the module to your output @Logging/file.module/ at build time. The host's WitPluginLoader<ILogProviderPlugin> discovers it.

License

Apache 2.0 — see LICENSE.txt.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.0	160	5/13/2026