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.
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).
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.
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)_
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
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
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
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
There are no known issues at this time.
No special instructions for upgrading this app to a newer version.
For help with any further questions, consult the developer using the link above or ask on Splunk Answers.
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:
This screen shows the basic elements on using the new command, including examples that get you started.
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.
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.
This tab will take you to an example set of Dashboard panels created to expose Rigor data using this app. These Dashboards are titled:
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.
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.
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.
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.
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
This major release includes support for the Web Optimization feature from Splunk Synthetic Monitoring along with new improved Dashboards.
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 from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.