Get started with Splunk AR
Tie data to real-world objects and locations, add notes and media to augmented reality (AR) dashboards, and manage user permissions using the Splunk App for AR. Mobile users can then consume, interact, and take action with data where it exists in reality using the Splunk AR mobile app.
Splunk AR terminology
The following terms and definitions used in Splunk AR:
|A group of assets that share a dashboard, AR workspace, and recognition method.
|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 notes, media files, or playbooks.
|Any component in an AR workspace. A workspace object can be a visualization, note, title, media, or playbook.
|An augmented reality representation of a visualization. For example, creating an AR workspace with a dashboard that has four visualizations creates four panels.
|Text in an AR workspace.
|Any media files in an AR workspace, such as PDFs, audio files, video files, or images.
|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.
|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.
|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 are available as a form input token in dashboards and allow Splunk AR to identify and retrieve data for a particular asset.
|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 more about playbooks, see Use playbooks to automate analyst workflows in Splunk SOAR (Cloud).
Splunk AR deployments
A Splunk AR deployment consists of a group of assets, a workspace and its objects, and a dashboard selection. Each deployment gets data from a common dashboard and shares one workspace. The workspace, assets they're associated with, and their recognition methods exist within their deployments.
All registered assets must be members of one deployment. You can also create single-asset deployments.
Different ways to associate data with assets
You can use various methods for Splunk AR mobile app users to access and interact with data:
Asset tags are barcodes, Quick Response (QR) codes, or Near Field Communication (NFC) devices that store data and wirelessly send information to devices. Asset tags allow Splunk AR to identify the data you're requesting. Splunk AR supports a variety of barcodes and NFC tags.
To learn more about asset tags, see About Splunk AR Asset Tags. Associate data with asset tags, and scan the tags with your mobile device to access the data.
|Beacons are Bluetooth Low Energy (BLE) devices that broadcast their location and associated data to nearby mobile devices. Splunk AR supports the iBeacon protocol.
When you associate Splunk dashboards with beacons, Splunk AR presents the dashboards on your mobile device when it detects a beacon nearby. You can set up and configure beacons in the Splunk AR mobile app. To learn more about beacons, see About beacons with Splunk AR in the Download and Use Splunk AR manual.
|Geofences are GPS-based boundaries that allow a device to trigger an action when the device enters or exits the area.
Create a virtual boundary on a GPS map, associate dashboards with the boundary. Splunk AR then presents dashboards on your mobile device when you're located within the virtual boundary. You can create geofences in the Splunk AR mobile app. To learn more about geofences, see About geofences with Splunk AR.
Object detection lets you associate Splunk data with real-world objects without the need for asset tags. Splunk AR currently supports 2 kinds of object detection: text and logo.
Text detection uses optical character recognition (OCR) technology. It uses text as an asset identifier and a visual anchor for placing augmented reality visualizations.
Logo detection uses logos as an asset identifier and visual anchor for placing augmented reality visualizations.
You can use the same logo or string of text to distinguish multiple assets by using object detection with beacons or geofences.
Room detection lets you associate Splunk data with rooms and their objects using an Ultra Wide Band (UWB) sensor and Light Detection and Ranging (LiDAR) technology.
Room detection requires an iOS device that supports LiDAR technology.
For more information about the different ways you can associate data with real-world objects and locations, and how to choose the best method for your use case, see Should I use asset tags, beacons, or geofences with Splunk AR?.
Get started with the Splunk App for AR
Complete the following steps to get started with the Splunk App for AR:
Set up and configure Splunk Secure Gateway
Complete the following steps in Splunk Secure Gateway, a backend infrastructure that comes with your Splunk platform deployment to support the Connected Experiences apps:
Install the Splunk App for AR from Splunkbase
See Install the Splunk App for AR for installation instructions.
Mobile device steps: Download the Splunk AR mobile app and register mobile devices
Complete the following steps to set up mobile devices for Splunk AR:
- Download Splunk AR on the mobile devices using Splunk AR.
- Register your device to a Splunk instance in the Use Splunk Secure Gateway manual.
Associate assets with data
To start associating assets with Splunk dashboards, see Associate objects with dashboards in the Splunk App for AR.
You can use the sample dashboard, Splunk Stats, to create an AR workspace. Or, use one from your own instance. You can also associate the asset with a non-AR dashboard.
Manage your Splunk AR deployment
Manage your Splunk AR deployment using the admin tools in the Splunk App for AR.
Configure Splunk AR permissions
See Configure Splunk AR roles and permissions to learn how to control who can see, adjust, or manage Splunk AR objects.
Edit AR workspaces using the 3D Workspace Editor
See Edit, add notes, and associate data with workspaces in the Splunk App for AR to adjust and add media notes or playbooks to AR workspaces using a 3D editor.
Use the Splunk AR mobile app
See the following topics in the Use Splunk AR manual to get started with the Splunk AR mobile app:
|Splunk AR for iOS Documentation
|Associate objects with data using asset tags
|Associate objects with dashboards in the Splunk App for AR with asset tags
|Associate objects with data using object detection
|Associate objects with dashboards in the Splunk AR mobile app with object detection
|Associate objects with locations
|Set up and use geofences with Splunk AR
|Adjust AR workspaces
|Adjust AR workspaces and visualizations using Splunk AR
|Add and edit notes or media to AR workspaces
|Add and edit notes or media to AR workspaces using Splunk AR
|View a dashboard or AR workspace
|View Splunk dashboards and AR workspaces using Splunk AR
Get started with Splunk Edge Hub
Should I use asset tags, object detection, beacons, or geofences with Splunk AR?
This documentation applies to the following versions of Splunk® App for Edge Hub and Augmented Reality: 4.4.0, 4.5.0, 4.6.0