Configure the Tetra File-Log Agent in the Cloud
NOTE
The following configuration option is available for File-Log Agent (FLA) 4.1 or later only.
Prerequisites
Before you can configure the Tetra File-Log Agent (FLA) in the cloud, you must do the following:
- Create a new Tetra File-Log Agent.
- From the Tetra File-Log Agent's Management Console, select Yes for the Receive Commands option. For instructions, see the Tetra File-Log Agent documentation.
- Install the Tetra File-Log Agent on a machine. For more information, see Tetra File-Log Agent Installation Guide (Version 4.0.x).
Available Configuration Methods
You can configure the Tetra File-Log Agent by using either of the following methods:
- Enter configuration details in the Management Console on the machine where the Tetra File-Log Agent is installed. For more information, see Tetra File-Log Agent Installation Guide (Version 4.0.x).
- Enter configuration details in the Cloud Configuration window by completing the following instructions.
Configure the Tetra File-Log Agent in the Cloud Configuration Window
To configure the Tetra File-Log Agent in the Cloud Configuration window:
- From the Cloud Configuration window, choose TDP. The TDP Agents page appears.
- On the Agents page, select the name of the agent that you want to configure. A menu appears on the right.
- Choose Receive Commands. A message appears that asks you to confirm if you want to enable the agent's queue.
- Choose Yes.
- From the right menu, choose Configure.
- On the Configure page, configure the following Tetra File-Log Agent settings:
- For Start Date, enter the date you want to begin using the configuration.
- For File Change Interval (Seconds), enter the file change interval that you want in seconds. Then, set the Path Configurations and File Watcher settings. For more information about each setting, see the File Path Configuration Options table on this page and the Tetra File-Log Agent Installation Guide.
- Choose Overwrite Local with Existing Cloud Configuration.
NOTE
If aCloud/Local Configuration is Out of Sync message displays, then the agent's cloud and local configurations are different. To review the differences, choose the Review Cloud Configuration and Review Local Configuration buttons. Based on the differences, you can decide to push the configuration or reject it.
Path Configuration Options
| Parameter | Description |
|---|---|
| Status | Indicates if a path is accessible or not (valid or invalid) |
| File change interval (in seconds) | Determines the amount of idle time before the agent uploads the file and scans the file path to detect changes |
| Path | Shows the folder paths that are monitored by File Watcher |
| Watch Mode | Provides two modes: File mode monitors files to see if they've been updated, and Folder mode monitors the folder directory to check for changes |
| Patterns | Glob pattern to filter the file or folder |
| Source Type | (Mandatory) Defines the file's data source and triggers the file's associated pipeline |
| Labels | Added in TDP 3.5 Displays path level labels (name/value pairs). User may select from existing label names or add new label names. Note: (For TDP v3.5) Four labels are applied by default, but can be removed: vendor, software, instrument_type, and instrument_model. Pre-defined values for these 4 labels are fetched from Tetra Catalog. User may select from those values or enter their own if the value is not present in the dropdown. |
| Metadata | Optional, immutable key/value pairs attached as native Amazon Simple Storage Service (Amazon S3) metadata to the underlying Amazon S3 object |
| Tag | Optional, immutable strings attached as native Amazon S3 metadata to the underlying Amazon S3 object |
| Archive/Delete | (For FLA v4.3 and later) If File Watch Mode is set to file, then the following read-only Archive information appears: -Archive files to folder (toggle)—indicates if archive settings are activated or not -Archive to—shows the root folder where archived files are stored -Archive time and unit—shows the amount of time after successful file upload -Delete file from archive permanently (toggle)—indicates if delete settings are activated or not -Delete time and unit—shows the amount of time that after a file has been archived and when it becomes eligible to be deleted |
| Fetch OS file / folder owner | (For FLA v4.3 and later)Fetch the OS file (or folder if the File Watch Mode is Folder) creator information and add as a metadata to the file during upload |
Updated 12 months ago