Gmail Trace Logs

Gmail Trace Logs is a new Sumo Logic app based on the Gmail BigQuery Cloud-to-Cloud source, which is a managed analytics data warehouse that provides scalable Gmail reports of your organization.

The Sumo Logic App for Gmail Trace Logs helps monitor spam messages, malware, dropped messages and rejected messages. It allows you to view messages with objectionable content, messages detected by your Security Sandbox, and messages flagged by the Walled Garden Rule.

Log types

The Sumo Logic App for Gmail Trace Logs uses Gmail Logs via BigQuery.

For details, see the Schema for Gmail logs in BigQuery.

Sample log messages

{
  "event_info": {
    "timestamp_usec": 1669101504309964,
    "elapsed_time_usec": 2115298,
    "success": true
  },
  "message_info": {
    "action_type": 3,
    "rfc2822_message_id": "\u003c2f9102a27ddd041edc7654ef84e4e06ddb843aba-20231242-111224498@wcwgkemdsf.com\u003e",
    "subject": "[Update] For GCP Organizations, all Security and Privacy Notifications will be sent through Advisory Notifications",
    "payload_size": 33084,
    "source": {
      "address": "CloudPlatform-noreply@wcwgkemdsf.com",
      "service": "smtp-inbound",
      "selector": null,
     "from_header_address": "cloudplatform-noreply@wcwgkemdsf.com",
     "from_header_displayname": "Google Cloud Platform"
   },
   "destination": [
     {
       "address": "Thomas@wcwgkemdsf.com",
       "service": "gmail-ui",
       "selector": "",
       "smime_signature_verification_success": null,
       "smime_decryption_success": null,
       "smime_parsing_success": null,
       "smime_extraction_success": null,
       "rcpt_response": null
     }
   ],
   "flattened_destinations": "gmail-ui::Thomas@wcwgkemdsf.com",
   "description": "No Error",
   "connection_info": {
     "client_ip": "95.184.117.158",
     "smtp_in_connect_ip": null,
     "smtp_out_connect_ip": null,
     "failed_smtp_out_connect_ip": null,
     "smtp_tls_state": 1,
     "smtp_reply_code": 0,
     "tls_required_but_unavailable": null,
     "smtp_out_remote_host": null,
     "smtp_user_agent_ip": "95.184.117.158",
     "is_intra_domain": false,
     "dmarc_pass": true,
     "dmarc_published_domain": "google.com",
     "client_host_zone": "google.com",
     "smtp_response_reason": null,
     "ip_geo_city": null,
     "ip_geo_country": "US",
     "authenticated_domain": [
       {
       },
      {
        "name": "scoutcamp.bounces.google.com",
        "type": 1
      }
    ],
    "is_internal": false,
    "dkim_pass": true,
    "spf_pass": true,
    "smtp_tls_version": null,
    "smtp_tls_cipher": null
  },
  "is_spam": false,
  "is_policy_check_for_sender": false,
  "num_message_attachments": 0,
  "message_set": [
    {
      "type": 9
    },
    {
      "type": 15
    },
    {
      "type": 1
    }
  ],
  "smtp_relay_error": null,
  "upload_error_category": null,
  "structured_policy_log_info": null,
  "triggered_rule_info": null,
  "flattened_triggered_rule_info": null,
  "smime_sign_message": null,
  "smime_encrypt_message": null,
  "smime_packaging_success": null,
  "smime_extraction_success": null,
  "smime_content_type": 0,
  "link_domain": [
    "google.com"
  ],
  "attachment": null,
  "spam_info": {
    "classification_reason": 2,
    "classification_timestamp_usec": null,
    "disposition": 1,
    "ip_whitelist_entry": ""
  }
}
}

Sample queries

Gmail messages classifications
_sourceCategory=Labs/GmailTraceLogs
| json "event_info.success", "message_info.action_type", "message_info.attachment[*].file_extension_type", "message_info.attachment", "message_info.subject", "message_info.attachment[*].malware_family", "message_info.attachment[*].sha256", "message_info.connection_info.client_ip", "message_info.connection_info.ip_geo_city", "message_info.connection_info.ip_geo_country", "message_info.connection_info.is_internal", "message_info.connection_info.smtp_response_reason", "message_info.connection_info.smtp_reply_code", "message_info.connection_info.smtp_tls_state", "message_info.destination[*].address", "message_info.is_spam", "message_info.spam_info.classification_reason", "message_info.spam_info.disposition", "message_info.message_set[*].type", "message_info.source.address" as is_event_success, action_type, file_extension_type, message_attachment, message_subject, message_malware_family, message_sha256, client_ip,  client_city,  client_country, is_message_internal, smtp_response_reason, smtp_reply_code, smtp_tls_state, destination_email, is_spam, spam_classification_reason, spam_disposition, message_set_type, message_source_email  nodrop
| parse regex field=message_set_type "(?<message_setType>[\w]+)" multi
| if(message_setType matches "6","Message triggered the walled garden rule you configured that restricts messages to authorized addresses or domains.",
  if(message_setType matches "4","Message contains objectionable content, as defined by one of your policies.",
  if(message_setType matches "61","Message was caught by Security sandbox.", "Other Type, Check message_set_type Field for more info."))) as message_set_type
| count by message_set_type
| sort by _count

Collection configuration and app installation

Depending on the set up collection method, you can configure and install the app in three ways:

