The Diagnostic information tool and accompanying documentation are meant to assist Workspace administrators in exporting and understanding the diagnostic information generated during the use of Workspace core services and sent to Google servers in order to fulfill their legal obligations. The Diagnostic information tool should not be used for any other purpose.
As an administrator, you can use the Diagnostic information tool to review information sent to Google from a user’s device during the use of Workspace core services. You can export up to 24 hours of diagnostic information for a user in your organization.
Before you begin
Expand section | Collapse all & go to top
Which Google Workspace services are included in the Diagnostic information tool?The Diagnostic information tool provides diagnostic information for the following Workspace core services:
Assignments and Classroom (Google Workspace for Education only), Google Calendar, Chat, Cloud Search, Contacts, Docs, Drive, Groups, Keep, Meet, Sheets, Sites, Slides, Tasks, Vids, and Voice, and Gmail.
The first version of the Diagnostic information tool is available only for the Dutch government public-sector and education customers. Admins also need to opt-in to gain access.
In line with the Google Cloud Privacy Notice, the maximum period that Google may retain diagnostic information that identifies a user is 180 days. For example, we may retain IP addresses and device identifiers for longer than 180 days where necessary to identify and prevent unwanted, unsolicited, or dangerous messages—such as spam, phishing, and malware—from reaching users’ Gmail inboxes. However, in practice, this diagnostic information is retained for shorter periods of time, 30–63 days, with the information then anonymised or deleted.
Google’s policy is to aggregate, anonymise, or pseudonymise Workspace service data (including diagnostic information that identifies a user) where it does not need the personal information contained in that service data for the relevant purpose.
In the case of anonymisation, Google may anonymise diagnostic information and use that anonymised information in aggregate in order to, for example:
- Identify technical issues that may occur, such as application crashes.
- Understand health metrics (including latency and error rates) to detect anomalies and identify ways of improving system reliability.
- Assess the stability, optimization, and usage of new service features (for example, if a percentage of devices using the feature are experiencing unexpected battery drain).
To elaborate on the first example (earlier on this page), Google maintains systems that monitor the end-to-end performance of Workspace services and identify crashes when they happen.
If a service crashes, information about that crash (including information that may identify the user that initiated the service request) is collected and aggregated into statistics about crashes occurring in the services. The Google engineers diagnosing the cause of service crashes have access only to the aggregated statistics rather than information that would identify individual users.
At the end of its applicable retention period, Google may also retain service data in anonymised form. More information about Google’s retention of service data is available in the “Retention and Deletion of Service Data” section of the Google Cloud Privacy Notice.
Run a search in the Diagnostic information tool
-
Sign in with an administrator account to the Google Admin console.
If you aren’t using an administrator account, you can’t access the Admin console.
-
Go to Menu
Reporting > Diagnostic Information Tool.
Requires having the Reports administrator privilege.
- For User email, enter the user’s email address.
- For Service name, select the Workspace service—for example, Calendar.
- For Time range, select an option:
Last hour, Last 2 hours, Last 4 hours, Last 8 hours, or Last 24 hours.
- Click Export.
- For Export name, enter a name.
- Select an option:
Google Sheets or CSV file (comma-separated values).
- Click Export.
Exports usually complete within 2 days, but some exports can take longer. The length of time depends on the amount of data in the search results. For example, Drive and Docs contain information from multiple apps. There is no limit on the number of times you can run the tool (for example, once per day). Export requests can be processed in parallel.
-
(Optional) To view the progress of your export, at the top of the Admin console, click Tasks
Your tasks.
-
(Optional) To download the results when the export is complete, click Download CSV or Open in Sheets.
If a Google Sheets export exceeds 10 million cells, a CSV file is exported instead, even if you selected Google Sheets for your export. If a cell exceeds 50,000 characters in a Google Sheets export, you’ll see a suffix in that cell with the word truncated. If a cell gets truncated, you can rerun the export as a CSV file. Use the same or similar time range that you used for the original export. For more information, go to Files you can store in Google Drive.
View the exported search results
You can review the following information in the exported search results:
- Timestamp—Date and time of the event, corresponds to when the event actually reaches the server and is logged
- User IP—IP address of the user specified
- DUSI—Device User Session Identifier, uniquely identifies a single user on a device and is the hash of the device ID and user ID
- User agent—User’s browser and operating system
- Payloads—Data from different logging payloads
About payloads data
Expand section | Collapse all & go to top
Example: Payloads for the Calendar serviceDifferent payloads are displayed in the Payloads column depending on the service name you choose when running your search. For example, if you ran a search using the Calendar service, you can search for the following payloads:
- common_event_logging
- calendar_android_sync_adapter
- calendar_client_events
- calendar_ios_events
- calendar_logging
- calendar_sync_metrics
- calendar_unified_sync
- common_event_logging_counters
- request_context
- unprocessed_trace_buffer
- visual_elements
In the following example, you can find these logging payloads:
- common_event_logging
- calendar_client_events
{"common_event_logging":"'{\"clientInfo\":{\"androidClientInfo\":{\"applicationBuild\":\"2019999948\",\"board\":\"bluejay\",\"brand\":\"google\",\"country\":\"US\",\"device\":\"bluejay\",\"deviceFingerprint\":\"google/bluejay/bluejay:13/TP1A.XXXXX.004.A2/XXXXX:user/release-keys\",\"extensionVersion\":[{\"extension\":33,\"version\":3},{\"extension\":30,\"version\":3},{\"extension\":31,\"version\":3}],\"gmscoreVersion\":223316044,\"hardware\":\"bluejay\",\"locale\":\"en\",\"manufacturer\":\"Google\",\"mccMnc\":\"40449\",\"model\":\"Pixel6a\",\"osBuild\":\"TP1A.222093.004.A2\",\"product\":\"bluejay\",\"radioVersion\":\"i12345-102852-220720-B-321321321\",\"sdkVersion\":33},\"clientType\":\"ANDROID\"},\"clientTimestampMillis\":\"1664529600759\",\"deviceStatus\":{\"isXXXXXDevice\":true},\"logSource\":\"CALENDAR_CLIENT\",\"timestampMillis\":\"1664529600760\",\"timezoneOffsetSeconds\":19800}'","calendar_client_events": "'{\"visualElementEntry\":{\"ancestryVisualElement\":{\"elementId\":92131},\"visualElementMetadata\":{\"clientMetadata\":{\"channel\":\"PROD\",\"orientation\":\"PORTRAIT\",\"versionName\":\"2022.36.0-472143158-release\"},\"userMetadata\":{\"userType\":\"EXTERNAL\"},\"userNotificationMetadata\":{\"userNotificationContentState\":\"ORIGINAL\",\"userNotificationSource\":\"EVENT\"}}}}'"}
For descriptions of the various data fields, go to Understand your search results (later on this page).
For the complete list of payloads per service, go to Which logging payloads are associated with which services? (later on this page).
The payloads that you can review depend on the service that you searched.
- Click the service name in the following table for an example of the output for that service.
The actual output varies and depends on the actions that the user performs in the relevant service.
- For descriptions of the logging payloads, go to Understand your search results (later on this page).
| Service name | Logging payloads |
|---|---|
| Assignments | common_event_logging apps_edu_client request_context visual_elements |
| Calendar | common_event_logging calendar_android_sync_adapter calendar_client_events calendar_ios_events calendar_logging calendar_sync_metrics calendar_unified_sync common_event_logging_counters request_context unprocessed_trace_buffer visual_elements |
| Chat |
common_event_logging |
| Classroom | common_event_logging impression_batch |
| Cloud Search | common_event_logging apps_search cloud_search_client visual_elements |
| Contacts | common_event_logging web_contacts |
| Drive and Docs | common_event_logging impression_batch drive_detail_pane drive_clients notifications_logs request_context visual_elements |
| Gmail | common_event_logging android_gmail assisted_writing common_event_logging_counters gmail request_context unprocessed_trace_buffer visual_elements web_protection |
| Groups | common_event_logging groups_ui_client request_context visual_elements |
| Keep | common_event_logging |
| Meet | common_event_logging meet_logging meet_quality_tool request_context visual_elements |
| Sites | impression_batch |
| Tasks | common_event_logging request_context tasks_logs visual_elements |
| Voice | common_event_logging client_interaction_log_entry voice |
Spelling and grammar suggestions in Google Docs are generated using advanced server-side algorithms that analyze portions of the content users are writing on their client devices in real time.
The service logs the user’s action as well as the content used to make the suggestion. The logged data (including the relevant portion of the content) may be displayed in a data export when using the Diagnostic information tool. These logs are temporary in nature and held for a maximum of 30 days. They are collected, anonymised or pseudonymised, and aggregated to provide the information needed to operate the spelling and grammar tool. The document itself does not retain a record of spelling suggestions and interactions.
Learn more about the spelling and grammar check feature.
Understand logging payloads search results
In this section, you can review details on the payloads returned in the search results.
Expand section | Collapse all & go to top
common_event_loggingThe common_event_logging payload is the standard payload that’s associated with all services in the Diagnostic information tool. It provides details about the user's environment, such as the device type, operating system, and browser versions. You can also review details about configuration options, such as whether the menu bar is visible or hidden.
| Data field | Description |
|---|---|
| client_info | Additional details about the client that the impressions were recorded in. |
| is_user_initiated | Whether this event was initiated by the user at the time of the event, rather than a change triggered by a background event, such as a background data update or notification. |
| log_source | Identifies the datatype of the logged event. |
| experiment_id | List of experiment IDs for this request. |
|
timestamp_millis |
The timestamp of the log event on the server in milliseconds. The timestamp corresponds to when the event actually reaches the server and is logged. |
|
client_timestamp_millis |
The time when the client logs the event. This value is mainly used to allow accurate computation of latencies across clients and servers. |
| timezone_offset_seconds | User's time zone offset from UTC in seconds. |
| network_connection_info | Additional details about the network connection, such as the type of network. |
| event_code | The code corresponding to the type of log event. |
| impression_batch | Records of client-side events sent to the server and written to logs. |
| http_lang | Indicates the natural language and locale that the client prefers when the server can’t determine the target content language. |
Associated with the Gmail service, the android_gmail payload holds records of user interactions and synchronization data within the Android version of Gmail.
| Data field | Description |
|---|---|
| client_entry | Events for client-side Gmail logging |
| client_info | Description of the Gmail client, including the version name, platform type, and device type |
| active_event | Summary of an event that identifies the user as active |
| exchange_activation_event | Summary for an event that marks an Microsoft Exchange activation |
| sync_data | Sync metric data—for example, domain and network information |
| visual_element_event | Visual element events representing user actions and impressions |
| gmail_network_data | Network-related data for Gmail |
| gmail_jank_data | Information related to rendering issues |
| gmail_client_state | Contains transient information about the client—for example, the network type, or whether the user is interacting with the device |
| gmail_feature_event | Log information for Gmail features for usage or bug tracking |
| google_apps_event | Log information for events related to Google applications |
| organic_event | Used for logging organic events on Gmail |
| gmail_thread_pool_monitoring_data | Logging information related to rendering metrics |
| account_info | Contains fields defining the protocol of the email accounts and the providers they belong to |
| gmail_anr_data | Information related to application not responding (ANR) issues |
Associated with the Assignments service, the apps_edu_client payload holds logging information related to user interactions with visual elements in a user interface. For example, when a user accesses an assignment, this payload records the service they are using and the user's role in the course (student or teacher). This data enables status tracking for assignments.
| Data field | Description |
|---|---|
| originality_log | Metadata attached to a specific visual element in the application and metadata attached to the entire log event that’s not specific to the visual element |
| prof_log | The top-level product the user is accessing |
Associated with the Cloud Search service, the apps_search payload holds records of user interactions when searching in Google Workspace web services, such as Gmail, Google Drive, or Google Calendar. For example, the payload can indicate whether the user entered a query, dictated a voice query, or selected a query from a list of suggestions.
| Data field | Description |
|---|---|
| query_info | Contains additional information about how the query was executed, such as query ID and which auto suggestion was used. |
| result | Results shown to the user—present if this log record was written after a search request and absent if no result was returned by the current request. |
| client_info | Information that pertains to the client on which the search was performed. |
| not_shown_result | All top results returned from the backend but not shown to the user. |
| click | Information on a click—present if this log record was written after a click and absent if no click was recorded by the current request. |
| suggestion_removed | A suggestion was removed from a document because of an edit. This result can mean the suggestion was deleted, accepted, or rejected. |
| focus | Contains information from a core infrastructure service. |
| click_subtype | The interaction type of the click. |
| processed_clicks | Used to store information on all clicks made by a user after a search query. This field is empty if there are no clicks. |
| search_session_id | The search session ID that produced this request. |
| gaia_auth_time | The authentication time in seconds. |
| search_packer | Generic packer scoring information for organic results. |
| nl_interpretation_info | Natural language interpretation results. One query can have multiple interpretations. |
| facet_response | Loggable facet response from Cloud Search superroot. |
| rpc_stats | Loggable Remote Procedure Call (RPC) stats from Cloud Search superroot. |
| personalized_scheme_segment | Personalized scheme with set of weights. These weights are combined with the default scheme to compute the number of slots per section. |
| workspace_audit_info | Google Workspace audit RPC information. |
| side_experiment_info | Contains information about selected experiments for this request. |
| non_search_context_info | Contains information about non-search activity for this request from Gmail, Drive, and Calendar. |
Associated with the Gmail service, the assisted_writing payload holds logging information related to assisted writing features in Gmail, such as Smart Compose and spelling and grammar suggestions. For example, it records the type of assistance provided and the action that triggered the request (such as saving a draft). This data enables Gmail to provide the requested assistance.
| Data field | Description |
|---|---|
| session_id | Unique session ID for the user |
| client_context | Additional contextual information about the client that’s supplemental to the request—for example, location or client IDs |
| suggestion_request | Indicates that a client requested query suggestions |
| client_event | Container to hold client events |
| client_type | The type of assisted writing client |
| device_type | Type of device that's getting writing assistance |
| language | The requested language in BCP 471 format—for example en for English or pt-BR for Brazilian Portuguese |
| detected_language | Detected language in BCP 47 format |
| active_language | Language that was used for the request |
| country | Two-letter string representation of a
Common Locale Data Repository (CLDR) region code |
| 1 Standard for representing regionalized languages | |
Associated with the Calendar service, the calendar_android_sync_adapter payload contains information about the syncs of Google Calendar data to and from Android’s Calendar Provider. It reports on the success of the process and records the changes made to bring calendars into sync.
| Data field | Description |
|---|---|
| sync_adapter_result | Result of a sync of Google Calendar data to and from Android’s Calendar Provider |
Associated with the Calendar service, the calendar_client_events payload holds records of user interactions and impressions on first-party calendar clients. For example, the payload might show that the Calendar service suggested a time or room for a meeting that a user created.
| Data field | Description |
|---|---|
| events | Logged events—for example, if a Calendar event is created or updated, or if the parameters for an event are changed in the event settings. |
| shard_name | Name of the shard reported by the web client. |
| availability_level | Filled by the web client to indicate the quality of service that’s available to the acting user. |
| visual_element_entry | Specifies what event took place on which UI element and in what context. It can also contain metadata providing additional information, such as the related calendar event. |
| platform | Client platform, if it’s known. |
| client_impression | Simple client impression with an optional latency. |
| ui_metadata | Metadata about the UI where the log was written. |
| connection_status | Internet connection status of the client when the event was recorded. |
|
gemini_eligibility |
Access to Gemini AI features when the event was recorded. Only populated for Calendar on the web after an access check is performed. |
| apps_telemetry_extension | Start time of the server that the client loaded the web application from and the canary type of the server (canary, control, or none). |
Associated with the Calendar service, the calendar_ios_events payload includes logged data related to user interactions with the iOS app. For example, it records which Calendar view the user interacts with and the type of object they're working on, such as an event, contact, or reminder.
| Data field | Description |
|---|---|
| log_event | Calendar iOS app log event |
| counter_dimensions | Dimensions for Calendar iOS app counters |
Associated with the Calendar service, the calendar_logging payload includes logged data related to user interactions with the Android Calendar service. For example, it records which action the user took, such as creating or changing an event or reminder.
| Data field | Description |
|---|---|
| action_type | Generated by user actions, such as creating a calendar event, changing an event, or creating a reminder |
| distribution_invariants | Invariants about app distribution |
Associated with the Calendar service, the calendar_sync_metrics payload includes high-level system metrics for assessing how well Calendar is syncing. This data is used for measuring performance, making sure the Calendar service is up to date, and for alerting.
| Data field | Description |
|---|---|
| schedule_vital_log | Captures the comparison of 2 copies of the same schedule (one from the client and one from the server). A schedule is defined as the set of events the user sees when opening the app. |
| view_event_vital_log | Compares the events when users view them in a client, to make sure the correct data is being shown. |
| edit_event_vital_log | Compares the events after they are edited, to make sure the correct data is being stored. |
Associated with the Calendar service, the calendar_unified_sync payload holds information related to the sync service’s API health, sync health, and sync operation.
| Data field | Description |
|---|---|
| operation | Information about one complete run of the sync loop, which may include several requests to the server. |
| source | Information about the client that logged the record. |
| android_specific | Android internal logging related to Android-specific metrics and health. |
| web_specific | Web internal logging used to populate the web specific client state. |
| database_error | Information about a database error emanating from the client stack. |
| ios_specific | iOS internal logging used to populate the iOS-specific client state. |
| check_report | Information about client database health. |
| session | Information about the current sync session. |
| scheduling_decision_group | Information about a scheduling decision by the sync service. |
| dao_inconsistency | A batch containing information about inconsistent method calls. |
| transaction_description | Description of the transaction that was found to cause an inconsistency between the sync and async implementation. |
| dark_launch_report | Information about a new function that is enabled and working or an old version. Often used during migration to verify that the new path output is the same as the old path output. The field contains data, such as ID and time, about the inputs and outputs to the computation. |
Associated with the Chat service, the chat_event_log payload includes information related to Chat log events. It records the type of action the user initiates, such as creating a message or selecting an autocomplete option, and provides details about related metadata and any errors that occur.
| Data field | Description |
|---|---|
| type | Type of event. |
| error_reason | Chat-related error code. |
| origin | Origin of the event log. |
| canary | Control origin of the event log. |
| entity_id | The ID of the entity, such as a user, who sent the chat message. |
| error_info | Message containing error information if the event was unsuccessful. |
| timer_value | Values from timer measurements. |
| client_timestamp_millis | The time when the client logs this event. This value is mainly used to allow accurate computation of latencies across clients and servers. |
| client_session_latency_millis | The time that passed from when the page or app was open to when the client logged the event. |
| client_info | Message containing info about the client and used for analytics. This information is populated in the client-specific code by the relevant client. |
| client_metadata | Populated by the client to record additional information about the event. |
| server_metadata | List of server metadata. |
| hangouts_interop_client_metadata | Client metadata populated by the Interop server. |
| trace_id | The ID populated by clients and propagated through the system to enable end-to-end tracing. |
| group_type | Type of group, such as a space. |
| notification_dispatch_metadata | Populated by the dispatcher and session servers for analyzing and debugging notification delivery. |
| logging_group_type | Logging group type, such as one-to-one direct message. |
| group_load_metadata | Metadata associated with loading a group. |
| dlp_event_metadata | Metadata about the DLP event. |
| item_scheduled_event_type | The type of scheduled event. |
| tracing_id | Populated by clients and propagated through the system to enable end-to-end tracing. |
| activity_feed_metadata | Populated in the activity feed service when handling an activity feed message. |
| dynamite_audit_log_metadata | Metadata about the recorded log events. |
Associated with the Voice service, the client_interaction_log_entry payload includes Voice records that are used for analytics and debugging, such as the user's account preferences, performance information, and any problems.
| Data field | Description |
|---|---|
| user_account_info | Basic information about the user's account status and preferences |
| interaction_properties | Record of a communication event, used when a user is referencing a previous conversation, such as reading through it or replying |
| network_connection_info | Network connection information |
| app_launch_info | Information about the app opening or resuming |
| search_info | Search related data |
| error_info | Information to help debug errors |
| device_info | Number of accounts that the device has signed in to at the time of logging |
| performance_info | Performance measurement on the client |
| contacts_interaction_info | Information on user interaction with contacts |
| voip_info | Information on the VoIP connection logged |
| voicemail_greeting_recording_info | Information on the voicemail greeting logged |
| workflow_info | Information on what type of workflow the user is using, such as user signup, making a call, or sending a message |
| web_product_info | Information about the web product that the user is using |
| client_version_info | Provides attributes related to the client version |
| web_sync_info | Information about web sync events |
| previous_call_info | Details on a related previous call, such as identifying the failed call for a redial interaction |
| web_borg_info | Information on Google’s cluster manager for Voice |
| web_app_status_info | Information about the web app status |
| action_info | Information about actions related to state management |
| media_playback_info | Information related to media playback |
| debug_info | Information for debugging |
| web_mutex_lock_info | Information about mutual exclusion (mutex) lock for Voice |
| media_input_info | Information related to media input |
| display_info | Information related to screen display |
| rpc_info | Information related to RPC status |
| inbound_call_rules_info | Information related to inbound call rules |
Associated with the Cloud Search service, the cloud_search_client payload holds logging information related to Cloud Search.
| Data field | Description |
|---|---|
| visual_element_entry | Contains user interaction events generated by the logging framework. This information specifies what event took place and in what context. |
Associated with the Gmail and Calendar services, the common_event_logging_counters payload holds a collection of counters and histograms from Gmail and Calendar clients.
| Data field | Description |
|---|---|
| uptime_millis | Uptime timestamp in milliseconds since the system was booted. |
| timestamp_millis | Real-world (server time) timestamp before the first datum in this counter. This field is populated during translation from uptime_millis. |
| counter | Set of counters sent atomically. |
| dimensions_instance | Serialized custom dimension protocol message. |
| dimensions_instance_js | A JSPB version of dimensions_instance, using array serialization. format. |
| dimensions_instance_json | A JSON version of dimensions_instance presented as a string of text. |
Associated with the Drive and Docs services, the drive_detail_pane payload holds logging information related to Drive features that allow users to see changes made to their Drive files. For example, when a user navigates from one page to another, it records the event and how long it took. This data is useful for debugging and measuring performance.
| Data field | Description |
|---|---|
| host_app_id | ID of the host application |
| impression_type | Duration type of the impression: instant or elapsed |
| host_build_label | Build label of the host application |
| host_session_id | Represents the activity during a single page load |
| start_session_sequence_number | Sequence number captured at the start of the session |
| end_session_sequence_number | Sequence number captured at the end of the session |
| start_usec | Start time (in microseconds) |
| duration_usec | Number of microseconds that elapsed |
| event_code | Event code of the impression event |
| event_details | Details for the impression event |
| experiments | Experiments enabled within the Details & activity feature in Drive |
Associated with the Drive and Docs services, the drive_clients payload holds logging information related to Drive clients. It provides a link between details about the event (client_entry) and where the event was logged (logging_context).
| Data field | Description |
|---|---|
| client_entry | Container message for the event information generated by the visual element logging framework. This information specifies what event took place on which visual element and in what context. |
| logging_context | Client-supplied logging details. Provides the context for the logging of the request, such as additional metadata only used for logging purposes. |
Associated with the Gmail service, the gmail payload holds logging information related to Android, iOS, and web Gmail services. This payload contains impressions and user actions for users across multiple Gmail clients, along with performance metrics, such as tracking RPC failures and latencies. The data is collected for internal analytics purposes to better understand how users use Gmail. This data is useful for debugging and for improving the safety and reliability of the service.
| Data field | Description |
|---|---|
| client_info | Details about the client, such as Android or iOS |
| client_state |
Transient client attributes, such as network information |
| counter | Counter and latency events from the client |
| measurement | Measurements corresponding to specific user actions, such as the timing for a user action |
| thread_pipeline_stats | Performance stats related to the sync server |
| highlights_partner_info | View and click metrics for Highlights, which is a Gmail feature that surfaces key information and actions in an email message, such as details about a flight reservation and a link to check in |
| client_entry | Container class for all data from the client that’s persisted in logs |
| account_info | Information that defines the protocol of email accounts and the provider they belong to |
| request_type | Describes the type of request being served |
| sync_action | Information about sync actions |
| sync_status | Basic information about sync call status that can be used to analyze potential sync loops |
| has_user_activity | Information about whether a request contains changes indicating that the user is active |
| search_experiment_metadata | Additional metadata associated with Gmail search experiments within Gmail, such as an experiment identifier |
| dispatcher_assignment_type | Gmail dispatcher assignment type that indicates why a request was sent to a specific server |
| session_validation_failure | Reason for session validation failure, for example, the session expired, the account has an unverified primary email address, or the session's account isn’t registered for the given service |
| has_interactive_priority | Whether or not the request is given interactive priority on the serving stack |
| channel_id_verification | Log verification status and logout state |
| web_client_availability_info | Information about the availability of Gmail web client |
Associated with the Groups service, the groups_ui_client payload holds logging information related to user interactions with Google Groups.
| Data field | Description |
|---|---|
| client_entry | Events specifying interactions with user interface elements displayed on a page, such as left-click, right-click, or point to |
| timer_value | Values from timer measurements |
The impression_batch payload is associated with several services—for example, Classroom, Drive, Docs, Keep, and Sites. This payload is used to log user interactions for Drive, Docs, Sheets, Slides, Forms, and Sites across web, Android, and iOS platforms. These actions are recorded and sent to the server in periodic batches. This payload contains client side events representing user interactions with the service, latency measurements, usage statistics, or memory usage. It is used to improve the product, monitor product growth and releases, and analyze performance.
| Data field | Description |
|---|---|
| impressions | The recorded impressions (the recorded events on the client) |
| session_info | Information describing the client session |
| client_info | Additional details about the client where the impressions were recorded |
| impression_system | Information about the impression system that generated the batch |
| serialized_batch | Serialized impression batch string |
| session_invariants | Information about the user session |
| log_server_time_usec | Time when the logging server received the record |
Associated with the Meet service, the meet_logging payload holds logging information related to Google Meet. For example, it contains details about the user's environment, such as their real-time communications (RTC) client and the state of Meet configuration options. This data is useful for debugging and for improving the safety and reliability of the service.
| Data field | Description |
|---|---|
| hangout_log_entry | Used for storing identification, impression, and call performance information for Meet |
| transport_event | Logs events as messages that are transported through the backend |
| client_state | Holds the messages and enums used to log a client's state when it receives an event |
| gwslog_data | Log data for HTTP requests—used by most HTTP servers at Google |
| rtc_client | Information about the RTC client, which provides details about the physical device and frontend application that the user is using |
| client_connectivity | Includes information about client connectivity, such as whether the connection attempt succeeded or failed and the server or client logging the event |
Associated with the Meet service, the meet_quality_tool payload includes logging information related to the Meet Quality Tool, which is a tool that assists customers in debugging the quality of their Meet calls.
| Data field | Description |
|---|---|
| requester_customer_id | Customer ID of the user that's making the request |
| acting_customer_id | Customer ID that’s necessary for support and resellers |
| data_access_permissions | Logging information related to users’ data access permissions |
Associated with the Drive and Docs services, the notifications_logs payload holds logging information related to Google Drive notifications. When a user receives a notification, this payload records details about the user's client and the action that triggered the notification. This data is useful for debugging and for improving the safety and reliability of the service.
| Data field | Description |
|---|---|
| social_client | Identifies the client's device, application, and platform |
| client_log | Used to hold the client-side log event |
| eng_data | Used to collect engineering-specific metrics independent of the client log |
| client_experiment_id | Set of experiment IDs sent by the client to the server |
| actual_user_info | Information about the user |
| action_info | Information about the user action triggering the log event |
The request_context payload is associated with the following services: Assignments, Calendar, Chat, Drive, Docs, Gmail, Groups, Meet, and Tasks. This payload holds information related to user actions. For example, it records whether the user swiped or clicked on a UI element and metadata about the UI element itself. This data is used to debug, analyze, and understand usage patterns for different features.
| Data field | Description |
|---|---|
| ancestry | Ancestry of visual elements for the visual element the user interacted with |
| cardinal_direction | Direction of the user action |
| client_interaction_metadata | Container message that holds application-specific extensions for any application-specific metadata that’s relevant to an interaction event |
| element_index | Value of the corresponding element_index field |
| interaction_context | Value of the interaction context |
| parent_event_id | Client-side event ID of the parent event |
| primary_user_action | First value in a user action |
| type_id | Type of clicked visual element |
| ui_state | State of the UI before the interaction |
| ve_index | Index of the clicked element in the original visual elements array |
Associated with the Google Tasks service, the tasks_data_layer_entry payload holds information related to Tasks. It contains information about the sync performance of a cross-platform tasks client library. It is used for tracking, monitoring, and alerting sync success or failure and latencies.
| Data field | Description |
|---|---|
| client_info | Stores information about the Tasks client sending the request, including the application and the platform. |
| sync_operation | Contains information on how many actions the user was trying to take and on how many entities, why they were trying to sync data, and the result. |
| invariant_violations | If this is set, the client experienced an unrecoverable error. This contains IDs to help identify the problematic entities. |
| client_latency_measurements | Information about generic client latency measurements. |
| shard_user_interaction | Whether the user interacted with a space or their own tasks and which list, if applicable. |
| secondary_sync_data | Tracks success of calls to other services to read relevant data, such as Docs for Tasks from documents and the Chat API for Tasks from Spaces. |
| load_storage_data | Used for performance measurements to see how many entities Google needed to put into the cache on clients and how long it took. |
| migration_operation | Contains information about changes to the database format. |
| resource_holder_event | Contains information about client memory management. |
| user_action_switch | Counter used to track instances where the system could not switch from a deprecated method of grouping user actions on the client to a new, intended method. |
| resource_events | Contains information about client memory management. |
| account_model_operations | Contains information about whether the tasks data stored on-device is synced (up to date) when an app or space is opened. |
| purge_operation | Contains information about how many users or spaces Google tried to delete data for and whether it succeeded or not. |
| smart_view_events | Contains information about displaying the list of starred tasks or other smart views. |
Associated with the Tasks service, the tasks_logs payload holds logging information related to Tasks. For a user-initiated event in Tasks, the payload records the event, UI element used, and related metadata.
| Data field | Description |
|---|---|
| client_entry | Container message for the event information generated by the visual element logging framework. This information specifies what event took place on which visual element and in what context. |
Associated with the Gmail and Calendar services, the unprocessed_trace_buffer payload holds information about system trace records and performance information related to Gmail and Calendar. Trace buffers record latency and other performance data on the client. If a buffer fails validation for any reason during upload to the server, it remains unprocessed. It's important to identify (and fix) unprocessed trace buffers to avoid losing valuable performance data.
| Data field | Description |
|---|---|
| unprocessed_trace_buffer | Information about where the trace originated from |
The visual_elements payload is associated with the following services: Assignments, Calendar, Chat, Cloud Search, Drive, Docs, Gmail, Groups, Meet, and Tasks. This payload is used to log UI elements on a webpage. It records data about the UI elements, including which service each one relates to and whether it is visible to the user.
| Data field | Description |
|---|---|
| apps_edu_ve_metadata | Information about UI visual elements related to Google Workspace for Education |
| gmail_ve_metadata | Information about UI visual elements related to Gmail |
| contains_elements | Indicates additional UI visual elements are contained within |
| dedupe_key | Key used when deduping UI visual elements |
| drive_ve_metadata | Information about user interface visual elements related to Drive |
| chat_ve_metadata | Information about user interface visual elements related to Chat |
| element_index | Information about ordered lists |
| groups_ui_ve_metadata | Information about user interface visual elements related to Groups |
| meet_ve_metadata | Information about user interface visual elements related to Meet |
| tasks_ve_metadata | Information about user interface visual elements related to Tasks |
| ui_type | Type of UI element on the page, such as container, result, group, or link |
| visible | Indicates that a UI visual element is shown to the user |
Associated with the Voice service, the voice payload holds logging information related to Voice client devices. This information is useful for debugging and for improving the performance and reliability of the service.
| Data field | Description |
|---|---|
| voice_client_info | Client information for Voice |
| voice_options | VoIP configuration options selected by Google client used for quality analytics |
| public_identity | Identity generated by the Google backend to match a device to specific user information |
| call_event | Call metrics used for quality analytics |
| media_event | Media statistics for a single call, used for quality analytics |
| sip_message_event | Represents a small subset of data extracted from sent or received SIP messages |
| registration_event | Whether the registration event succeeded or not and why the client ended in that state |
| network_event | Network metrics used for quality analytics |
| domain_event | Domain metrics used for quality analytics |
| stun_probe_stats | Network connection quality analytics |
| internal_event | Internal event for quality analytics |
| device_id | Unique identifier for the device |
Associated with the Contacts service, the web_contacts payload includes logging information related to the Web Contacts app, which provides a unified view of the people users know. The data in this payload is recorded for debugging purposes.
| Data field | Description |
|---|---|
| client_entry | Container message for the event information generated by the visual element logging framework. This information specifies what event took place on which visual element and in what context. |
| dimension | The dimension for web contacts. |
| metric_entry | The engineering metrics data entry. |
Associated with the Gmail service, the web_protection payload holds logging information related to spam protection and bot detection. The payload records the intervention of a web protection program and an encoded summary of its response.
| Data field | Description |
|---|---|
| property_id | Integer corresponding to an enum value |
| event_time_usec | Time when client response is recorded |
| encoded_web_protection_response | Encoded web-protection response |
| tab_id | Per-tab pseudorandom number populated by web- protection integration |
| no_eval_enabled | Marks if no-evaluation was enabled for the current session |
| standalone_infra_enabled | Indicates if the web protection program was downloaded from the standalone server |
Google, Google Workspace, and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.
