Activate the Files and Folders Collector

The broker VM provides a Files and Folders Collector applet that enables you to monitor and collect logs from files and folders in a network share.
Ingesting logs and data from external sources requires a Cortex® XDR™ Pro per TB license.
The broker VM provides a Files and Folders Collector applet that enables you to monitor and collect logs from files and folders in a network share for a Windows or Linux directory, directly to your log repository for query and visualization purposes. A maximum file size of 500 MB is supported. After you activate the Files and Folders Collector applet, you can collect files as datasets (
<Vendor>_<Product>_raw
) by defining the following.
  • Details of the folder path on the network share containing the files that you want to monitor and upload to Cortex XDR.
  • Settings related to the list of files to monitor and upload to Cortex XDR, where the log format is either JSON, CSV, or Raw (default).
Complete the following task before you begin setting up the Files and Folders Collector applet.
  • Know the complete path to the files and folders that you want Cortex XDR to monitor.
  • Ensure that the user permissions for the network share include the ability to rename and delete files in the folder that you want to configure collection.
Activate the Files and Folders Collector.
  1. In Cortex XDR, select
    Settings ( )
    Configurations
    Broker VM
    and locate your broker VM.
  2. Right-click the broker VM and select
    Files and Folder Collector
    Activate
    .
  3. Configure the Files and Folders Collector settings.
    1. Configure the
      Shared Folder Connection
      settings.
      • Folder Path
        —Specify the path to the files and folders that you want Cortex XDR to monitor continuously to collect the files. The following formats are available based on the type of machine you are using.
        • Windows
          \\<hostname>\<shared_folder>
          or
          smb://<hostname>/<shared_folder>
        • Linux
          /<srv>/<shared_folder>
          or
          nfs://<srv>/<shared_folder>
          When using the Linux file share, including the Linux share with nfs, a
          Username
          and
          Password
          is not required, so these fields are grayed out in the screen.
      • Recursive
        —Select this checkbox to configure the Files and Folders Collector applet to recursively examine any subfolders for new files as long as the folders are readable. This is not configured by default.
      • Username
        —Specify the username to access the shared resource using a User Principal Name (UPN) format.
      • Password
        —Specify the password to access the shared resource.
      • Test Connection
        —Select to validate the connection and permissions.
    2. Configure the
      File and Folder Settings
      .
      • Collect Every
        —Specify the execution frequency of collection by designating a number and then selecting the unit as either
        Minutes
        ,
        Hours
        , or
        Days
        .
      • After Files Uploaded
        —Select what to do with the files after they are uploaded to the Cortex XDR server. You can either select
        Rename files with a suffix
        (default) and then you must specify the
        Suffix
        or
        Delete files
        . When adding a suffix, the suffix is added at the end of the original file name using the format
        <file name>.<suffix>
        , which becomes the new name of the file.
      • Include
        —Specify the files and folders that must match to be monitored by Cortex XDR. Multiple values are allowed with commas separating the values.
        Allowed wildcard:
        • '?' matches a single alphabet character in a specific position.
        • '*' matches any character or set of characters, including no character.
        Example:
        log*.json
        includes any JSON file starting with 'log'.
      • Exclude
        —(
        optional
        ) Specify the files and folders that must match to not be monitored by Cortex XDR. Multiple values are allowed with commas separating the values.
        Allowed wildcard:
        • '?' matches a single alphabet character in a specific position.
        • '*' matches any character or set of characters, including no character.
        Example:
        *.backup
        excludes any file ending with '.backup'.
      • Log Format
        —Select the
        Log Format
        from the list as either
        Raw
        (default),
        JSON
        , or
        CSV
        . This setting defines the parser used to pars all the processed files as defined in the
        Include
        and
        Exclude
        fields, regardless of the file names and extension. For example, if the
        Include
        field is set
        *
        and the
        Log Format
        is
        JSON
        , all files (even those named
        file.log
        ) in the specified folder are processed by the Files and Folders Collector as JSON, and any entry that does not comply with the JSON format are dropped.
        When uploading
        JSON
        files, Cortex XDR only parses the first level of nesting and only supports single line JSON format, such that every new line means a separate entry.
      • # of Lines to Skip
        —(
        optional
        ) Specify the number of lines to skip at the beginning of the file. This is set to 0 by default.
    3. Configure
      Data Source Mapping
      settings.
      Vendor
      and
      Product
      —Specify the
      Vendor
      and
      Product
      for the type of data being collected. The vendor and product are used to define the name of your XQL dataset (
      <Vendor>_<Product>_raw
      ).
    4. Generate Preview
      .
      Select
      Generate Preview
      to display up to 10 rows from the first file and
      Preview
      the results. The
      Preview
      works based on the Files and Folders Collector settings, which means that if all the files that were configured to be monitored were already processed, then the
      Preview
      returns no records.
  4. (
    optional
    )
    Add Connection
    to define another Files and Folders connection for collecting logs from files and folders in a shared resource.
  5. (
    optional
    ) Other available options.
    As needed, you can return to your Files and Folders Collector settings to manage your connections. Here are the actions available to you.
    • Edit the connection name by hovering over the default
      Collection
      name, and selecting the edit icon to edit the text.
    • Disable
      /
      Enable
      a connection by hovering over the top area of the connection section, on the opposite side of the connection name, and selecting the applicable button.
    • Delete a connection by hovering over the top area of the connection section, on the opposite side of the connection name, and selecting the delete icon. You can only delete a connection when you have more than one connection configured. Otherwise, this icon is not displayed.
  6. Activate
    the Files and Folders Collector applet.
    After a successful activation, the
    Apps
    field displays
    Files and Folders Collector - Active
    .
  7. (
    Optional
    ) To view metrics about the Files and Folders, hover over the
    Files and Folders Collector
    link in the Apps field.
    Cortex XDR displays
    Resources
    , including the amount of
    CPU
    ,
    Memory
    , and
    Disk
    space the applet is using.
  8. Manage the Files and Folders Collector.
    After you activate the Files and Folders Collector, you can make additional changes as needed. To modify a configuration, right-click your broker VM and select:
    • Files and Folders Collector
      Configure
      to redefine the Files and Folders Collector configurations.
    • Files and Folders Collector
      Deactivate
      to disable the Files and Folders Collector.

Recommended For You