Get started with Splunk AR

Turn Splunk data into augmented reality (AR) and view dashboards on your mobile device with Splunk AR. View AR workspaces and Splunk dashboards by scanning Splunk generated QR codes and NFC tags with your mobile device.

What are AR workspaces?

An AR workspace is a camera overlay of a collection of single value or gauge visualizations. The AR visualizations contain live data from your Splunk Enterprise instance. You can view AR workspaces, adjust the position and dimensions of AR workspaces and their visualizations, and add notes to AR workspaces on your mobile device.

See Visualization support in the Splunk Cloud Gateway Release Notes Manual for more information about compatible visualizations.

What are QR codes and NFC tags? Which one should I use?

QR (quick response) codes and NFC (near field communication) tags store data and wirelessly send information to devices. Securely access Splunk data with a mobile device registered to your own Splunk instance.

QR codes

QR codes save the exact position of workspaces and visualizations for subsequent scans. However, QR codes rely on image processing and require adequate lighting for scanning.

NFC tags

Using NFC tags and an NFC writer (such as an Android device), you can render AR workspaces more efficiently. NFC tags have a faster, more successful scan rate than QR codes because they don't rely on the environment or image processing. You can save the exact position of workspaces and visualizations for subsequent scans with a detection image attached to the NFC tag.

See Save Splunk AR workspace placement with NFC tags in the Splunk Cloud Gateway Use Splunk Cloud Gateway manual for more information about how to use a detection image with your NFC tag.

QR codes are useful to get started with Splunk AR because they allow you to simply print, place, and scan. However, using NFC tags with a detection image is best practice because NFC doesn't depend on the environment or image processing, resulting in faster and more successful scanning. You can purchase NFC tags and an NFC writer online or use an Android device as an NFC writer.

Set up Splunk AR

To get started with Splunk AR, you need to use Splunk Cloud Gateway, a required companion Splunk Enterprise app. Install Splunk Cloud Gateway, configure permissions, enable Splunk AR, and register your device. Then, create QR codes and NFC tags for Splunk AR using Splunk Cloud Gateway, and scan the QR codes or NFC tags with your mobile device to view AR workspaces with Splunk AR.

1. Install Splunk Cloud Gateway

An admin with the cloudgateway role must install Splunk Cloud Gateway.

1. Launch Splunk Enterprise.
2. Log in.
3. Download the LAR version of Splunk Cloud Gateway from Splunkbase.
4. Click the Apps gear icon in Splunk Enterprise.
5. Click Install app from file.
6. Click Choose File and select the downloaded Splunk Cloud Gateway file.
7. Click Upload.
8. Restart Splunk Enterprise.

See Install Splunk Cloud Gateway in the Splunk Cloud Gateway Installation manual for prerequisites and more information about installation steps.

2. Download Splunk AR

Install Splunk AR from the App Store.

1. On your mobile device, launch the App Store.
2. Search for "Splunk AR."
3. Tap the Splunk AR app.
4. Tap Get.
5. Log in with your Apple ID. Splunk AR downloads on your device.

See Download Splunk AR in the Splunk AR Installation manual for prerequisites and more information about installation steps.

3. Configure permissions

Users must have the cloudgateway role to access Splunk Cloud Gateway and to view dashboards on their mobile device. Only admins with the cloudgateway role can add or remove users from a role in Splunk Web.

To add or remove a user from the cloudgateway role, do the following.

1. Log in as a user with the Splunk admin role.
2. In Splunk Web, click Settings > Access Controls.
3. Click Users.
4. Click Edit.
5. In the Assign to roles section, click cloudgateway to add or remove it.
6. Click Save.

To configure dashboard permissions so that users can view dashboards in the Connected Experiences apps, do the following.

1. Navigate to the Dashboards tab of Splunk Web.
2. Click Edit > Edit Permissions next to the dashboard you want to configure permissions for.
3. Click All Apps if the dashboard isn't from the Search & Reporting app, or click App if the dashboard is from the Search & Reporting app.
4. Check Read for the Cloud Gateway role.
5. Click Save.

4. Enable Splunk AR

Only users with the admin role and the cloudgateway role can enable and disable apps.

1. In Splunk Cloud Gateway, select the Configure tab.
2. Select which apps to you to enable or disable. Your configuration applies to all registered devices.

