com.splunk.logging

Class HttpEventCollectorSender

java.lang.Object

java.util.TimerTask

com.splunk.logging.HttpEventCollectorSender

All Implemented Interfaces:

HttpEventCollectorMiddleware.IHttpSender, java.lang.Runnable

public class HttpEventCollectorSender
extends java.util.TimerTask
implements HttpEventCollectorMiddleware.IHttpSender

This is an internal helper class that sends logging events to Splunk http event collector.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpEventCollectorSender.SendMode Sender operation mode.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DefaultBatchCount
static int	DefaultBatchInterval Recommended default values for events batching.
static int	DefaultBatchSize
static java.lang.String	MetadataHostTag
static java.lang.String	MetadataIndexTag
static java.lang.String	MetadataMessageFormatTag
static java.lang.String	MetadataSourceTag
static java.lang.String	MetadataSourceTypeTag
static java.lang.String	MetadataTimeTag

Constructor Summary

Constructors

Constructor and Description
HttpEventCollectorSender(java.lang.String Url, java.lang.String token, java.lang.String channel, java.lang.String type, long delay, long maxEventsBatchCount, long maxEventsBatchSize, java.lang.String sendModeStr, java.util.Dictionary<java.lang.String,java.lang.String> metadata) Initialize HttpEventCollectorSender

Method Summary

Modifier and Type	Method and Description
void	addMiddleware(HttpEventCollectorMiddleware.HttpSenderMiddleware middleware)
void	disableCertificateValidation() Disable https certificate validation of the splunk server.
void	flush() Flush all pending events
void	flush(boolean close)
void	postEvents(java.util.List<HttpEventCollectorEventInfo> events, HttpEventCollectorMiddleware.IHttpSenderCallback callback)
static void	putIfPresent(JSONObject collection, java.lang.String tag, java.lang.Object value)
void	run() Timer heartbeat
void	send(java.lang.String message) Send a single logging event with message only
void	send(java.lang.String severity, java.lang.String message, java.lang.String logger_name, java.lang.String thread_name, java.util.Map<java.lang.String,java.lang.String> properties, java.lang.String exception_message, java.io.Serializable marker) Send a single logging event
java.lang.String	serializeEventInfo(HttpEventCollectorEventInfo eventInfo)
void	setEventBodySerializer(EventBodySerializer eventBodySerializer)

Methods inherited from class java.util.TimerTask

cancel, scheduledExecutionTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MetadataTimeTag

public static final java.lang.String MetadataTimeTag

See Also:

Constant Field Values

MetadataHostTag

public static final java.lang.String MetadataHostTag

See Also:

Constant Field Values

MetadataIndexTag

public static final java.lang.String MetadataIndexTag

See Also:

Constant Field Values

MetadataSourceTag

public static final java.lang.String MetadataSourceTag

See Also:

Constant Field Values

MetadataSourceTypeTag

public static final java.lang.String MetadataSourceTypeTag

See Also:

Constant Field Values

MetadataMessageFormatTag

public static final java.lang.String MetadataMessageFormatTag

See Also:

Constant Field Values

DefaultBatchInterval

public static final int DefaultBatchInterval

Recommended default values for events batching.

See Also:

Constant Field Values

DefaultBatchSize

public static final int DefaultBatchSize

See Also:

Constant Field Values

DefaultBatchCount

public static final int DefaultBatchCount

See Also:

Constant Field Values

Constructor Detail

HttpEventCollectorSender

public HttpEventCollectorSender(java.lang.String Url,
                                java.lang.String token,
                                java.lang.String channel,
                                java.lang.String type,
                                long delay,
                                long maxEventsBatchCount,
                                long maxEventsBatchSize,
                                java.lang.String sendModeStr,
                                java.util.Dictionary<java.lang.String,java.lang.String> metadata)

Initialize HttpEventCollectorSender

Parameters:

Url - http event collector input server

token - application token

delay - batching delay

maxEventsBatchCount - max number of events in a batch

maxEventsBatchSize - max size of batch

metadata - events metadata

channel - unique GUID for the client to send raw events to the server

type - event data type

Method Detail

addMiddleware

public void addMiddleware(HttpEventCollectorMiddleware.HttpSenderMiddleware middleware)

send

public void send(java.lang.String severity,
                 java.lang.String message,
                 java.lang.String logger_name,
                 java.lang.String thread_name,
                 java.util.Map<java.lang.String,java.lang.String> properties,
                 java.lang.String exception_message,
                 java.io.Serializable marker)

Send a single logging event

Parameters:

severity - event severity level (info, warning, etc.)

message - event text

send

public void send(java.lang.String message)

Send a single logging event with message only

Parameters:

message - event text

flush

public void flush()

Flush all pending events

flush

public void flush(boolean close)

run

public void run()

Timer heartbeat

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class java.util.TimerTask

disableCertificateValidation

public void disableCertificateValidation()

Disable https certificate validation of the splunk server. This functionality is for development purpose only.

setEventBodySerializer

public void setEventBodySerializer(EventBodySerializer eventBodySerializer)

putIfPresent

public static void putIfPresent(JSONObject collection,
                                java.lang.String tag,
                                java.lang.Object value)

serializeEventInfo

public java.lang.String serializeEventInfo(HttpEventCollectorEventInfo eventInfo)

postEvents

public void postEvents(java.util.List<HttpEventCollectorEventInfo> events,
                       HttpEventCollectorMiddleware.IHttpSenderCallback callback)

Specified by:

postEvents in interface HttpEventCollectorMiddleware.IHttpSender