1.3.4 Splunk Settings

It’s possible to send Test results to Splunk as an event.

Splunk Settings can be defined in Administration module at "System Settings -> General Settings -> Splunk Settings":

Protocol type - choose HTTP or HTTPS.

Host - host/ip that will be used for the connection. This field can contain variables:

Port - port that will be used for the connection.

Endpoint - insert the endpoint which you want to use in order to send event(s) to Spunk. For example:  services/collector, services/collector/event, services/collector/raw.

Authentication Type - could be of type “Token” or “Username and Password”.

Token authentication type - use valid token value from Splunk settings:

Note: “Enable indexer acknowledgment” in Splunk Token settings should be disabled!

Username and Password authentication type - use valid credentials from Splunk settings:

User -  can contain variable:

Use channel - when enabled, enter the Splunk channel in the Splunk Channel field:

Please refer to the detailed guide on setting up and using the HTTP Event Collector (HEC) in Splunk Web: https://docs.splunk.com/Documentation/Splunk/8.2.1/Data/UsetheHTTPEventCollector

Additional parameters can be added by clicking the "Add Additional Parameters" button. These parameters will be added to the URL. If there is no index defined, by default the event will be sent to the index "Main". Additional Parameter(s) "Value" field can contains variable:

Additional Parameters are also supported in JSON format:

For example:

1. Parameter 'fields'  

2. Parameter 'time' (default time format is epoch, in the format <sec>.<ms>)

value: <sec>.<ms>

3. Parameter 'event' (value should be String):

Splunk settings can be validated by clicking the "Send test event to Splunk" button: 

Splunk Settings on Test level:

To enable quilliup to send Test event(s) to Splunk, in a specific Test access "Share Options -> Splunk Settings" and make sure that "Splunk Enabled" is on. :

Define a Splunk Group by clicking "Add Group":

Next form, allowing to set up Splunk Group details, will open:

Name - Choose a name for Spunk Group.

If there are any Additional Parameters defined in the "Administration -> System Settings -> General Settings -> Splunk Settings" section then by default these parameters will be shown in Splunk Group, they can be removed or replaced. Also, new Additional parameters can be added by clicking the "Add Additional Parameters" button.

Send on Status - choose on which Test status an event will be sent to Splunk.

Example:  quilliup sends events to Splunk with relevant information for any test type.   

For the Data Validation Test any Rule will be sent in the next format: 

Rule_1_Name: Rule name

Rule_1_Failures: X

Rule_2_Name: Rule name

Rule_2_Failures: Y    

For Compare Tests Different Records and Missing Records will be sent for each Data Set in the next format: 

dataset_1_failed_records: 0
dataset_1_missing_records: 0
dataset_1_name: Set2
final_result_id: 0

final_status: Passed
id: 100000097
index: quilliup
master_dataset: Set1
master_dataset_missing_records: 0
mode: Full Comparison
 

You can use the following manual for further Test sharing options: Test-Share-Options