5. Register a device

Any user with the cloudgateway role can register a device. You do not need the admin role to register a device. Devices with a Connected Experiences app installed have a registration code in the app.

1. Log in to Splunk Cloud Gateway.
2. On the Register tab in Splunk Cloud Gateway, enter the 10-digit code provided by the mobile device.
3. Name the device.
4. Click Register.
5. Ensure that the confirmation code matches the confirmation code on the device.
6. Log in with your Splunk.com credentials to complete registration.

How do I view an AR workspace?

Before you can view an AR workspace, you need access to a QR code or NFC tag created in Splunk Cloud Gateway.

1. Create a compatible dashboard

Splunk Cloud Gateway comes with a compatible dashboard that'll help you learn how to create an AR workspace. This dashboard is titled Splunk Stats. You can use this sample dashboard, or create your own with up to nine single value or gauge visualizations on your Splunk Enterprise instance.

See Visualization support in the Splunk Cloud Gateway Release Notes manual for more information about compatible visualizations.

2. Create an AR workspace

1. In Splunk Cloud Gateway, navigate to the Splunk > AR tab.
2. Click Create AR Workspace next to the dashboard you want to generate a QR code or NFC URL for.
3. Click Confirm.
4. Enter a workspace title. The default title is the name of the dashboard in the Search & Reporting app.
5. Configure each panel:
   1. Click Edit.
   2. Select a visualization type. With a gauge icon, you can set value ranges and colors.
   3. Label your visualization. This is the label that Splunk AR users will see on their mobile device.
   4. Click Save.
6. Repeat the previous step for each panel.
7. Click Save.

3. Create the QR code or NFC URL


1. In Splunk Cloud Gateway, navigate to the Splunk > AR tab.
2. Next to the workspace you want to generate a QR code or NFC URL for, select Get QR code or Get NFC URL.
3. Print and place the QR code, or use a NFC writer to write a tag with the NFC URL for Splunk AR users to scan.
   If you're using an NFC tag, see Save AR workspace placement with NFC tags to set up a detection image so that you can save the orientation of your workspaces for future scans.
   

4. View the AR workspace

In Splunk AR on your mobile device, you can view an AR workspace by scanning a QR code or NFC tag that was created on Splunk Cloud Gateway.

To scan a QR code, position your mobile device in front of a QR code.

Here's how to scan an NFC tag.

1. Tap the NFC scanning button.
2. Tap your phone to an NFC tag.

How do I view standard dashboards with Splunk AR?

You can also view standard non-AR Splunk dashboards by scanning QR codes and NFC tags. Non-AR Splunk dashboard panels don't have to be single value or gauge visualizations. However, not all visualizations are supported. See Visualization support for compatible visualizations.

1. Create a compatible dashboard

Create a dashboard on your Splunk Enterprise instance. See Visualization support in the Splunk Cloud Gateway Release Notes manual for more information about compatible visualizations.


2. Create the QR code or NFC URL

1. Navigate to the Splunk > AR tab in Splunk Cloud Gateway.
2. Click the Dashboards tab to toggle to the Splunk Dashboards screen.
3. Next to the dashboard you want to generate a QR code or NFC URL for, select Get QR code or Get NFC URL.
4. Print and place the QR code, or use a NFC writer to write a tag with the NFC URL for Splunk AR users to scan.

3. View the standard Splunk dashboard

View standard non-AR dashboards the same way you scan QR codes and NFC tags for AR workspaces.

You can also tap the dashboards icon to view recently scanned non-AR dashboards.

How do I adjust AR workspaces?

Resize the workspace or a visualization

1. Scan an AR workspace QR code or NFC tag.
2. Tap the workspace title to resize the workspace, or tap a visualization to resize a visualization.
3. Pinch or expand your fingers to resize the workspace or visualization.
4. Tap Save.

Reposition the workspace or a visualization

1. Scan an AR workspace QR code or NFC tag.
2. Long press the workspace title to reposition the workspace, or a visualization to reposition a visualization.
3. While holding the workspace title or visualization, move your device. The workspace or visualization moves with your mobile device.
4. Release the workspace or visualization where you want to place it.
5. Tap Save.

How do I add AR workspace notes?

Add workspace notes to clearly communicate workspaces to Splunk AR users. See Add and edit workspace notes in the Use Splunk AR manual.