Create a new collector and install the app. Create a new Sumo Logic Cloud-to-Cloud (C2C) source under a new Sumo Logic Collector and later install the app, or
Use an existing collector and install the app. Create a new Sumo Logic Cloud-to-Cloud (C2C) source under an existing Sumo Logic Collector and later install the app, or
Use existing source and install the app. Use your existing configured Sumo Logic Cloud-to-Cloud (C2C) source and install the app.

info

Use the Cloud-to-Cloud Integration for Gmail Trace Logs to create the source and use the same source category while installing the app. By following these steps, you can ensure that your Gmail Trace Logs app is properly integrated and configured to collect and analyze your Gmail Trace Logs data.

Create a new collector and install the app

To set up collection and install the app, do the following:

note

Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, and Manage Collectors capabilities depending upon the different content types part of the app.

Select App Catalog.
In the 🔎 Search Apps field, run a search for your desired app, then select it.
Click Install App.
note
Sometimes this button says Add Integration.
In the Set Up Collection section of your respective app, select Create a new Collector.
1. Collector Name. Enter a Name to display the Source in the Sumo Logic web application. The description is optional.
2. Timezone. Set the default time zone when it is not extracted from the log timestamp. Time zone settings on Sources override a Collector time zone setting.
3. (Optional) Metadata. Click the +Add Metadata link to add a custom log Metadata Fields. Define the fields you want to associate, each metadata field needs a name (key) and value.
  - A green circle with a checkmark is shown when the field exists and is enabled in the Fields table schema.
  - An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
4. Click Next.
Configure the source as specified in the Info box above, ensuring all required fields are included.
In the Configure section of your respective app, complete the following fields.
1. Field Name. If you already have collectors and sources set up, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value.
Click Next. You will be redirected to the Preview & Done section.

Post-installation

Once your app is installed, it will appear in your Installed Apps folder, and dashboard panels will start to fill automatically.

Each panel slowly fills with data matching the time range query received since the panel was created. Results will not immediately be available but will be updated with full graphs and charts over time.

Use an existing collector and install the app

To set up the source in the existing collector and install the app, do the following:

note

Select App Catalog.
In the 🔎 Search Apps field, run a search for your desired app, then select it.
Click Install App.
note
Sometimes this button says Add Integration.
In the Set Up Collection section of your respective app, select Use an existing Collector.
From the Select Collector dropdown, select the collector that you want to set up your source with and click Next.
Configure the source as specified in the Info box above, ensuring all required fields are included.
In the Configure section of your respective app, complete the following fields.
1. Field Name. If you already have collectors and sources set up, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value.
Click Next. You will be redirected to the Preview & Done section.

Post-installation

Once your app is installed, it will appear in your Installed Apps folder, and dashboard panels will start to fill automatically.

Use an existing source and install the app

Viewing the Gmail Trace Logs dashboards

All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.

You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. Learn more.
You can use template variables to drill down and examine the data on a granular level. For more information, see Filtering Dashboards with Template Variables.
Most Next-Gen apps allow you to provide the scope at the installation time and are comprised of a key (_sourceCategory by default) and a default value for this key. Based on your input, the app dashboards will be parameterized with a dashboard variable, allowing you to change the dataset queried by all panels. This eliminates the need to create multiple copies of the same dashboard with different queries.

Security Overview

The Gmail Trace Logs - Security Overview dashboard lets you monitor spam messages, malware threats, dropped messages, and rejected messages.

The CrowdStrike Analysis. To protect your organisation from threats, the app also scans the SHA256 hash of Gmail attachments with CrowdStrike's threat detection service.

Upgrading the Microsoft Teams app (optional)

To update the app, do the following:

note

Select App Catalog.
In the Search Apps field, search for and then select your app.
Optionally, you can identify apps that can be upgraded in the Upgrade available section.
To upgrade the app, select Upgrade from the Manage dropdown.
1. If the upgrade does not have any configuration or property changes, you will be redirected to the Preview & Done section.
2. If the upgrade has any configuration or property changes, you will be redirected to the Setup Data page.
3. In the Configure section of your respective app, complete the following fields.
  1. Field Name. If you already have collectors and sources set up, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata Field Value.
4. Click Next. You will be redirected to the Preview & Done section.

Post-update

Your upgraded app will be installed in the Installed Apps folder and dashboard panels will start to fill automatically.

note

See our Release Notes changelog for new updates in the app.

To revert the app to a previous version, do the following:

Select App Catalog.
In the Search Apps field, search for and then select your app.
To version down the app, select Revert to < previous version of your app > from the Manage dropdown.

Uninstalling the Microsoft Teams app (optional)

To uninstall the app, do the following:

Select App Catalog.
In the 🔎 Search Apps field, run a search for your desired app, then select it.
Click Uninstall.

Log types​

Sample log messages​

Sample queries​

Collection configuration and app installation​

Create a new collector and install the app​

Use an existing collector and install the app​

Use an existing source and install the app​

Viewing the Gmail Trace Logs dashboards​

Security Overview​

Upgrading the Microsoft Teams app (optional)​

Uninstalling the Microsoft Teams app (optional)​

Log types

Sample log messages

Sample queries

Collection configuration and app installation

Create a new collector and install the app

Use an existing collector and install the app

Use an existing source and install the app

Viewing the Gmail Trace Logs dashboards

Security Overview

Upgrading the Microsoft Teams app (optional)

Uninstalling the Microsoft Teams app (optional)