App Template (Version 2)

/Introduction/

Data collected

\Add all the data sources and respective polling interval information\

Polling Interval	Data
{{Polling time in minutes}}	{{Data sources}}

Example:

Polling Interval	Data
5 min	Team Events

Log types

Sample log messages

Your json message goes here

Sample queries

Your query goes here

Setup

Vendor configuration

Prerequisites (if any)

\NOTE: This section doesn't apply to all sources; use only where needed\

Example: You'll need a Dropbox App Key, App Secret, and Access Code to provide to Sumo Logic. To generate these credentials, ....

\Insert steps to configure the Source in the Vendor UI\

Example: Refer to Split vendor configuration

Source configuration

\Insert steps to configure the Source in the Sumo Logic UI\

Example: Split source configuration

Metadata fields (If any)

\Insert metadata fields in the Sumo Logic UI. Update the below table accordingly.\

Field	Value	Description
{{field}}	{{value}}	{{Description}}

Installing the Split app

To install the app, do the following:

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Install App.
   note

   Sometimes this button says Add Integration.

4. Click Next in the Setup Data section.
5. In the Configure section of your respective app, complete the following fields.
   1. Key. Select either of these options for the data source.
      • Choose Source Category and select a source category from the list for Default Value.
      • Choose Custom, and enter a custom metadata field. Insert its value in Default Value.
6. Click Next. You will be redirected to the Preview & Done section.

Post-installation

Once your app is installed, it will appear in your Installed Apps folder, and dashboard panels will start to fill automatically.

Each panel slowly fills with data matching the time range query and received since the panel was created. Results will not immediately be available, but will update with full graphs and charts over time.

Viewing Split dashboards

All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.

• You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. Learn more.
• You can use template variables to drill down and examine the data on a granular level. For more information, see Filtering Dashboards with Template Variables.
• Most Next-Gen apps allow you to provide the scope at the installation time and are comprised of a key (_sourceCategory by default) and a default value for this key. Based on your input, the app dashboards will be parameterized with a dashboard variable, allowing you to change the dataset queried by all panels. This eliminates the need to create multiple copies of the same dashboard with different queries.

Dashboard 1 (example: Overview)

\Descriptions of each app dashboard.
\This section has dashboard description, use cases, and screenshot for each dashboard.\

The Split - Overview dashboard provides a quick snapshot of ....

Dashboard 2 (example: Users and Groups)

\Descriptions of each app dashboard.
\This section has dashboard description, use cases, and screenshot for each dashboard.\

The Split - Users and Groups dashboard provides a quick snapshot of ....

Upgrade/Downgrade the Split app (Optional)

To update the app, do the following:

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
   Optionally, you can identify apps that can be upgraded in the Upgrade available section.
3. To upgrade the app, select Upgrade from the Manage dropdown.
   1. If the upgrade does not have any configuration or property changes, you will be redirected to the Preview & Done section.
   2. If the upgrade has any configuration or property changes, you will be redirected to Setup Data page.
      1. In the Configure section of your respective app, complete the following fields.
         • Key. Select either of these options for the data source.
           • Choose Source Category and select a source category from the list for Default Value.
           • Choose Custom and enter a custom metadata field. Insert its value in Default Value.
      2. Click Next. You will be redirected to the Preview & Done section.

Post-update

Your upgraded app will be installed in the Installed Apps folder, and dashboard panels will start to fill automatically.

note

See our Release Notes changelog for new updates in the app.

To revert the app to a previous version, do the following:

1. Select App Catalog.
2. In the Search Apps field, search for and then select your app.
3. To version down the app, select Revert to < previous version of your app > from the Manage dropdown.

Uninstalling the Split app (Optional)

To uninstall the app, do the following:

1. Select App Catalog.
2. In the 🔎 Search Apps field, run a search for your desired app, then select it.
3. Click Uninstall.