MMP.Herald.Sinks.Elasticsearch
0.2.1
dotnet add package MMP.Herald.Sinks.Elasticsearch --version 0.2.1
NuGet\Install-Package MMP.Herald.Sinks.Elasticsearch -Version 0.2.1
<PackageReference Include="MMP.Herald.Sinks.Elasticsearch" Version="0.2.1" />
<PackageVersion Include="MMP.Herald.Sinks.Elasticsearch" Version="0.2.1" />
<PackageReference Include="MMP.Herald.Sinks.Elasticsearch" />
paket add MMP.Herald.Sinks.Elasticsearch --version 0.2.1
#r "nuget: MMP.Herald.Sinks.Elasticsearch, 0.2.1"
#:package MMP.Herald.Sinks.Elasticsearch@0.2.1
#addin nuget:?package=MMP.Herald.Sinks.Elasticsearch&version=0.2.1
#tool nuget:?package=MMP.Herald.Sinks.Elasticsearch&version=0.2.1
Herald.Sinks.Elasticsearch
Sends Herald log events to Elasticsearch as JSON documents via the Bulk API. Uses time-based indexes (prefix-yyyy.MM.dd) and emits exceptions as a typed sub-object (type / message / stack) that Kibana's exception-tracking UI indexes as first-class fields.
Part of Herald — high-performance structured logging for .NET 8, 9, and 10.
Install
dotnet add package Herald.Sinks.Elasticsearch
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: elasticsearch (the identifier the Dashboard form and JSON config use to reference this sink).
Capabilities
- Batched delivery via the Bulk API (one NDJSON request per batch)
- Time-based indices ({prefix}-yyyy.MM.dd) for easy retention policies
- Exception emission as typed sub-object (type / message / stack)
- Separate properties / context namespaces guard against user-property collisions with reserved fields
- Index-prefix regex validation at construction
Limitations
- No auth support yet (API key / basic auth requires caller-supplied HttpClient)
- Index prefix configurable at construction only
- Synchronous Send path; pair with async decorator for throughput
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 — shared HttpClient is reentrant.
Vendor
Elastic — https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
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
- Herald.OSS (>= 0.10.4)
-
net8.0
- Herald.OSS (>= 0.10.4)
-
net9.0
- Herald.OSS (>= 0.10.4)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on MMP.Herald.Sinks.Elasticsearch:
| Package | Downloads |
|---|---|
|
MMP.Herald.Business
Herald observability metapackage for business and enterprise deployments. Pulls in every Herald.Sinks destination — HTTP, TCP, UDP, every Enterprise HTTP sink (Seq, Splunk, Honeycomb, Datadog, Loki, SignalFx, Sentry, PagerDuty), community transports (Elasticsearch, Slack, GenericWebhook), and the OTLP trio. Depend on this one package and pick destinations at registration time. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.2.1 | 109 | 5/30/2026 |
| 0.2.0 | 112 | 5/26/2026 |
| 0.2.0-alpha.3 | 59 | 5/13/2026 |
| 0.2.0-alpha.2 | 51 | 5/13/2026 |
| 0.2.0-alpha.1 | 59 | 5/13/2026 |