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.

To simplify working with the table, the Applications tab includes a search feature to quickly locate applications. The search tool 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

Search is case-insensitive and supports partial matches.

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 – Identifier for the application

  • Type Application – Indicates the agent group (Vector or Beat)

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

  • Configuration File Name – Name of the configuration file

  • Configuration – Contents of the configuration file

  • Additional Files – List of files associated with 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 must be in .tar.gz or .zip format

  • The root of the archive must contain only one top-level folder, and no files

Additionally, for proper agent type detection and configuration binding, the root folder must contain a property.yml file in 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 properties file is missing, the system will attempt to determine the agent type and config file name based on the prefix of the application name (up to the _ 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

Helpful Tips

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

When Vector is selected as the application type, the Agent Type is automatically set to vector.

If you make changes, the Revert Changes button will appear, which resets the application card to its original 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:

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

Helpful Tips

Selecting an agent type from the dropdown enables the Apply default configuration button.

When Vector is selected as the application type, the Agent Type is automatically set to vector.

The Revert Changes button restores the original application state if modifications were made.

warning

In SAF Beat Manager v4.3.0 and later, a properties file will be stored for applications created via the interface, including the agent type (e.g., ElasticBeat).

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