Skip to main content

Connectors: Splunk

Legacy Documentation
You're viewing legacy documentation for API Fortress (deployed via an on-premises container). To view documentation for the new SaaS version of API Fortress — now known as Sauce Labs API Testing and Monitoring (with Sauce Connect tunnels) — see API Testing on the Sauce Labs Cloud.

Using the connector, you can send test execution information to Splunk then use that data to create visualizations.

Below is a quick guide to setting up and using the Splunk connector.

note

This connector does not come pre-loaded out of the box for self-hosted/on-premises, and will need to be loaded separately. To learn how to load the connector into your API Fortress instance click here.

Configure the Connector​

Note: You can click on the screenshots to zoom in.

  1. Access the company dashboard by clicking the gear icon in the top right corner

    1.-splunk-settings.png

  2. Click on “Alert Groups”

    2.-splunk-alert-groups.png

  3. Create a new group or add a connector to an existing alert group

    3.-splunk-add-connector-to-group.png

  4. Add a new connector

    4.-add-new-connector-1.png

  5. Choose the Splunk connector

    5.-choose-splunk.png

  6. Configure the connector

    6.-configure-splunk-connector.png
    1. url - this is the url for "http event collector" generated in Splunk platform. Please include the port number in the url, but do not include the endpoint.
    2. hec_token - this is the token generated for the "http event collector"

  7. Go into project settings for a project you would like Splunk connector set up for

    7.-splunk-project-settings.png

  8. Add the alert group that contains your Splunk connector to this project

    8.-splunk-add-alert-group-to-proj.png

Example Use Case​

You can create a dataset table of your executions like so:

9.-dataset-table.png

You can also use the data to create visualizations like below:

9.-dashboard-chart.png

In this example, you can see all the tests executed, and the "blue" bar is the total number of successful runs whereas the "green" bar shows the total number of failed runs.

Video Example​

You can also watch a video walk through of the integration below.

Splunk Video