org.apache.beam.it.splunk

Class SplunkResourceManager

java.lang.Object

org.apache.beam.it.testcontainers.TestContainerResourceManager<SplunkContainer>

org.apache.beam.it.splunk.SplunkResourceManager

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

public class SplunkResourceManager
extends TestContainerResourceManager<SplunkContainer>
implements org.apache.beam.it.common.ResourceManager

Client for managing Kafka resources.

The class supports one Splunk server instance.

The class is thread-safe.

Note: The Splunk TestContainer will only run on M1 Mac's if the Docker version is >= 4.16.0 and the "Use Rosetta for x86/amd64 emulation on Apple Silicon" setting is enabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SplunkResourceManager.Builder Builder for SplunkResourceManager.

Field Summary

Fields inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

HOST_IP, port

Method Summary

Modifier and Type	Method and Description
static SplunkResourceManager.Builder	builder(java.lang.String testId)
java.util.List<SplunkEvent>	getEvents() Return a list of all Splunk events retrieved from the Splunk server.
java.util.List<SplunkEvent>	getEvents(java.lang.String query) Return a list of Splunk events retrieved from the Splunk server based on the given query.
java.lang.String	getHecEndpoint() Returns the HTTP Event Collector (HEC) endpoint that this Splunk server is configured to receive events at.
java.lang.String	getHecToken() Returns the Splunk Http Event Collector (HEC) authentication token used to connect to this Splunk instance's HEC service.
java.lang.String	getHttpEndpoint() Returns the HTTP endpoint that this Splunk server is configured to listen on.
boolean	sendHttpEvent(SplunkEvent event) Sends the given HTTP event to the Splunk Http Event Collector (HEC) service.
boolean	sendHttpEvents(java.util.Collection<SplunkEvent> events) Sends the given HTTP events to the Splunk Http Event Collector (HEC) service.

Methods inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

cleanupAll, getDockerImageName, getHost, getPort

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.beam.it.common.ResourceManager

cleanupAll

Method Detail

builder

public static SplunkResourceManager.Builder builder(java.lang.String testId)

getHttpEndpoint

public java.lang.String getHttpEndpoint()

Returns the HTTP endpoint that this Splunk server is configured to listen on.

Returns:

the HTTP endpoint.

getHecEndpoint

public java.lang.String getHecEndpoint()

Returns the HTTP Event Collector (HEC) endpoint that this Splunk server is configured to receive events at.

This will be the HTTP endpoint concatenated with '/services/collector/event'.

Returns:

the HEC service endpoint.

getHecToken

public java.lang.String getHecToken()

Returns the Splunk Http Event Collector (HEC) authentication token used to connect to this Splunk instance's HEC service.

Returns:

the HEC authentication token.

sendHttpEvent

public boolean sendHttpEvent(SplunkEvent event)

Sends the given HTTP event to the Splunk Http Event Collector (HEC) service.

Note: Setting the index field in the Splunk event requires the index already being configured in the Splunk instance. Unless using a static Splunk instance, omit this field from the event.

Parameters:

event - The SpunkEvent to send to the HEC service.

Returns:

True, if the request was successful.

sendHttpEvents

public boolean sendHttpEvents(java.util.Collection<SplunkEvent> events)

Sends the given HTTP events to the Splunk Http Event Collector (HEC) service.

Note: Setting the index field in the Splunk event requires the index already being configured in the Splunk instance. Unless using a static Splunk instance, omit this field from the events.

Parameters:

events - The SpunkEvents to send to the HEC service.

Returns:

True, if the request was successful.

getEvents

public java.util.List<SplunkEvent> getEvents()

Return a list of all Splunk events retrieved from the Splunk server.

Returns:

All Splunk events on the server.

getEvents

public java.util.List<SplunkEvent> getEvents(java.lang.String query)

Return a list of Splunk events retrieved from the Splunk server based on the given query.

e.g. query: 'search source=mySource sourcetype=mySourceType host=myHost'

Parameters:

query - The query to filter events by.

Returns:

All Splunk events on the server that match the given query.