The Gmail Trace Logs integration pulls the Gmail log from the BigQuery using BigQuery Library APIs and ingests them into the Sumo Logic to store, analyze, and alert.
The Gmail Trace Logs integration will query a single data source (BigQuery). The Gmail Trace Logs Source ingests the following:
Metadata fields will be set, if the integration is configured with the SIEM forward option. See Metadata Fields table below:
|_siemparser||/Parsers/System/Google/GCP BigQuery Gmail|
Setup and Configuration
Follow the below steps to get the Service Account's Credential JSON file to to complete the authorization process.
- Open IAM & Admin under Google Cloud Console.
- Select the Service Account tab.
- From the project dropdown button, select the project where you will run the BigQuery jobs.
- Click on Create a Service Account and follow the instructions in Create service accounts google cloud docs.
- Click on the email address provisioned during the creation and then click the KEYS tab.
- Click ADD KEY and choose Create new key.
- Select key type as JSON.
- Click Create. A JSON key file is downloaded to your computer.
Gmail Trace Logs source is a fully managed enterprise data warehouse that helps you to manage and analyze your data. When you create an Gmail Trace Logs source, it goes through the following stages:
- Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
- Started. A collection task is created on the Hosted Collector.
- Initialized. The task configuration is complete in Sumo Logic.
- Authenticated. The Source successfully authenticated with Gmail Trace Logs.
- Collecting. The Source is actively collecting data from Gmail Trace Logs.
If the source has any issues during any one of these states, it is placed in an Error state.
When you delete the source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector. On the Collection page, the Health and Status for Sources is displayed. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.
Create Gmail Trace Logs Source
When you create an Gmail Trace Logs Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.
To configure Gmail Trace Logs Source:
- In Sumo Logic, select Manage Data > Collection > Collection.
- On the Collection page, click Add Source next to a Hosted Collector.
- Search for and select Gmail Trace Logs.
- Enter a Name for the Source. The description is optional.
- (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called
- (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
- A green circle with a check mark is shown when the field exists in the Fields table schema.
- An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
- Project ID. Enter the unique identifier number. You can find this from the Google Cloud Console.
- Dataset ID. Enter the ID. The Dataset ID is the project-wise unique identifier for your dataset.
- Data Location. Enter the location of DataSet which is set while creating Dataset in BigQuery.
- Private Key. Enter the private key of Service Account JSON. This is a security key which is required for authentication. You can find this from the Google Cloud Console.
- Client Email. Enter the user email collected from the Google Cloud Console.
- Token URI. Enter the token URI used for generating the token. You can find this from the Google Cloud Console.
- The Collection should begin is set to 24 Hours ago by default. You can adjust it based on your needs.note
If you set Collection should begin to a collection time that overlaps with data that was previously ingested on a source, it may result in duplicated data to be ingested into Sumo Logic.
- (Optional) Processing Rules for Logs. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
- When you are finished configuring the Source, click Save.
When Sumo Logic detects an issue, it is tracked by Health Events. The following table shows the three possible error types, the reason for the error, if the source attempts to retry, and the name of the event log in the Health Event Index.
|Type||Reason||Retries||Retry Behavior||Health Event Name|
|ThirdPartyConfig||Normally due to an invalid configuration. You'll need to review your Source configuration and make an update.||No retries are attempted until the Source is updated.||Not applicable||ThirdPartyConfigError|
|ThirdPartyGeneric||Normally due to an error communicating with the third-party service APIs.||Yes||The Source will retry indefinitely.||ThirdPartyGenericError|
|FirstPartyGeneric||Normally due to an error communicating with the internal Sumo Logic APIs.||Yes||The Source will retry indefinitely.||FirstPartyGenericError|
Restarting your Source
If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.
To restart your source in the Sumo Logic platform, follow the steps below:
- Open the Collection page, and go to Manage Data > Collection > Collection.
- Select the source and click the information icon on the right side of the row.
- The API usage information popup is displayed. Click the Restart Source button on the bottom left.
- Click Confirm to send the restart request.
- The bottom left of the platform will provide a notification informing you the request was successful.
To restart your source using the Sumo Management API, follow the instructions below:
- Example endpoint:
Sumo Logic endpoints like
api.sumologic.com are different in deployments outside
us1. For example, an API endpoint in Europe would begin
api.eu.sumologic.com. A service endpoint in
us2 (Western U.S.) would begin
service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details.
|JSON Object||Yes||Contains the configuration-parameters of the Source.||n/a|
|JSON Object||Yes||Use ||not modifiable|
|String||Yes||Use ||not modifiable|
|String||Yes||Type the desired name of the Source and it must be unique per Collector. This value is assigned to the ||modifiable|
|String||No||Type the description of the Source.||modifiable|
|String||No||Type the category of the source. This value is assigned to the metadata field ||modifiable|
|JSON Object||No||JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field ||modifiable|
|String||Yes||The project ID is the globally unique identifier for your project. For example, ||modifiable|
|String||Yes||The Dataset ID is the project-wise unique identifier for your dataset. For example, ||modifiable|
|String||Yes||The Private Key is part of Service Account JSON, it is a security key which is required for authentication.||modifiable|
|String||No||User email collected from the Google Cloud Console.||modifiable|
|String||Yes||The Token URI is part of Service Account JSON, it is used for generating the token.||modifiable|
|String||Yes||This sets how many hours the Source checks for new data. The default is 24 hours.||modifiable|
|String||Yes||Dataset ID is the project-wise unique identifier for your dataset.||modifiable|
"name":"Gmail Trace Log",
"startTime":"24 Hours ago"
"type":"Gmail Trace Logs"