Breadcrumbs

Initialize the Darktrace Beat

Prerequisites

  • Open Collector is installed. If you have not already installed it, follow the instructions in the Open Collector Installation and User Guide, and then return to this topic.

  • A public key and private key have been generated in the Darktrace portal, as described in Darktrace Portal Configuration.

  • The following port is open:

    Direction

    Port

    Protocol

    Source

    Outbound

    443

    HTTPS

    darktracebeat

Initialize the Beat via the Web Console (Recommended)

  1. Ensure that the Open Collector Connection to the SIEM (WebUI) setup has been completed.

  2. Ensure that the System Monitor Agent to which you intend to send these logs has been Configured for JSON Parsing.

Use either the Enable JSON Parsing on System Monitor Agents or the Enable JSON Parsing for an Existing System Monitor Agent sections at the above link to configure the System Monitor Agent for JSON Parsing.

  1. Follow the steps outlined in Add a Beat in the Web Console to create the Beat via the Web UI.

Initialize the Beat via Command Line (Legacy)

  1. In the Open Collector, run the following command to start the beat:

    ./lrctl darktracebeat start

  2. Use the Up and Down Arrow keys to select New darktracebeat instance from the list, and then press Enter.                       

  3.  Enter a unique identifier for this Darktrace beat instance, and then press Enter.  

  4.  Enter the Darktrace domain name, and then press Enter.

  5. Enter the Darktrace Public Key for authentication, and then press Enter. 

  6. Enter the Darktrace Private Key for authentication, and then press Enter.

  7. Enter the hostname or IP address of the System Monitor Agent that has been Configured for JSON Parsing, and then press Enter.

Use either the Enable JSON Parsing on System Monitor Agents or the Enable JSON Parsing for an Existing System Monitor Agent sections at the above link to configure the System Monitor Agent for JSON Parsing.

  1. Enter the port on which the System Monitor Agent is configured to listen for JSON data (the default is 5044), and then press Enter.
    The Darktracebeat service started message appears.

  2. Check the status of the service to confirm that it’s running:

    ./lrctl darktracebeat status

  3. (Optional) Edit the darktracebeat configuration to update the values set above if needed. Ensure that you have all the needed information for each step available as you will need to re-enter it:

    ./lrctl darktracebeat config edit


Default Config Values for the Darktrace Beat

S.No

Field Name

Default Values

1

heartbeatinterval

60s

2

heartbeatdisabled

false

3

period

2s

4

throttlingIntervalSecs

60

This field value should always be greater than 0.

5

numbackhoursData

7

The Darktrace Beat supports up to 180 hours of backlog data. The range for this value is 1-180 hours.

6

limit

1000

The supported limit range is 1-1000.