Activate the CSV Collector - Administrator Guide - Cortex XDR - Cortex - Security Operations

Cortex XDR Pro Administrator Guide

Cortex XDR
Creation date
Last date published
Administrator Guide


Ingesting Logs and Data from external sources requires a Cortex XDR Pro per GB license.

The Broker VM provides a CSV Collector applet that enables you to monitor and collect CSV (comma-separated values) log files from a shared Windows directory directly to your log repository for query and visualization purposes. After you activate the CSV Collector applet on a Broker VM in your network, you can ingest CSV files as datasets by defining the list of folders mounted to the Broker VM and setting the list of CSV files to monitor and upload to Cortex XDR using a username and password.

Be sure you do the following tasks before you begin setting up the CSV Collector applet.

  • Configure the Broker VM.

  • Ensure that you share the applicable CSV files.

  • Know the complete file path for the Windows directory.

Activate the CSV Collector.

  1. Select SettingsConfigurationsData BrokerBroker VMs.

  2. In either the Brokers tab or the Clusters tab, locate your Broker VM.

  3. You can either right-click the Broker VM and select Add AppCSV Collector, or hover in the APPS column, and select AddCSV Collector.

  4. Configure your CSV Collector by defining the list of folders mounted to the Broker VM and specifying the list of CSV files to monitor and upload to Cortex XDR. You must also specify a username and password.

    1. Mounted Folders

      • FOLDER PATH—Specify the complete file path to the Windows directory containing the shared CSV files using the format: //host/<folder_path>. For example, //testenv1pc10/CSVFiles.

      • USERNAME—Specify the username for accessing the Windows directory.

      • PASSWORD—Specify the password for accessing the Windows directory.

      After you configure the mounted folder details, Add (plus_sign_add_icon.png) details to the applet.

    2. Monitored CSV Files

      • FOLDER PATH+NAME—Select the monitored Windows directory and specify the name of the CSV file. Use a wildcard file search using these characters in the name of the directory, CSV file name, and Path Exclusion.

        - ?—Matches a single char, such as 202?-report.csv.

        - *—Matches either multiple characters, such as 2021-report*.csv, or all CSV files with *.csv.

        -**—Searches all directories and subdirectories

        For example, if you want to include all the CSV files in the directory and any subdirectories, use the syntax //host/<folder_path>/**/*.csv.


        When you implement a wildcard file search, ensure that the CSV files share the same columns and header rows as all other logs that are collected from the CSV files to create a single dataset.

      • PATH EXCLUSION—(Optional) Specify the complete file path for any files from the Windows directory that you do not want included. The same wildcard file search characters are allowed in this field as explained above for the FOLDER PATH+NAME field. For example, if you want to exclude any CSV file prefixed with 'exclude_' in the directory and subdirectories of //host/<folder_path>, use the syntax //host/<folder_path>/**/exclude_*.csv>.

      • TAGS—(Optional) To easily query the CSV data in the database, you can add a tag to the collected CSV data. This tag is appended to the data using the format <data>_<tag>.

      • TARGET DATASET—Either select the target dataset for the CSV data or create a new dataset by specifying the name for the new dataset.

  5. Activate the CSV Collector applet.

    After a successful activation, the APPS field displays CSV with a green dot indicating a successful connection.


    The CSV Collector checks for new CSV files every 10 minutes.

  6. (Optional) To view metrics about the CSV Collector, hover over the CSV connection in the APPS field for your Broker VM.

    Cortex XDR displays Resources, including the amount of CPU, Memory, and Disk space the applet is using.

  7. Manage the CSV Collector.

    After you activate the CSV Collector, you can make additional changes as needed. To modify a configuration, hover over the CSV connection in the APPS column to display the CSV settings, and select:

    • Configure to redefine the CSV Collector configurations.

    • Deactivate to disable the CSV Collector.

    You can also Ingest CSV Files as Datasets.