Skip to main content
Skip table of contents

Initialize the Gmail Message Tracking Beat


Prerequisites

  • The 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.
  • You have the required keys: GCP Credential file contents, GCP Project ID, and the GCP BigQuery Dataset name.
  • The following port is open:

    Direction

    Port

    Protocol

    Source

    Outbound443HTTPSgmtbeat

Initialize the Beat

  1. Confirm the Open Collector is running:

    CODE
    ./lrctl status

    You should see the open_collector and metrics as shown in the following graphic:

    If the Open Collector is not running correctly, see the Troubleshoot the Open Collector topic in the Open Collector Installation and User Guide.
  2. Start the beat:

    CODE
    ./lrctl gmtbeat start
  3. Enter the following details:

    Starting with GMT Beat version 0.1.2, the contents of this user credential file are saved in encrypted format.

    1. GCP credential file contents:

    2. GCP Project ID:
    3. GCP BigQuery Dataset name:

      To change the dataset name in the beat after changing the configuration, use the following to delete the previous position file and re-enable log collection:

      Delete Position File

      BASH
      rm /var/lib/docker/volumes/gmtbeat_logs/_data/pos.json
    The configuration has been saved and the service has been started successfully.
  4. Check the status of the service:

    CODE
    ./lrctl gmtbeat status

Default Config Values for GMTBeat:

S. No.

Field Name

Default Value

1.projectUser Provided
2.HeartbeatInterval5m0s 
3.HeartbeatDisabledfalse
4.CredentialsFile/beats/gmtbeat/config/gmt_credentials.json 

5.

DatadetUser Provided
6.NumberOfBackDays7
7.Period10s



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.