MMP.Herald.Sinks.ClickHouse
0.2.2
dotnet add package MMP.Herald.Sinks.ClickHouse --version 0.2.2
NuGet\Install-Package MMP.Herald.Sinks.ClickHouse -Version 0.2.2
<PackageReference Include="MMP.Herald.Sinks.ClickHouse" Version="0.2.2" />
<PackageVersion Include="MMP.Herald.Sinks.ClickHouse" Version="0.2.2" />
<PackageReference Include="MMP.Herald.Sinks.ClickHouse" />
paket add MMP.Herald.Sinks.ClickHouse --version 0.2.2
#r "nuget: MMP.Herald.Sinks.ClickHouse, 0.2.2"
#:package MMP.Herald.Sinks.ClickHouse@0.2.2
#addin nuget:?package=MMP.Herald.Sinks.ClickHouse&version=0.2.2
#tool nuget:?package=MMP.Herald.Sinks.ClickHouse&version=0.2.2
Herald.Sinks.ClickHouse
Inserts Herald log events into a ClickHouse table via the ClickHouse.Client driver. Single INSERT on the Log path, ClickHouseBulkCopy on IBatchedLogSink batches — the driver's native column-block format gives sustained-throughput insert performance ClickHouse is famous for.
Part of Herald — high-performance structured logging for .NET 8, 9, and 10.
Install
dotnet add package Herald.Sinks.ClickHouse
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: clickhouse (the identifier the Dashboard form and JSON config use to reference this sink).
Capabilities
- Single INSERT per event on the Log path
- ClickHouseBulkCopy on batches — column-block native format
- Identifier validation prevents SQL injection on the table name
- LowCardinality columns suggested in the schema for level + category
Limitations
- Synchronous Log path uses GetAwaiter().GetResult around the async bulk-copy SDK
- Schema creation is operator responsibility
- No automatic Properties column wiring; add a Map(String, String) column and bind via custom subclass
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: Connection per call; no shared state across calls.
Vendor
ClickHouse — https://clickhouse.com
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 | Versions 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. |
-
net10.0
- ClickHouse.Client (>= 7.10.0)
- Herald.OSS (>= 0.13.0)
- Herald.Sinks.Batching (>= 0.2.2)
-
net8.0
- ClickHouse.Client (>= 7.10.0)
- Herald.OSS (>= 0.13.0)
- Herald.Sinks.Batching (>= 0.2.2)
-
net9.0
- ClickHouse.Client (>= 7.10.0)
- Herald.OSS (>= 0.13.0)
- Herald.Sinks.Batching (>= 0.2.2)
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.2 | 147 | 8/7/2026 |
| 0.2.1 | 116 | 5/30/2026 |
| 0.2.0 | 115 | 5/26/2026 |
| 0.2.0-alpha.3 | 75 | 5/13/2026 |
| 0.2.0-alpha.2 | 77 | 5/13/2026 |
| 0.2.0-alpha.1 | 64 | 5/13/2026 |