Skip to main content
Version: 5.0

Apps

The Agent Management interface includes functionality for viewing application data, uploading applications from an archive, as well as creating, editing, and deleting applications. To open the Applications page in the SAF Beat Manager interface, navigate to: Main Menu - Settings - Smart Beat Management - Apps.

For a more user-friendly table format, the Applications tab features a search tool that allows quick access to the desired applications. The search bar is located at the top of the interface.:

Application Table

The Search field allows you to search for applications by their Name.

To use the search:

  1. Enter a query into the Search field

  2. Press Enter

warning

The search is case-insensitive and matches partial input.

Application Search

Application Details

To view detailed information about an application, select the desired row and click the application name. The application details card includes the following information:

  • Name – identifies the application

  • Type Application – specifies which agent group the application belongs to (Vector or Beat)

  • Agent Type – indicates the type of agent associated with the application

  • Configuration File Name – designates the configuration file

  • Configuration – the content of the configuration file

  • Additional Files – a list of embedded files related to the application

Application Details

Uploading an Application from an Archive

To upload an application from an archive via the SAF Beat Management interface:

  1. Prepare the application archive file and drag it into the upload area or click the upload area to select the archive from your file system:

Application Upload Window

  1. Click the Upload button:

Upload Confirmation

warning

The application archive file must meet the following criteria:

  • Archive extension must be tar.gz or zip

  • The archive must contain only one root folder at its root level and no loose files

Additionally, for correct agent type detection and configuration file binding, the root folder must include a property.yml file with the following format:

property:
config_name: <config_name>.yml
agent_type: <agent_type>

Where <agent_type> is the lowercase agent type and <config_name> is the configuration file name.

If the application property file is missing, the application's agent type and configuration file name will be derived from the application name prefix before the first _ character.

Creating an Application

To create an application using the SAF Beat Management interface:

  1. Click the Create button to the right of the search bar:

Application Creation Window

  1. Fill in the required fields and optionally upload Additional Files:
  • Name

  • Type application (Vector or Beat)

  • Agent type

  • Configuration file name

  • Configuration

Useful information!

Selecting an agent type from the dropdown enables the Apply default configuration button, which fills in the default config.

When the Vector application type is selected, the agent type field is automatically populated with the value vector.

During edits, the Discard Changes button becomes available, which reverts the application card to its initial state.

  1. Click Save to add the new application to the system

Editing an Application

To edit an existing application in the SAF Beat Management interface:

  1. Select the desired row and click on the application name:

Application Edit Window

  1. Modify one or more of the following fields:
  • Type application (Vector or Beat)

  • Agent type

  • Configuration file name

  • Configuration

  • Additional files

Useful information!

When selecting an agent type from the dropdown list, the Apply Default Configuration button becomes enabled. This button populates the configuration field with default settings.

If the application type Vector is selected, the agent type field is automatically set to vector.

While editing, the Discard Changes button appears - clicking it resets the application card to its original state.

warning

For applications created through the SAF Beat management interface in version 4.3.0, the system will store an application property file containing agent specifications, including the ElasticBeat agent type.

For legacy applications created before v4.3.0 without a properties file, backward compatibility is maintained, but changing the agent type is not possible since it's inferred from the application name.

  1. Click Save to apply the changes

Deleting an Application

To delete an application via the SAF Beat Management interface:

  1. Click the Trash icon at the end of the application row

  2. Confirm deletion by clicking the Delete button

Application Deletion Confirmation