Understand Splunk AR terminology and deployments
Before using Splunk AR, get to know the Splunk AR terminology and how Splunk AR deployments work.
Splunk AR terminology
The following are definitions of terms used in Splunk AR:
Term | Definition |
---|---|
Workspace | A container for live data retrieved from Splunk dashboards. A workspace can consist of visualization panels that you can overlay on real-world objects in a camera view, or two dimensional mobile-friendly visualizations. A workspace can also include objects such as notes, media files, or playbooks. |
Object | Any component in an AR workspace. An object can be a visualization, note, title, media, or playbook. |
Panel | An augmented reality representation of a visualization. For example, creating an AR workspace with a dashboard that has four visualizations creates four panels. |
Note | Text in an AR workspace. |
Media | Any media files in an AR workspace, such as PDFs, audio files, video files, or images. |
Asset | Any real-world object that you want to associate an AR workspace or Splunk dashboard with. For example, a machine with a barcode or a logo image. |
Deployment | A collection of assets that define a dashboard selection and are associated with one workspace. |
Asset tag | A visual representation of an asset that contains an asset ID. For example, a barcode, QR code, or NFC tag. To learn more about asset tags, see About Splunk AR asset tags. |
Asset group | A group of assets that might have different names or asset tags, but share the same data. |
Asset Identifier (Asset ID) | An identifier that's encoded in an asset tag. For example, the value of a UPC barcode, or a URL encoded in a QR code or NFC tag. Asset IDs allow Splunk AR to identify and retrieve data for a particular asset. |
Playbook | Playbooks are Python scripts that execute various actions in response to an incident. You can integrate playbooks into AR workspaces to guide users through real-world tasks. To learn how to use playbooks in Splunk AR, see Enable Splunk AR Workflow Automation. |
What are Splunk AR deployments?
A Splunk AR deployment consists of a group of assets, a workspace, and a dashboard selection. Each deployment gets data from a common dashboard and shares one workspace. All registered assets must be members of one deployment. You can also create single-asset deployments.
The following diagram describes the Splunk AR deployment architecture:
This documentation applies to the following versions of Splunk® App for Edge Hub and Augmented Reality: 2.0.0
Feedback submitted, thanks!