Splunk® Edge Hub OS

Setup and Configuration Guide

For documentation on other necessary components for Splunk Edge Hub, see the Splunk App for Edge Hub and AR documentation, Splunk Edge Hub mobile app documentation, and Splunk Edge Hub hardware documentation.
This documentation does not apply to the most recent version of Splunk® Edge Hub OS. For documentation on the most recent version, go to the latest release.

Register or unregister your Splunk Edge Hub

Start streaming data into your Splunk Edge Hub by registering it to a Splunk platform instance using the Splunk App for Edge Hub and AR.

You'll use the Splunk App for Edge Hub and AR when registering your Splunk Edge Hub. See the Splunk App for AR documentation to learn more.

Splunk Edge Hub requires token authentication to be enabled. See the following prerequisites for a resource on how to enable token authentication.

Prerequisites

Complete the following before registering your Splunk Edge Hub.

  • Get started with Splunk Edge Hub
  • Enable token authentication
  • Have the following capabilities and role:
    • Have the edit_token_http capability to register the first Edge Hub to a Splunk platform instance
    • Have the list_token_http capability to register an Edge Hub after the first one has been registered
    • Have the admin role to configure the HTTP Event Collector (HEC).

Register your Splunk Edge Hub

Complete the following steps to register your Splunk Edge Hub.

1. Register your mobile device to your Splunk platform instance

  1. On your mobile device, launch the Splunk Edge mobile app.
  2. In SSG, select + Add new device. See Log in to a Splunk platform instance in a Connected Experiences app.
  3. Select Splunk Mobile.
  4. Select Next.
  5. In the Splunk Edge mobile app, select Open camera.
  6. Use your mobile device to scan the QR code in SSG.

Your device appears on the Home page devices list. During this release, the application and platform for Edge devices is listed as Unknown. This will be resolved in a future release.

2. Configure the HTTP Event Collector (HEC) endpoint that your Hub will push events to

The admin role is required to configure the HEC endpoint.

  1. On the same instance that you registered your mobile device to with SSG, open the Splunk App for AR and Edge Hub.
  2. Navigate to the Edge Settings page.
  3. Enter the HEC hostname. This includes the protocol and port number.
  4. (Recommended) Select Test Configuration to confirm that the HEC settings are valid.
  5. Select Save.

The Test Configuration function might not validate all settings depending on your deployment type or network settings. If you encounter issues when using this function, run the following search in the Search and Reporting app to view internal logs and investigate errors:

index=_internal sourcetype = splunk_app_ar_internal_log

To remove the Edge Hub configuration, select Remove Splunk Edge configuration. This removes the HEC hostname configuration from all Edge Hubs that you've registered to this Splunk platform instance.

3. Register your Splunk Edge Hub to your mobile device

The edit_token_http capability is required to register the first Edge Hub to a Splunk platform instance. The list_token_http capability is required to register an Edge Hub after the first one has been registered.

  1. In the Splunk Edge mobile app, tap the scanning icon.
  2. Scan the QR code on your Splunk Edge Hub with your mobile device.
  3. While the Splunk Edge Hub registers, configure the network settings.
  4. (Optional) If you have more than one Splunk Edge Hub, repeat this process for all of them.

Start viewing data

After registering you Splunk Edge Hub, you can use the Edge Hub default indexes to start viewing and analyzing data. See View Splunk Edge Hub data from your Splunk platform instance to learn more.

Unregister your Splunk Edge Hub

  1. On your Splunk Edge Hub, tap the gear icon to navigate to Settings.
  2. Tap Unregister.
  3. Tap Confirm.
Last modified on 12 April, 2023
Prerequisites for Splunk Edge Hub OS   View Splunk Edge Hub data

This documentation applies to the following versions of Splunk® Edge Hub OS: beta0.12.0, beta0.15.0, beta1.2


Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters