MMP.Herald.Sinks.File 0.2.0-alpha.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of MMP.Herald.Sinks.File.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package MMP.Herald.Sinks.File --version 0.2.0-alpha.1
                    


                    

                
NuGet\Install-Package MMP.Herald.Sinks.File -Version 0.2.0-alpha.1
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="MMP.Herald.Sinks.File" Version="0.2.0-alpha.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="MMP.Herald.Sinks.File" Version="0.2.0-alpha.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="MMP.Herald.Sinks.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 MMP.Herald.Sinks.File --version 0.2.0-alpha.1
                    


                    

                
#r "nuget: MMP.Herald.Sinks.File, 0.2.0-alpha.1"
#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 MMP.Herald.Sinks.File@0.2.0-alpha.1
#: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=MMP.Herald.Sinks.File&version=0.2.0-alpha.1&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=MMP.Herald.Sinks.File&version=0.2.0-alpha.1&prerelease
                    


                            Install as a Cake Tool

MMP.Herald.Sinks.File

Writes Herald log events to disk. Plain-text mode produces human-readable lines; structured mode produces NDJSON for machine parsing. Optional file rolling for time-based or size-based rotation, with per-pipeline path templating.

Part of Herald — high-performance structured logging for .NET 8, 9, and 10.

Install

dotnet add package MMP.Herald.Sinks.File

The sink auto-registers into LogSinkProviderRegistry.Default via a [ModuleInitializer] on assembly load. No manual RegisterAll(...) or With*SinkProviders() call is required — dotnet add package is the whole workflow.

Sink kind: file (the identifier the Dashboard form and JSON config use to reference this sink).

Capabilities

  • Plain-text or NDJSON output via the format toggle
  • Time-based rolling (hour / day / week)
  • Size-based rolling (maxBytes per file)
  • Retention by file count or total size cap
  • Path templating with {pipeline}, {date}, {hour} tokens

Limitations

  • Local filesystem only (use a remote sink for cloud storage)
  • One file per sink instance — fan-out via multiple sink registrations

Tier & runtime

  • Edition: Community — works on the free Apache 2.0 Herald.Core. No license key required.
  • AOT-compatible: yes
  • Targets: .NET 8 / 9 / 10
  • Thread safety: Thread-safe via internal lock around write+flush.

Vendor

MMP

Configuration

Per-sink config form lives in configuration*.mmpform at the package root and inside the assembly as an embedded resource. The Herald Dashboard renders it at runtime; JSON config follows the same shape. See CAPABILITY.yaml shipped at the package root for the full manifest (schema reference: CAPABILITY-SCHEMA.md).

License

Apache 2.0. Copyright (c) 2026 MMPWorks LLC. See LICENSE shipped at the package root.

Generated from CAPABILITY.yaml. Re-run Modules/Herald.Sinks/tools/generate-readmes.cjs after manifest edits to refresh.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  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.

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
0.2.0 31 5/26/2026
0.2.0-alpha.3 49 5/13/2026
0.2.0-alpha.2 55 5/13/2026
0.2.0-alpha.1 49 5/13/2026