NetEvolve.HealthPublishers.Splunk 1.10.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package NetEvolve.HealthPublishers.Splunk --version 1.10.0
                    


                    

                
NuGet\Install-Package NetEvolve.HealthPublishers.Splunk -Version 1.10.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="NetEvolve.HealthPublishers.Splunk" Version="1.10.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NetEvolve.HealthPublishers.Splunk" Version="1.10.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NetEvolve.HealthPublishers.Splunk" />
                    


                            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 NetEvolve.HealthPublishers.Splunk --version 1.10.0
                    


                    

                
#r "nuget: NetEvolve.HealthPublishers.Splunk, 1.10.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 NetEvolve.HealthPublishers.Splunk@1.10.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=NetEvolve.HealthPublishers.Splunk&version=1.10.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NetEvolve.HealthPublishers.Splunk&version=1.10.0
                    


                            Install as a Cake Tool

NetEvolve.HealthPublishers.Splunk

NuGet Version NuGet Downloads License

An IHealthCheckPublisher implementation that pushes HealthReport results to Splunk, using the HTTP Event Collector (HEC) (/services/collector/event) directly over HTTP.

Features

  • Pushes a single Splunk HEC event per publish, summarizing the overall report status, elapsed time, and a per-check breakdown
  • Authenticates using the HEC token, sent as the Authorization: Splunk <token> header
  • Tags every event with the machine name and a required, free-form SystemIdentifier to tell instances apart
  • Optionally sets the Splunk sourcetype, source, and index for the published event
  • Configuration- or builder-based setup, consistent with the NetEvolve.HealthPublishers.* conventions
  • Named registrations to publish to multiple Splunk targets (e.g. different environments or indexes) side by side
  • No Splunk SDK dependency - just HttpClient via IHttpClientFactory

Installation

NuGet Package Manager

Install-Package NetEvolve.HealthPublishers.Splunk

.NET CLI

dotnet add package NetEvolve.HealthPublishers.Splunk

PackageReference

<PackageReference Include="NetEvolve.HealthPublishers.Splunk" Version="x.x.x" />

Quick Start

using NetEvolve.HealthPublishers.Splunk;

var builder = services.AddHealthChecks();

builder.AddSplunkPublisher(options =>
{
    options.ServerUrl = new Uri("https://splunk.example.com:8088");
    options.HecToken = "<hec-token>";
    options.SystemIdentifier = "checkout-service";
});

Usage

Basic Example

Register under the default name ("Default"), configured via code:

var builder = services.AddHealthChecks();

builder.AddSplunkPublisher(options =>
{
    options.ServerUrl = new Uri("https://splunk.example.com:8088"); // Required, base address of the HEC endpoint
    options.HecToken = "<hec-token>"; // Required, sent as the Authorization: Splunk <token> header
    options.SystemIdentifier = "checkout-service"; // Required, tags events alongside the machine name
    options.SourceType = "health-check"; // Optional
});

Advanced Example

Register multiple named Splunk targets, each pushing the same health reports to a different environment or index:

var builder = services.AddHealthChecks();

builder.AddSplunkPublisher("Production", options =>
{
    options.ServerUrl = new Uri("https://splunk-prod.example.com:8088");
    options.HecToken = "<prod-hec-token>";
    options.SystemIdentifier = "checkout-service";
    options.Index = "prod_health";
});
builder.AddSplunkPublisher("Staging", options =>
{
    options.ServerUrl = new Uri("https://splunk-staging.example.com:8088");
    options.HecToken = "<staging-hec-token>";
    options.SystemIdentifier = "checkout-service";
    options.Index = "staging_health";
});

Configuration

Code-based

builder.AddSplunkPublisher(options =>
{
    options.ServerUrl = new Uri("https://splunk.example.com:8088"); // Required
    options.HecToken = "<hec-token>"; // Required
    options.SystemIdentifier = "checkout-service"; // Required
    options.SourceType = "health-check"; // Optional
    options.Source = "checkout-service"; // Optional
    options.Index = "health"; // Optional
});

appsettings.json-based

builder.AddSplunkPublisher(); // reads the "Default" section below

{
  "HealthPublishers": {
    "Splunk": {
      "Default": {
        "ServerUrl": "https://splunk.example.com:8088",
        "HecToken": "<hec-token>",
        "SystemIdentifier": "checkout-service",
        "SourceType": "health-check",
        "Source": "checkout-service",
        "Index": "health"
      }
    }
  }
}

When using an explicit name, the section key must match: builder.AddSplunkPublisher("Production") reads HealthPublishers:Splunk:Production.

Requirements

  • .NET 8.0 or higher
  • A Splunk instance with the HTTP Event Collector (HEC) enabled and a valid HEC token

Documentation

For complete documentation, please visit the official documentation.

Contributing

Contributions are welcome! Please read the Contributing Guidelines before submitting a pull request.

Support

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ by the NetEvolve Team Visit us at https://www.daily-devops.net for more information about our services and solutions.

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
1.10.0 47 7/27/2026

https://github.com/dailydevops/healthpublishers/releases/