Disclaimers
The Workspace 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.
Introduction
The Diagnostic Information Tool provides a comprehensive view of the diagnostic information sent to Google from a user’s device during the use of Workspace Core Services, and enables administrators to export that information. Using the Diagnostic Information Tool, administrators can export up to 24 hours of diagnostic information for a selected user within your organization for the Workspace services described in the section below.
Before getting started
The Diagnostic Information Tool provides diagnostic information for the following core Google Workspace services:
Assignments (Google Workspace for Education only), Calendar, Chat, Classroom (Google Workspace for Education only), Cloud Search, Contacts, Drive & Docs (Docs, Forms, Sheets, Slides, Vids), Gmail, Groups, Keep, Meet, Sites, Tasks, and Voice.
The first version of the Diagnostic Information Tool is available only for the Dutch government public-sector and education customers. To use the Diagnostic Information Tool, admins need the Reports privilege (for details, see Administrator privilege definitions). 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 between 30 to 63 days, with the information then either being 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; or
- 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 further elaborate on the first example above, Google maintains systems that monitor the end-to-end performance of the Google 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 would only have access 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
To run a search in the Diagnostic Information Tool:
- Go to the Google Admin console at admin.google.com.
Be sure to sign in using your corporate (administrator) email address, and not your personal address. - On the left of the Admin console Home page, click Reporting > Diagnostic Information Tool.
- In the User email field, enter the user ID for your search—for example, jim@solarmora.com.
- Select the Service name for your search—for example, Calendar.
- Enter a time range for your search.
You can run a search for the Last hour, Last 2 hours, Last 4 hours, Last 8 hours, or Last 24 hours. - Click Export.
- Enter an Export name.
- Select a format: Google Sheets or CSV file (comma-separated values).
- Click Export.
The length of time to complete the export process depends on the amount of data in the search results.
The Diagnostic Information Tool limits this period to 24 hours so that it can produce the export in a reasonable amount of time, taking into account the volume of data potentially being exported. There is no limit on the number of times you can run the tool (for example, once per day), and export requests can be processed in parallel.
Exports should be completed within 2 days, but some exports can take longer. Note: Drive & Docs contains diagnostic information from multiple applications and as a result the export might take longer to complete.
To view the progress of your export, click Tasksat the upper right corner of the Google Admin console, and go to Your tasks.
Click Tasksat the upper right corner of the Google Admin console. If the status of your export is Completed, click Download CSV or Open in Sheets to view the data generated by your search.
Note:
- 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 this occurs, you can rerun the export as a CSV file. Use the same or similar time range that you used for the original export.
View the exported search results
When you run a search in the Diagnostic Information Tool, the following columns are displayed in the exported search results:
- Timestamp—Date and time of the logging event. The timestamp corresponds to when the event actually reaches the server and is logged.
- User IP—IP address of the user specified in the Diagnostic Information Tool search.
- DUSI—Stands for Device User Session Identifier. This is the hash of the device ID and user ID which uniquely identifies a single user on a device.
- User agent—String identifying the type of browser and operating system of the user.
- Payloads—The Diagnostic Information Tool enables you to export diagnostic information from several different logging payloads. This data is displayed in the Payloads column. For details about this information, see the sections below.
The example below shows the data that’s outputted in the Payloads column of the exported search results. To understand this data, you’ll first need to find the logging payloads that are shown in the output; and to find these payloads, you’ll need to know which ones to look for.
Here’s how: Different 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 in the Diagnostic Information Tool using the Calendar service, you’ll need to search your outputted spreadsheet 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
- visual_elements
Note: For the complete list of which payloads you should look for depending on the service, see Which logging payloads are associated with which services?
The following example shows data that was outputted using the Calendar service. With the output in this example, you can find the following logging payloads:
- common_event_logging
- calendar_client_events
To understand this data, read the descriptions for the various data fields. To do this, go to Understand your search results, and go to the sections for common_event_logging and 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\"}}}}'"}
The Diagnostic Information Tool enables you to export data for several different logging payloads. This data is displayed in the Payloads column. Different payloads are shown in the outputted search results depending on the service you choose when running your search.
For example, if you chose the Calendar service when running your search, your search results might display data for the calendar_client_events payload and the calendar_unified_sync payload. See the table below for details.
Note: Click the service name in the table to view an example of the Diagnostic Information Tool output for that service. This can help you understand the kind of output you might expect to obtain through the tool. Each example is representative only, not exhaustive; the actual output will vary depending on the actions the user performs in the relevant service.
To read descriptions about the payloads and their various data fields, go to Understand your search results and search for the relevant sections.
| 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 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 & 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 |
Google’s spell and grammar check feature makes spelling and grammar suggestions when a user is writing or editing a document or email. Providing this feature involves a combination of server-side and client-side processing. The suggestions are generated using advanced server-side algorithms that analyze portions of the content users are writing on their client devices in real time.
Suggestions are presented to the user on their client device by underlining a word or phrase. When a user selects any of the spelling and grammar suggestions, the service presents them with one or more suggested edits and the option to ignore the suggestion. The service logs the user’s selection on the client along with the relevant portion of the content used to make the suggestion. This logged data is sent to the server where it is then processed to ensure that this feature is working properly; logging which suggestions are accepted, rejected, or ignored is essential for the reliability, effectiveness. and functioning of this feature.
On that basis, the logged data (including the relevant portion of the content) may be displayed in the data export when using the Diagnostic Information Tool.
These logs are temporary in nature, held for a maximum of 30 days. They are collected, anonymised or pseudonymised, and aggregated to provide the information needed to operate the spell and grammar check tool. The document itself does not retain a record of spelling suggestions and interactions.
Understand your search results
The Diagnostic Information Tool includes information from several different logging payloads. The specific payloads that are displayed in the outputted search results depend on the Service name you choose when running your search.
To view details related to the specific custom payloads displayed in the search results, see the sections below. For example, if the Payloads column refers to the calendar_client_events payload, see the corresponding section below for more details.
The common_event_logging payload is the standard payload that’s associated with all services in the Diagnostic Information Tool, so it’s common to see information for this payload outputted in the Payloads column.
The common_event_logging payload provides details about the user's environment, such as the device type, operating system and browser versions, and about the state of configuration options like whether the menu bar is visible or hidden. This data is useful for debugging and for improving the safety and reliability of the services.
| 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 this event. This value is mainly used to allow accurate computation of latencies across clients and servers. |
| timezone_offset_seconds | User's timezone 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. |
The android_gmail payload holds records of user interactions and sync data within the Android version of Gmail.
This payload is associated with the Gmail service in the Diagnostic Information Tool. When you run a search for the Gmail service, you might see data for android_gmail outputted in the Payloads column.
| 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 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. |
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.
This payload is associated with the Assignments service in the Diagnostic Information Tool. When you run a search for the Assignments service, you might see data for apps_edu_client outputted in the Payloads column.
| 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. |
The apps_search payload holds records of user interactions when searching within Google Workspace web services—for example, Gmail, Drive, and Calendar. For instance, the payload can indicate whether the user typed a query, dictated a voice query, or selected a query from a list of suggestions.
This payload is associated with the Cloud Search service in the Diagnostic Information Tool. When you run a search for the Cloud Search service, you might see information for apps_search outputted in the Payloads column.
| 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 this 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 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 may have multiple interpretations. |
| facet_response | Loggable facet response from Cloud Search superroot. |
| rpc_stats | Loggable 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. |
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 (such as spelling or grammar) and the action that triggered the request (such as saving a draft). This data enables Gmail to provide the requested assistance.
This payload is associated with the Gmail service in the Diagnostic Information Tool. When you run a search for the Gmail service, you might see data for assisted_writing outputted in the Payloads column.
| 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 | The type of device that's getting writing assistance. |
| language | The requested language in BCP 47 format—for example en or pt-BR. |
| detected_language | Detected language in BCP 47 format—for example en or pt-BR. |
| active_language | Language that was used for the request. |
| country | Two-letter string representation of a CLDR region code. |
The calendar_android_sync_adapter payload contains information about the syncs of Google Calendar data from/to Android’s Calendar Provider. It reports on the success of the process and records the changes made to bring the calendars into sync. This data is useful for debugging and for improving the safety and reliability of the service.
This payload is associated with the Calendar service in the Diagnostic Information Tool. When you run a search for the Calendar service, you might see data for calendar_android_sync_adapter outputted in the Payloads column.
| Data field | Description |
|---|---|
| sync_adapter_result | The result of a sync of Google Calendar data from/to Android’s Calendar Provider. |
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 the user is creating. This data is useful for debugging and for improving the safety and reliability of the service.
This payload is associated with the Calendar service in the Diagnostic Information Tool. When you run a search for the Calendar service, you might see information for calendar_client_events outputted in the Payloads column.
| Data field | Description |
|---|---|
| events | The 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 | A 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. |
| 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). |
The calendar_ios_events payload includes logged data related to user interactions with the iOS Calendar service. 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. This data is useful for debugging and for improving the safety and reliability of the service.
This payload is associated with the Calendar service in the Diagnostic Information Tool. When you run a search for the Calendar service, you might see data for calendar_ios_events outputted in the Payloads column.
| Data field | Description |
|---|---|
| log_event | The calendar iOS log event. |
| counter_dimensions | Dimensions for Calendar iOS counters. |
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. This data is useful for debugging and for improving the safety and reliability of the service.
This payload is associated with the Calendar service in the Diagnostic Information Tool. When you run a search for the Calendar service, you might see data for calendar_logging outputted in the Payloads column.
| 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. |
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.
This payload is associated with the Calendar service in the Diagnostic Information Tool. When you run a search for the Calendar service, you might see data for calendar_sync_metrics outputted in the Payloads column.
| Data field | Description |
|---|---|
| schedule_vital_log | Captures the comparison of two copies of the same schedule (one from the client, one from the server). Here a schedule is defined as the set of events the user sees when opening the app. |
| view_event_vital_log | Compares the events when the 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. |
The calendar_unified_sync payload holds information related to the sync service’s API health, sync health, and sync operation.
This payload is associated with the Calendar service in the Diagnostic Information Tool. When you run a search for the Calendar service, you might see data for calendar_unified_sync outputted in the Payloads column.
| 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. This is 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. This is 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 | The 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 has been enabled and is actually working, or if an old version is being used. 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. |
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. This data is useful for debugging and for improving the safety and reliability of the service.
This payload is associated with the Chat service in the Diagnostic Information Tool. When you run a search for the Chat service, you might see information for chat_event_log outputted in the Payloads column.
| Data field | Description |
|---|---|
| type | Type of event being recorded. |
| 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, 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 | This is populated by clients and propagated through the system to enable end-to-end tracing. |
| group_type | Type of group—for example, a space. |
| notification_dispatch_metadata | This is populated by the dispatcher and session servers for analyzing and debugging notification delivery. |
| logging_group_type | Logging group type—for example, 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. |
The client_interaction_log_entry payload includes Google Voice records that are used for analytics and debugging. It records the nature of the interaction, the preferences set in the user's account, and performance information. It collects information about the Voice interactions, the performance of the Voice service, and any problems encountered.This data is useful for debugging issues with the Voice service and tracking its usage.
This payload is associated with the Voice service in the Diagnostic Information Tool. When you run a search for the Voice service, you might see information for client_interaction_log_entry outputted in the Payloads column.
| Data field | Description |
|---|---|
| user_account_info | Basic information about the user's account status and preferences. |
| interaction_properties | Record of a communication event. This is used when a user is referencing a previous conversation—for example 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—for example, user signup, making a call, or sending a message. |
| web_product_info | Information about the web product 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—for example, 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 |
The cloud_search_client payload holds logging information related to Cloud Search. This payload is associated with the Cloud Search service in the Diagnostic Information Tool. When you run a search for the Cloud Search service, you might see information for cloud_search_client outputted in the Payloads column.
| 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. |
The common_event_logging_counters payload holds a collection of counters and histograms from Gmail and Calendar clients.
This payload is associated with the Gmail and Calendar services in the Diagnostic Information Tool. When you run a search for one of these services, you might see information for common_event_logging_counters outputted in the Payloads column.
| 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. |
The drive_detail_pane payload holds logging information related to Drive features that enable users to see changes made to their Drive files. For example, when the user navigates from one page to another, such as from the Approvals list page to the Approval Details page, it records the event and how long it took. This data is useful for debugging and measuring performance.
This payload is associated with the Drive & Docs service in the Diagnostic Information Tool. When you run a search for the Drive & Docs service, you might see data for drive_detail_pane outputted in the Payloads column.
| Data field | Description |
|---|---|
| host_app_id | The ID of the host application. |
| impression_type | The duration type of the impression: instant or elapsed. |
| host_build_label | The 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 | Microseconds indicating start time. |
| duration_usec | The number of microseconds that elapsed. |
| event_code | The event code of the impression event. |
| event_details | The details for the impression event. |
| experiments | Experiments enabled within the Details & activity feature in Drive. |
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).
This payload is associated with the Drive & Docs service in the Diagnostic Information Tool. When you run a search for the Drive & Docs service, you might see data for drive_clients outputted in the Payloads column.
| 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. |
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.
This payload is associated with the Gmail service in the Diagnostic Information Tool. When you run a search for the Gmail service, you might see data for the gmail payload outputted in the Payloads column.
| Data field | Description |
|---|---|
| client_info | Details about the client—for example, Android/iOS. |
| client_state |
Transient client attributes—for example, network information. |
| counter | Counter and latency events from the client. |
| measurement | Measurements corresponding to specific user actions—for example, 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—for example, 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 is 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. |
The groups_ui_client payload holds logging information related to user interactions with Google Groups. This payload is associated with the Groups service in the Diagnostic Information Tool. When you run a search for the Groups service, you might see data for groups_ui_client outputted in the Payloads column.
| Data field | Description |
|---|---|
| client_entry | Events specifying interactions with user interface elements displayed on a page—for example, left-click, right-click, hover, or mouse click. |
| timer_value | Values from timer measurements. |
The impression_batch payload is used to log user interactions for Editors and Drive 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.
This payload is associated with several services in the Diagnostic Information Tool—for example, Classroom, Drive & Docs, Keep, and Sites. When you run a search for one of these services, you might see information for impression_batch outputted in the Payloads column.
| 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 that the impressions were recorded in. |
| 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 at which the logging server received the record. |
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.
This payload is associated with the Meet service in the Diagnostic Information Tool. When you run a search for this service, you might see data for the meet_logging payload outputted in the Payloads column.
| 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 real-time communications (RTC) client, which provides details about the physical device and frontend application that the user is using. |
| client_connectivity | Includes information about client connectivity—for example, whether the connection attempt succeeded or failed, and the server/client logging the event. |
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.
This payload is associated with the Meet service in the Diagnostic Information Tool. When you run a search for the Meet service, you might see information for meet_quality_tool outputted in the Payloads column.
| Data field | Description |
|---|---|
| requester_customer_id | The customer ID of the user that's making the request. |
| acting_customer_id | A customer ID that’s necessary for support and reseller view. |
| data_access_permissions | Logging information related to users’ data access permissions |
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.
This payload is associated with the Drive & Docs service in the Diagnostic Information Tool. When you run a search for the Drive & Docs service, you might see data for notifications_logs outputted in the Payloads column.
| Data field | Description |
|---|---|
| social_client | The social client that identifies the client's device, application, and platform. |
| client_log | Used to hold the client-side log event. |
| eng_data | Used to collect eng-specific metrics independent of the client log. |
| client_experiment_id | A 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 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.
This payload is associated with the following services in the Diagnostic Information Tool: Assignments, Calendar, Chat, Drive & Docs, Gmail, Groups, Meet, and Tasks.
When you run a search for the above services, you might see information for request_context outputted in the Payloads column.
| Data field | Description |
|---|---|
| ancestry | The ancestry of visual elements for the visual element the user interacted with. |
| cardinal_direction | Represents the direction of the user action. |
| client_interaction_metadata | This is a container message to hold application specific extensions for any application specific metadata that’s relevant to an interaction event. |
| element_index | The value of the corresponding element_index field. |
| interaction_context | The value of the interaction context. |
| parent_event_id | The client side event ID of the parent event. |
| primary_user_action | This is the first value in a user action. |
| type_id | Identifies the type of clicked visual element. |
| ui_state | The state of the UI before the interaction. |
| ve_index | The index of the clicked element in the original visual elements array. |
The tasks_data_layer_entry payload holds information related to Google 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/failure and latencies.
This payload is associated with the Tasks service in the Diagnostic Information Tool. When you run a search for the Tasks service, you might see data for tasks_data_layer_entry outputted in the Payloads column.
| 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, 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 | This includes information about generic client latency measurements. |
| shard_user_interaction | This represents 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 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 show how many cases Google couldn’t move from the deprecated way of grouping actions a user took on the client to the new way. |
| 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 the app or a 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. |
The tasks_logs payload holds logging information related to Google Tasks. For a user-initiated event in Tasks, the payload records the event, UI element used, and related metadata.
This payload is associated with the Tasks service in the Diagnostic Information Tool. When you run a search for the Tasks service, you might see data for tasks_logs outputted in the Payloads column.
| 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. |
The unprocessed_trace_buffer payload holds information about system trace records and performance information related to Gmail. 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.
This payload is associated with the Gmail service in the Diagnostic Information Tool. When you run a search for Gmail, you might see information for unprocessed_trace_buffer outputted in the Payloads column.
| Data field | Description |
|---|---|
| unprocessed_trace_buffer | Information about where the trace originated from. |
The visual_elements payload is used to log UI elements on a web page. It records data about the UI elements, including which service each one relates to and whether it is visible to the user.
This payload is associated with the following services in the Diagnostic Information Tool: Assignments, Calendar, Chat, Cloud Search, Drive & Docs, Gmail, Groups, Meet, and Tasks.
When you run a search for the above services, you might see information for visual_elements outputted in the Payloads column.
| 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 Inbox. |
| 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—for example, container, result, group, or sitelink. |
| visible | Indicates that a UI visual element is shown to the user. |
The voice payload holds logging information related to the voice client devices. This information is useful for debugging and for improving the performance and reliability of the service.
This payload is associated with the Voice service in the Diagnostic Information Tool. When you run a search for the Voice service, you might see data for the voice payload outputted in the Payloads column.
| Data field | Description |
|---|---|
| voice_client_info | Client information for Google Voice. |
| voice_options | VoIP configuration options selected by Google client used for quality analytics. |
| public_identity | An identity generated by the Google backend to match a device to specific user information. |
| call_event | Call metrics used for quality analytics. |
| media_event | Contains the media statistics for a single call. Used for quality analytics. |
| sip_message_event | The message 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. |
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.
This payload is associated with the Contacts service in the Diagnostic Information Tool. When you run a search for the Contacts service, you might see information for web_contacts outputted in the Payloads column.
| 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. |
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.
This payload is associated with the Gmail service in the Diagnostic Information Tool. When you run a search for the Gmail service, you might see data for web_protection outputted in the Payloads column.
| Data field | Description |
|---|---|
| property_id | An integer corresponding to an enum value. |
| event_time_usec | The time when the client response is recorded. |
| encoded_web_protection_response | The encoded web protection response. |
| tab_id | A per-tab pseudorandom number populated by web protection integration. |
| no_eval_enabled | Marks if no-eval was enabled for the current session. |
| standalone_infra_enabled | Indicates if the web protection program was downloaded from the standalone server. |
