/// <summary>
/// Adds a sink that writes log events as to a Splunk instance via UDP.
/// </summary>
/// <param name="configuration">The logger config</param>
/// <param name="splunkHost">The Splunk host that is configured with an Event Collector</param>
/// <param name="eventCollectorToken">The token provided to authenticate to the Splunk Event Collector</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="outputTemplate">The output template to be used when logging</param>
/// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
/// <param name="renderTemplate">If ture, the message template will be rendered</param>
/// <param name="batchIntervalInSeconds">The interval in seconds that the queue should be instpected for batching</param>
/// <param name="batchSizeLimit">The size of the batch</param>
/// <returns></returns>
public static LoggerConfiguration SplunkViaEventCollector(
this LoggerSinkConfiguration configuration,
string splunkHost,
string eventCollectorToken,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
string outputTemplate = DefaultOutputTemplate,
IFormatProvider formatProvider = null,
bool renderTemplate = true,
int batchIntervalInSeconds = 2,
int batchSizeLimit = 100)
{
if (configuration == null)
{
throw new ArgumentNullException(nameof(configuration));
}
if (outputTemplate == null)
{
throw new ArgumentNullException(nameof(outputTemplate));
}
var eventCollectorSink = new EventCollectorSink(
splunkHost,
eventCollectorToken,
batchIntervalInSeconds,
batchSizeLimit,
formatProvider,
renderTemplate);
return(configuration.Sink(eventCollectorSink, restrictedToMinimumLevel));
}
/// <summary>
/// Adds a sink that writes log events as to a Splunk instance via the HTTP Event Collector.
/// </summary>
/// <param name="configuration">The logger config</param>
/// <param name="splunkHost">The Splunk host that is configured with an Event Collector</param>
/// <param name="eventCollectorToken">The token provided to authenticate to the Splunk Event Collector</param>
/// <param name="jsonFormatter">The text formatter used to render log events into a JSON format for consumption by Splunk</param>
/// <param name="uriPath">Change the default endpoint of the Event Collector e.g. services/collector/event</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="batchIntervalInSeconds">The interval in seconds that the queue should be instpected for batching</param>
/// <param name="batchSizeLimit">The size of the batch</param>
/// <param name="queueLimit">Maximum number of events in the queue</param>
/// <param name="messageHandler">The handler used to send HTTP requests</param>
/// <param name="levelSwitch">A switch allowing the pass-through minimum level to be changed at runtime.</param>
/// <returns></returns>
public static LoggerConfiguration EventCollector(
this LoggerSinkConfiguration configuration,
string splunkHost,
string eventCollectorToken,
ITextFormatter jsonFormatter,
string uriPath = "services/collector",
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
int batchIntervalInSeconds = 2,
int batchSizeLimit = 100,
int?queueLimit = null,
HttpMessageHandler messageHandler = null,
LoggingLevelSwitch levelSwitch = null)
{
if (configuration == null)
{
throw new ArgumentNullException(nameof(configuration));
}
if (jsonFormatter == null)
{
throw new ArgumentNullException(nameof(jsonFormatter));
}
var eventCollectorSink = new EventCollectorSink(
splunkHost,
eventCollectorToken,
uriPath,
batchIntervalInSeconds,
batchSizeLimit,
queueLimit,
jsonFormatter,
messageHandler);
return(configuration.Sink(eventCollectorSink, restrictedToMinimumLevel, levelSwitch));
}
/// <summary>
/// Adds a sink that writes log events as to a Splunk instance via the HTTP Event Collector.
/// </summary>
/// <param name="configuration">The logger config</param>
/// <param name="splunkHost">The Splunk host that is configured with an Event Collector</param>
/// <param name="eventCollectorToken">The token provided to authenticate to the Splunk Event Collector</param>
/// <param name="uriPath">Change the default endpoint of the Event Collector e.g. services/collector/event</param>
/// <param name="index">The Splunk index to log to</param>
/// <param name="source">The source of the event</param>
/// <param name="sourceType">The source type of the event</param>
/// <param name="host">The host of the event</param>
/// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
/// <param name="outputTemplate">The output template to be used when logging</param>
/// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
/// <param name="renderTemplate">If ture, the message template will be rendered</param>
/// <param name="batchIntervalInSeconds">The interval in seconds that the queue should be instpected for batching</param>
/// <param name="batchSizeLimit">The size of the batch</param>
/// <param name="messageHandler">The handler used to send HTTP requests</param>
/// <param name="levelSwitch">A switch allowing the pass-through minimum level to be changed at runtime.</param>
/// <param name="fields">Customfields that will be indexed in splunk with this event</param>
/// <returns></returns>
public static LoggerConfiguration EventCollector(
this LoggerSinkConfiguration configuration,
string splunkHost,
string eventCollectorToken,
CustomFields fields,
string uriPath = "services/collector",
string source = DefaultSource,
string sourceType = DefaultSourceType,
string host = DefaultHost,
string index = DefaultIndex,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
string outputTemplate = DefaultOutputTemplate,
IFormatProvider formatProvider = null,
bool renderTemplate = true,
int batchIntervalInSeconds = 2,
int batchSizeLimit = 100,
HttpMessageHandler messageHandler = null,
LoggingLevelSwitch levelSwitch = null)
{
if (configuration == null)
{
throw new ArgumentNullException(nameof(configuration));
}
if (outputTemplate == null)
{
throw new ArgumentNullException(nameof(outputTemplate));
}
var eventCollectorSink = new EventCollectorSink(
splunkHost,
eventCollectorToken,
uriPath,
source,
sourceType,
host,
index,
fields,
batchIntervalInSeconds,
batchSizeLimit,
formatProvider,
renderTemplate,
messageHandler
);
return(configuration.Sink(eventCollectorSink, restrictedToMinimumLevel, levelSwitch));
}