Share data from Splunk SOAR (Cloud)
How data is collected
Splunk SOAR (Cloud) uses several technologies running in the background to collect usage data.
- Splunk Web Analytics (swa.js)
- FullStory
Usage Data Telemetry
A Splunk SOAR (Cloud) background task runs at a specified system time to collect telemetry data which is transmitted to the Splunk products-telemetry server.
Each time a user logs in some system settings and license metrics are collected.
FullStory is used to collect experiential user journey information from the Visual Playbook Editor with user personally identifiable information redacted.
For information about the Visual Playbook Editor see Use playbooks to automate analyst workflows in Splunk SOAR (Cloud) in Build Playbooks with the Playbook Editor.
How data is stored
Splunk retention timeframes for Usage Data are described here. For more information about Splunk data collection and privacy practices see the Splunk Privacy Policy and learn how Splunk Protects.
Telemetry impacts on performance
Collecting telemetry data minimally affects database performance and the loading of the Splunk SOAR (Cloud) UI.
General Usage Data
Splunk SOAR (Cloud) telemetry collects the following basic usage information:
Name | Description | Example |
---|---|---|
Items in this section apply to all telemetry objects | ||
app.session. objects
|
||
automation.summary objects
|
||
orchestration. objects
|
||
automation.*
automation.summary.*
orchestration.*
|
Either:
And:
Splunk SOAR sends the deploymentID with every event. This change adds either companyID or stackID and licenseNumber, licenseIssueDate, licenseExpirationDate, and licenseInstance wherever deploymentID is currently logged. |
Or
|
app.session.soar.apiTime
|
Reports roundtrip time consumption for each API request. |
|
app.session.soar.error
|
Reports uncaught errors of front-end Splunk SOAR scripts. |
|
app.session.soar.license
|
Reports license status, limits, and usage information. Sent once per session.
|
|
app.session.soar.pageview
|
Reports which pages are visited by users. |
|
app.session.soar.
systemSettings
|
Reports the feature on/off settings and product version.
|
|
app.session.session_start
|
Reports the browser and OS, along with their versions. |
|
app.session.phantom.viewTime
|
Reports time spent on a specific page. Only tracked for specific pages. |
|
app.session.soar.vpe
|
Reports:
|
|
app.session.soar.vpeTime
|
Reports the time in milliseconds it took for the VPE to load in the browser. |
|
automation.summary.app_summary
|
A summary of apps installed on the system.
|
|
automation.summary.
case_summary
|
A summary of opened and closed cases in the last 24 hours.
|
|
automation.summary.
ingestion_status
|
Ingestion status and events ingested per Splunk SOAR deployment.
|
|
automation.summary.
playbook_names
|
A summary of playbooks names and whether or not a playbook is custom.
|
|
automation.summary.
playbook_runs.by_trigger
|
Counts of playbook runs by trigger, either adhoc or by automation, aggregated over the last day. Emitted once daily. |
|
automation.summary.
publish_telemetry_time_taken
|
Start time, end time, and a the calculated total time of the telemetry publish job.
|
|
automation.summary.
workbook_summary
|
A summary of opened and closed workbooks.
|
|
orchestration.summary.
action_runs.by_trigger
|
Counts of action runs by trigger, either adhoc or by automation, aggregated over the last day. Emitted once daily.
adhoc: Counts of adhoc action runs by status
automated: Counts of automated action runs by status all: Counts of both adhoc and automated playbook runs by status cloudWorksEnvironment: The environment in which the Splunk SOAR cloud stack is deployed; development (dev), staging (stg), or live (lve). missionControlDeploymentID: A nullable field identifying the Splunk Mission Control instance paired to the Splunk SOAR instance soarDeploymentID: Uniquely identifies the Splunk SOAR stack that emitted the metric |
|