This document provides you with an oveview of the Logs Explorer in the Google Cloud console, which you can use to retrieve, view, and analyze logs data.
To begin using the Logs Explorer, do the following:
Ensure that you have the correct Identity and Access Management role to view logs. For information on IAM roles and permissions, see Access control with IAM.
Note that if you use Amazon Web Services Elastic Compute Cloud (AWS EC2), your log entries are located in the AWS connector project that links your AWS account to Google Cloud services.
Note that if you ingest on-premise and hybrid cloud logs through BindPlane, you can find these logs under the resource type
Navigate to the Logs Explorer:
Select the appropriate Cloud project.
Logs Explorer interface
The Logs Explorer interface lets you retrieve logs, parse and analyze log data, and refine your query parameters.
The Logs Explorer contains the following sections, which are detailed on this page:
Using the Action toolbar features, you can do the following:
- Options: Go to the Legacy Logs Viewer, send feedback, and view a summary of new Logs Explorer features.
- Refine scope: Scope your search by logs in your current Cloud project only or by one or more storage views. For more information about scoping, see Refine scope.
- Share link: Create a shortened URL of the current query and
copy it to your clipboard, making it easier to share a query.
The copied URL has the corresponding absolute time range represented by the
current time range of your query; for example,
7:49:37 PM - 8:49:37 PM.
- Learn: View links to relevant documentation and topics.
You can refine the scope of the logs displayed in the Logs Explorer through the Refine scope option. You can search only logs within the current Cloud project or search logs in one or more storage views. To refine the scope of the Logs Explorer, do the following:
In the Action toolbar, select Refine Scope.
On the Refine scope dialog, select a Scope by option.
Scope by project allows you to search logs that the current Cloud project generates.
Scope by storage allows you to search logs based on one or more storage views. For more information about log views, see Manage log views on your log buckets.
If you select Scope by storage, select one or more buckets that you want to view.
The dialog lists storage views that meet the following conditions:
- The user has access to the storage view.
- The log buckets belong to the selected Cloud project, or the selected Cloud project has previously routed logs to the storage buckets.
Use the Query pane features to do the following:
Query tab: Build and refine queries using the following features:
Time-range selector: Restrict query results by time range. For more information, see Use the time-range selector.
Search-text box: Find log entries that match your search terms or phrases. For details, see Search for text across log fields.
Filter menus: Build queries based on Resource, Log name, and Severity. For more information, see Use filter menus.
Query-editor field: Build advanced queries using the Logging query language. For details, see Write advanced queries.
Recent tab: View queries that you have recently run. For more information, see Use recent queries.
Suggested tab: View suggested queries based on the resources in your Cloud project. For more information, see Use suggested queries.
Library tab: View and run Google-provided queries based on your use cases. For more information, see Select queries from the library.
Save: Save queries that can be viewed and run from the Saved tab.
Clear query: Clear and reset the selections you made when building a query in the Query pane.
Stream logs: View log entries as Logging ingests them. For more information, see Stream logs.
Run query: Run your queries after you have built them in the Query pane.
If you don't see the query-editor field, enable Show query. If you add any search terms in the search-text box, those terms also appear in the query-editor field and are evaluated as part of your query expression.
You can stream logs as Logging ingests them, or you can add a query to stream only those logs that match the query.
To stream logs based on a query, add a query in the Query pane, and then select Stream logs. As Logging ingests the logs data, only those logs that match the query are shown in the Query results pane. If a query isn't provided, Logging shows each log as it's ingested.
To stop streaming, click Stop streaming, or scroll within the Query results pane.
From the Results toolbar, you can do the following:
- Show Logs field pane: Quickly show or hide this pane from your Logs Explorer page layout.
- Show Histogram pane: Quickly show or hide this pane from your Logs Explorer page layout.
- Create metric: Set up a log-based metric based on your current query expression.
- Create alert: Set up a log-based alert based on your current query expression.
- Jump to now: Perform a forced refresh of your query results to include the current time. If the time-range selector uses a custom range and an end time is set, it runs the query with a default time range of one hour. Otherwise, it refreshes with the current start date or duration, and runs the query. Note that the query expression isn't altered when you use this feature.
- More actions: Use these further options to manage log-based alerts or create a sink.
Log fields pane
The Log fields pane offers a high-level summary of logs data and provides a more efficient way to refine a query. It shows log entries broken down by different dimensions, corresponding to fields in these entries. For each field, the Log fields pane shows values and their incidence in descending frequency order. The log-field counts correspond to the time range in the time-range selector.
To show or hide the Log fields pane, click on the Logs fields button in the Results toolbar.
The Log fields pane is populated and updated based on an executed query in the query-editor field.
If the query is empty, the Log fields pane displays the counts of log entries by the Resource type and Severity fields.
If you've selected Scope by storage, you'll also see Project ID and the corresponding counts of log entries.
If you select a resource type from the Log fields pane, a set of relevant fields, based on the resource labels, populate the pane. This lets you investigate logs data for that specific resource type. You can remove them by clicking Clear next to the Resource type field.
Add fields to Log fields pane
You can add certain
LogEntry key-value pairs to the Logs field
pane from the log entries populated in the Query results pane. To add a
field to the Logs field pane, do the following:
In the Query results pane, expand a log entry by clicking the expand button chevron_right.
Left-click on a field's value. From the menu, select Add field to Log fields pane.
The custom field appears in the Log fields pane as a list of key-value pairs.
To remove a custom field from the Log fields pane, click Remove next to the field. You can also remove a custom field from the list by left-clicking on it in the Query results pane and selecting Remove from Log fields.
Note that the following types of fields can't be added to the Log fields pane:
- Fields related to time; for example,
- Fields with high cardinality; for example,
- Fields with array indices in their path; for example,
Analyze logs using the Log fields pane
To narrow down and refine a query, you can add field-value pairs from the
Log fields pane to the expression in the Query pane. To do so, in the
Log fields pane, click on a field's value. This adds the field-value pair
to the expression using the
AND operator. The query then runs.
You can add nested field-value pairs, as well as top-level field-value pairs, to
the Log fields pane. For example, suppose you added
the Log fields pane. If you select a particular
it populates the query-editor field.
The Histogram and Query results panes also change to reflect the current query.
When a query is executing, the log entries are scanned and the log-field counts change. When the query is complete, the total counts for all log fields are displayed.
With the Histogram pane, you can visualize the distribution of logs over time. The histogram regenerates when you run a query, making it easier to see trends in your logs data and troubleshoot problems.
To show or hide the Histogram pane, click on the Histogram button in the Results toolbar.
Histogram bars: Each histogram bar represents a time range. Each bar contains a three-color breakdown for the log-severity levels captured in each bar's time range. The colors represent the following log severities:
- Blue: Low severities such as Default, Debug, Info, and Notice.
- Yellow: Medium severities such as Warning.
- Red: High severities such as Error, Critical, Alert, and Emergency.
Each histogram bar features a menu with options to analyze your logs.
Time controls: Let you adjust the time range of the logs you see in the Query results pane. For details on these options, see Analyze logs using time controls.
Timeline: Shows you the time range of the logs, represented by histogram bars, that are currently displayed within the Query results pane. The timeline helps to orient you to the logs you're currently viewing within the larger time range of your query.
Analyze logs using time controls
You can use the histogram's time controls to help you investigate and analyze your logs data.
Tip: When you adjust the histogram's time controls, the logs data in the Query results and Log fields panes adjusts according to the time range captured by the histogram timeline. Adjusting the histogram's time controls doesn't alter the query expression in the Query pane.
Adjust time quickly
The histogram provides time controls that let you quickly adjust the data that you see in the Logs Explorer.
Time handles: Drag the timeline's handles inward to narrow the data or outward to widen the data in the histogram timeline. Click Run.
Slide the timeline forward and backward: Click the chevron_rightforward arrow to slide the timeline to a later time. Click the chevron_leftbackward arrow to slide the timeline to an earlier time.
Zoom in and out: Click the zoom_outzoom-out icon to broaden the data shown in the timeline. Click the zoom_inzoom-in icon to narrow the data shown in the timeline.
Timeline modifications are constrained to be between the current time ("now") and 30 days ago.
Scroll or zoom to time
In addition to the time controls above, the histogram provides the Scroll to time and Zoom to time features to give you more in-depth control of the histogram and the data that you see in other panes in the Logs Explorer.
Perhaps a particular histogram bar interests you based on its relative size or severity levels. You can select that histogram bar to adjust the logs data you see in the Logs Explorer.
You can use the Scroll to time feature to browse your logs data without changing the values in the Histogram and Log fields panes. When you select the Scroll to time feature, the following happens:
The logs data that you see in the Query results pane adjusts according to the time range captured by the selected histogram bar.
The query isn't run, but a partial reload of the data might occur to ensure you're seeing logs in the Query results pane that correspond with the selected histogram bar's time range.
The console URL updates to contain the
timestampof the most recent log captured by the time range of the selected histogram bar.
To select the Scroll to time feature, do the following:
Hover over a bar in the histogram timeline. A pane containing summary information about the logs data for the specified time range appears.
In the pane, select Scroll to time.
Alternatively, clicking on a histogram bar, instead of hovering over it, is equivalent to selecting Scroll to time.
The Zoom to time feature is similar to Scroll to time, but it runs a query on your logs data based on the time range captured by a selected histogram bar. When you select the Zoom to time feature, the following happens:
- The logs data that you see in the Query results pane reloads and narrows according to the time-range restriction of the selected histogram bar.
- The console URL updates to contain the
timestampof the most recent log captured by the time range of the selected histogram bar.
- The histogram changes to show only logs that have a
timestampvalue that falls within the time range of the selected histogram bar. by the selected histogram bar.
- The data in the Log fields pane adjusts according to the time range captured by the selected histogram bar.
To select the Zoom to time feature, do the following:
Hover over a bar in the Histogram timeline. A pane containing summary information about the logs data for the specified time range appears.
In the pane, select Zoom to time.
Using the Query results pane, you can explore the log entries that match your query expressions and the time range you've selected using the histogram's time controls or the time-range selector:
Use the Query results pane features to do the following:
- Query results: View the retrieved log entries from your query in the structured JSON format. To expand the query results, click Enter fullscreen query results fullscreen.
- Time zone: Change the time zone that logs are displayed in.
- Download logs: Download logs from your query results.
- Hide similar logs: Hide large amounts of similar logs from your query results.
- Trace data: View trace details and refine your query based on the trace. For more information, see View trace data.
- Hide log summary: Hide the log summary line from the query results.
- Expand or collapse nested log fields: Expand or collapse nested fields.
- Copy to clipboard: Copy the log entry in its JSON format.
- Copy link to a log entry: Share a link to a log entry. For more information, see Copy a link to a log entry.
- Edit button in the Summary column header: Add the value of a log field to the summary lines of your log entries. You can also hide default summary fields entirely to give you a raw-text display of your entries. For more information, see Add and manage summary fields.
- Pin log entry: Pin a log entry to the Query results and Histogram panes. For more information, see Pin logs.
- Cursor scroll: Scroll the logs in Query results; the URL
adjusts to include
cursorTimestamp, which indicates the
timestampof the newest log shown in the current Query results pane.
Within the query results pane, you can click the values of a field to choose to do the following:
- Show matching entries: Query for matching log entries.
- Hide matching entries: Query for log entries that don't match the selected expression.
- Add field to summary line: Add the field as a summary line to log entries.
Add and manage summary fields
You can use summary fields to help you notice patterns in your logs faster.
Suppose you're looking through the log entries in your query results and want to
quickly skim the results by a certain
LogEntry field. Or perhaps
you want to group your log entries by a certain field-value pair. You can add
summary fields to your results, which appear as chips at the beginning of each
log entry line. For example, the following image shows query results with the
resource.type added to each log entry line:
The Logs Explorer offers default summary fields, which depend on your current query results, and custom summary fields, which let you target any field in the LogEntry.
You can manage both custom and default summary fields from an editing menu in your query results. You can also add custom summary fields directly from an expanded log entry.
Add a custom summary field from a log entry
To add a custom summary field directly from a log entry, do the following:
Expand a log entry by clicking the expand button chevron_right.
Click a field's value and then select Add field to summary line.
The summary field now appears as a chip before the log entries containing that field.
To remove a custom summary field, click on its chip in the log entry line and select Remove field from summary line. To further manage your custom summary fields, see the instructions in the next section.
Manage summary fields using the editing menu
To manage your custom and default summary fields using the editing menu, do the following:
Click Edit to open the editing menu:
In the Manage summary fields dialog, do the following:
Turn on or off Default summary fields by using the toggle switch toggle_off.
If you turn off the default summary fields, and don't add any custom summary fields, then your log entries are displayed in a raw-text format.
Add any custom field names to Custom summary fields.
The summary field selection has the following features:
- Autocomplete using the logs currently displayed in your query results.
- Field correction for legal characters within quotes.
For example, if you type
jsonPayload.id-field, it gets changed to
You can also target any
LogEntryfield, regardless of whether it is suggested to you with the autocomplete function.
To remove an existing custom summary field, click the
Xin its chip.
Turn on or off truncation for your custom summary fields. Use the toggle switch toggle_off by Truncate summary fields to shorten the display of the summary field values. Then choose how many characters to display before the field is truncated, and whether the beginning or the end of the field is displayed.
Tip: In your query results, hovering over a truncated summary field displays its full value.
Your summary fields are now updated in your query results.
Hide similar log entries
You can hide logs to quickly remove large amounts of similar log entries from your query results.
When you run a query, the query results are analyzed for patterns as they are being sent for display in the Query results pane. Log entries are then automatically grouped based on similar log field content. If a significant pattern is detected, a banner appears in the Query results pane showing the percentage of similar results that can be hidden:
To hide similar logs, click Hide similar entries. This adds a clause to the query and reloads the query results.
To preview which log entries would be hidden, click Preview. A separate window opens which describes the pattern found, and shows examples of the entries that will be hidden.
When you hide similar logs, no information is saved outside of the Logs Explorer session, and each query produces a new analysis, based only on the logs shown. Different queries analyze different portions of the log entries depending on the types of logs returned.
Pin log entries
You can pin a log entry to highlight a log entry of interest.
To pin a log entry, do the following:
- Hover over the log entry that you want to pin.
- Click on the pin icon push_pin.
After you pin a log entry, its background is darkened, and a pin icon push_pin is shown.
If you pin a log entry and run your query again, the pinned log entry appears at
either the top or bottom of the Query results pane, depending on how you've
configured your logs data. A pin icon also appears on the Histogram pane
based on the pinned log entry's
To unpin the log entry, click the pin icon again.
View a pinned log entry in resource contexts
If you pin a log entry and view it within different resource contexts, then the query reruns with the same resource information as the pinned log entry.
To view the pinned log entry within different resource contexts, do the following:
Click on the down arrow arrow_drop_down next to the pinned log to expand the pin menu.
Within the pin menu, you can choose to view the log entry within the following resource contexts:
View a pinned log entry in the Histogram pane
You can use the Histogram pane to highlight, scroll to, and further examine a pinned log entry.
Using the Histogram pane, click on the pin icon push_pin and then choose from the following menu options:
- Scroll to log entry: Bring the log entry into the current Query results pane and view the pinned log entry in the context of nearby logs.
- Zoom to log entry: Narrow the time range that the Histogram pane displays and refine your query to isolate the logs near the pinned log.
View trace data
When a log entry contains both the
trace and the latency-related field, both
the latency and trace icon appear.
When a log entry contains only the
trace field, then only the trace icon appears.
To view the trace data related to the log entry, click the trace icon. You have the following options:
- View trace details: Shows the parent span and child traces along with details about the trace. To view more details about the trace, navigate to Cloud Trace by clicking View in Trace. For more information about the content in the details panel, see View trace details.
Show all logs for this trace: Refines and runs the query by adding the
tracefield set to the identifier of the trace associated with the log entry.
Show only traced requests: Refines and runs the query by adding the
traceSampledfield set to
True. For more information on sampling, see Sampling rate.
View Monitoring data
For certain logs, such as GKE and Compute Engine logs, you can click on the resource type from the log's summary line to display a menu with the following options:
- View monitoring details: opens a details panel for a GKE resource. For information on the details panel, see View resource details.
- View in Monitoring: opens to a Monitoring page for the resource.
- View in GKE or View in Compute Engine: opens the Details page for the resource within the GKE or Compute Engine user interface.
Copy a link to a log entry
To share a link to a log, expand a log entry, and then select Copy link. The link is copied to your clipboard. You can send the link to users who have access to the Cloud project. When a user pastes the link into a browser or selects it, Logging pins the log entry in their Query results pane.
You can download your logs in CSV or JSON format. You need one of the following Identity and Access Management roles to download logs:
- Logging Admin (
- Logs View Accessor (
To download your logs, do the following:
Click Download in the Query results pane.
In the Download logs dialog, select CSV or JSON format.
Select what to do with the log data. You have the following options:
- Download the data to your computer.
- Download the data to Drive.
- View the data in a new tab.
When you save a CSV and select Drive, you can open the file in Sheets.
For suggested queries, arranged by Google Cloud product and use case, see Sample queries using the Logs Explorer. For example, you can run Kubernetes-related queries to find Google Kubernetes Engine logs.
View Compute Engine logs
For certain Compute Engine resource types, such as
gce_network, you see the resource name with the resource ID as subtext in
several places in the Logs Explorer. For example, for the
resource type, you see the VM name alongside the VM ID. The resource names help
you identify the correct resource ID, on which you can build queries.
You might see Compute Engine resource names in the following places:
- Query pane filter menus: Compute Engine resource types show resource names, with their corresponding resource IDs as subtext.
- Log fields: Compute Engine resource types show the resource name, rather than the resource ID, in the field dimensions.
- Query results: For Compute Engine VM instance logs, the
resource.labelsfield shows metadata with the corresponding resource name.
- Summary fields: For Compute Engine VM instance logs, the chip shows the resource name instead of the resource ID.
This section provides instructions for troubleshooting common issues when using the Logs Explorer.
If you're experiencing issues when trying to view logs in sink destinations, see Troubleshoot routing and sinks.
Get Cloud project or organization ID
To get a Cloud project or organization ID from anywhere in the Google Cloud console, expand the list of Cloud projects from the Cloud project and organization selector and find the Cloud project ID in the ID column:
Can't see log entries
If you don't see any log entries, check the following:
Is the correct Cloud project selected? If not, select the correct Cloud project from the Cloud project and organization selector.
Is your Cloud project using resources that generate logs and is there activity on those resources? Even if the Cloud project is new, it should have audit logs recording the fact that it was created. Verify you're using a resource that generates logs, by going to the "Mapping services to resource types" section in the Monitored resource list page.
Is the time range too narrow? Verify the time range in your query is correct.
View your current exclusion queries to ensure that the logs you're looking for aren't accidentally excluded.
Is the correct scope being used to view logs? For instructions on adjusting the scope of your search, see Refine scope.
My query is correct but I still don't see log entries
You can't see log entries that are older than the Logging retention period. See Log retention periods for the logs retention period in effect.
During periods of heavy load, there could be delays in sending logs to Logging or in receiving and displaying the logs.
The Logs Explorer doesn't show log entries that have timestamps in the future until the current time has "caught up" with them. This is an unusual situation, probably caused by a time skew in the application sending the logs.
The query scope was set too large and couldn't complete within a reasonable amount of time time. You might see this as "deadline expired before operation could complete". Try making your query more specific or reducing the time range.
Query returns an error
If you issue a query over a resource without specifying a bucket, then
Cloud Logging uses the history of the sinks in the Google Cloud project to
determine where entries might have been written for that resource. If
Cloud Logging identifies more than 200 buckets where entries
might have been written, then the query fails with the message
Error: Invalid query.
To resolve this issue, refine the scope of your query to a subset of the storage. For more information, see Refine scope.
Query results time range doesn't match query
The logs data you see in the Query results and Log fields panes adjusts according to the time range captured by the histogram timeline. You adjust the histogram timeline using the histogram's time controls or the time-range selector. Adjusting these time controls doesn't alter the query expression in the Query pane.
If you have a query with a timestamp, the time-range selector is disabled, and the query uses the timestamp expression as its time-range restriction. If a query doesn't use a timestamp expression, then the query uses the time-range selector as its time-range restriction.
For information on getting support, see the Google Cloud's operations suite support page.