icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Splunk Synthetic Monitoring Add-on
SHA256 checksum (splunk-synthetic-monitoring-add-on_107.tgz) b37ce2fb24186f4d5e701f9abbb928085ebe4d2edc3dd674cea46c0a41dfa140 SHA256 checksum (splunk-synthetic-monitoring-add-on_106.tgz) 3f937ce437af7e32527a41e30dec151a8d746bae7d773d36287420cfdf599da8 SHA256 checksum (splunk-synthetic-monitoring-add-on_105.tgz) cfcddbb721b79f6ab0b6319e44b8b27a46b9b794902cc043997e9d47bd3808fe SHA256 checksum (splunk-synthetic-monitoring-add-on_103.tgz) 1052ed48c695d3785e66f4ddb0547f360a52b54fc3d228e1f9990f5c46fe2cb2
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

Splunk Synthetic Monitoring Add-on

Splunk Cloud
Splunk Labs
Overview
Details
* Description *
Splunk Synthetics Monitoring is a platform to synthetically measure performance of your web based properties. This supporting add-on for Splunk Cloud and Splunk Enterprise demonstrates the value of bringing this synthetic data into the Splunk platform for use in regular SPL queries as well as into Splunk ITSI searches that populate KPIs and Events.

This supporting add-on creates a new command in your Splunk Search Processing Language (SPL) called `synthetics` that will bring your synthetics data into Splunk directly from your Splunk Synthetic Monitoring environment. This new `synthetics` command has a set of subcommands to retrieve the right data, and the results can be further processed using your SPL skills. You can create a correlated view that includes data from your Splunk Synthetics Monitoring platform alongside whatever you have in Splunk, including your Log and Observability data.

This add-on also enables you to use the Content Pack for Splunk Synthetic Monitoring within Splunk ITSI, which provides out of the box KPIs, Entities and Services in order to integrate your synthetic metrics into the overall Service view in Splunk ITSI. More information about this Content Pack is here: https://docs.splunk.com/Documentation/ITSICP/current/Config/AboutSM

* Get More Details about Splunk Synthetic Monitoring *
Learn more about the use cases for synthetics here: https://www.splunk.com/en_us/devops/synthetic-monitoring-use-case.html
Start your own free trial of Splunk Synthetic Monitoring here: https://www.splunk.com/en_us/form/splunk-synthetic-monitoring-free-trial.html

* Setup *
See the details tab here on this Splunkbase page for dependencies and setup instructions.

* Privacy *
This add-on contains no private information itself, refer to Splunk Synthetic Monitoring Documentation on privacy protection in the Splunk Synthetics platform.

* Questions *
This add-on is supported by the developer. For support use the link above to the developer or post to Splunkbase for support.

Instructions

Prerequisites

This add-on has been tested on Splunk versions 8.1 and 8.2, but will likely work on previous versions of Splunk.
This add-on also expects that you have a current Splunk Synthetic Monitoring environment and can access your API Key on the settings page of that service. You will find this on your Profile page in the web interface of Splunk Synthetic Monitoring.

Installation

This add-on is installed on the Splunk Search Head in either an on-premises instance, private cloud instance, or Splunk Cloud instance of Splunk.

This add-on is installed using the Splunk web interface by clicking on Manage Applications and browsing Splunkbase to this add-on.

Installed with this add-on are:
- a new command: synthetics
- a new lookup for the list of metrics available in Splunk Synthetics: input lookup metrics
- a group of dashboards to understand how to use the new command (see descriptions below).

Configuration

After installation, navigate to the Configuration tab of the add-on and provide the API Key from your Splunk Synthetics interface and click Save. This will enable connection to your Splunk Synthetics data and the new synthetics command in Splunk will work.

Usage

The synthetics command in your SPL begins the connection to your Rigor environment. This command must begin with a "pipe", or "|" and followed by subcommands to access synthetics data.
| synthetics _(insert argument here)_

Arguments

checks

Syntax: | synthetics checks | _(further SPL)_
Description: Get each of your configured "checks" from your Rigor environment.
Usage example: | synthetics checks | spath | table id, name, type, frequency, status.last_response_time, links.last_run

kpi

Syntax: | synthetics kpi id=<int> metric=<string> | _(further SPL)_
Description: Get a report on a specific KPI from your Rigor environment.
Usage: | synthetics kpi id=175384 metric=dom_interactive_time_ms | timechart by browsers

runs

Syntax: | synthetics runs id=<int> | _(further SPL)_
Description: Get data about what runs have been executed for a given check ID from your Rigor environment.
Usage: | synthetics runs id=175384 | spath | table runs{}.id, runs{}.timestamp, runs{}.region_code, runs{}.share_link

run

Syntax: | synthetics run id=<int> check_id=<int> | _(further SPL)_
Description: Get specific data about a run executed within your Rigor environment.
Usage: | synthetics run id=175384 check_id=8204006066 | spath

Known Issues

There are no known issues at this time.

Upgrade

No special instructions for upgrading this app to a newer version.

Questions

For help with any further questions, consult the developer using the link above or ask on Splunk Answers.

More details on the various tabs on this add-on

Once the Splunk Synthetics Add-on has been installed in your Splunk environment there are four tabs: Welcome, Configuration, Search and Synthetics Dashboard. Here is a quick tour of those tabs:

Welcome

This screen shows the basic elements on using the new command, including examples that get you started.

Configuration

This screen has an input box for specifying your API Key into the Rigor environment to connect to. This is obtained by accessing your Rigor interface navigating to your settings page and copying the API Key.

Search

This screen accesses the Search bar that all Splunk users to access and manipulate your machine data. This is provided for you to easily get to the Search bar to start using the | synthetics command within Splunk.

Synthetics Dashboards

This tab will take you to an example set of Dashboard panels created to expose Rigor data using this app. These Dashboards are titled:

Synthetics Checks:

This Dashboard shows all of the checks within your environment and presents basic information about that check. View the Events tab within Splunk to see more of the possible data gathered with the Checks subcommand, including the unique ID of each execution of the Check, which is called a Run.

Synthetics Run Details:

This Dashboard shows details of the Run subcommand within your environment and presents KPI data about that Run. View the Events tab within Splunk to see more of the possible data gathered with the Run subcommand.

Synthetics KPI Browser:

This Dashboard shows details of the KPI subcommand within your environment and presents details about the KPI data in your environment. View the Events tab within Splunk to see more of the possible data gathered with the KPI subcommand.

Synthetics KPI Comparison:

This Dashboard shows how to compare the KPIs of different Runs within your environment and presents comparison timecharts of the KPI data about those different Checks.

Use of this Splunk Synthetics Add-on in ITSI

You can use this new supporting addon within ITSI to create KPIs, Entities and Services. The Splunk App for Content Packs version 1.3 includes an ITSI Content Pack that provides these KPIs, Entities and Services. Read this documentation for more information: https://docs.splunk.com/Documentation/ITSICP/current/Config/AboutSM

Release Notes

Version 1.0.7
Aug. 18, 2021
Version 1.0.6
Aug. 14, 2021

Additional support for Splunk Cloud.

Version 1.0.5
July 27, 2021

Fixes for clustered environments
Permissions for Splunk Cloud
Updated compatibility to Python 3

Version 1.0.3
June 23, 2021

Appinspect changes

80
Installs
230
Downloads
Share Subscribe LOGIN TO DOWNLOAD

Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.