GSP617

Overview

Cloud Logging serves as a central repository for logs from various Google Cloud services, including BigQuery, and is ideal for short to mid-term log storage. Many industries require logs to be retained for extended periods. To keep logs for extended historical analysis or complex auditing, you can set up a sink to export specific logs to BigQuery.

In this lab you view the BigQuery logs inside Cloud Logging, set up a sink to export them into BigQuery, and then use SQL to analyze the logs.

Setup and requirements

Before you click the Start Lab button

Read these instructions. Labs are timed and you cannot pause them. The timer, which starts when you click Start Lab, shows how long Google Cloud resources will be made available to you.

This hands-on lab lets you do the lab activities yourself in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials that you use to sign in and access Google Cloud for the duration of the lab.

To complete this lab, you need:

• Access to a standard internet browser (Chrome browser recommended).

Note: Use an Incognito or private browser window to run this lab. This prevents any conflicts between your personal account and the Student account, which may cause extra charges incurred to your personal account.

• Time to complete the lab---remember, once you start, you cannot pause a lab.

Note: If you already have your own personal Google Cloud account or project, do not use it for this lab to avoid extra charges to your account.

How to start your lab and sign in to the Google Cloud console

1. Click the Start Lab button. If you need to pay for the lab, a pop-up opens for you to select your payment method. On the left is the Lab Details panel with the following:

   • The Open Google Cloud console button
   • Time remaining
   • The temporary credentials that you must use for this lab
   • Other information, if needed, to step through this lab

2. Click Open Google Cloud console (or right-click and select Open Link in Incognito Window if you are running the Chrome browser).

   The lab spins up resources, and then opens another tab that shows the Sign in page.

   Tip: Arrange the tabs in separate windows, side-by-side.

   Note: If you see the Choose an account dialog, click Use Another Account.

3. If necessary, copy the Username below and paste it into the Sign in dialog.

   {{{user_0.username | "Username"}}}

   You can also find the Username in the Lab Details panel.

4. Click Next.

5. Copy the Password below and paste it into the Welcome dialog.

   {{{user_0.password | "Password"}}}

   You can also find the Password in the Lab Details panel.

6. Click Next.

   Important: You must use the credentials the lab provides you. Do not use your Google Cloud account credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.

7. Click through the subsequent pages:

   • Accept the terms and conditions.
   • Do not add recovery options or two-factor authentication (because this is a temporary account).
   • Do not sign up for free trials.

After a few moments, the Google Cloud console opens in this tab.

Note: To view a menu with a list of Google Cloud products and services, click the Navigation menu at the top-left.

Activate Cloud Shell

Cloud Shell is a virtual machine that is loaded with development tools. It offers a persistent 5GB home directory and runs on the Google Cloud. Cloud Shell provides command-line access to your Google Cloud resources.

1. Click Activate Cloud Shell at the top of the Google Cloud console.

When you are connected, you are already authenticated, and the project is set to your Project_ID, . The output contains a line that declares the Project_ID for this session:

Your Cloud Platform project in this session is set to {{{project_0.project_id | "PROJECT_ID"}}}

gcloud is the command-line tool for Google Cloud. It comes pre-installed on Cloud Shell and supports tab-completion.

2. (Optional) You can list the active account name with this command:

gcloud auth list

3. Click Authorize.

Output:

ACTIVE: * ACCOUNT: {{{user_0.username | "ACCOUNT"}}} To set the active account, run: $ gcloud config set account `ACCOUNT`

4. (Optional) You can list the project ID with this command:

gcloud config list project

Output:

[core] project = {{{project_0.project_id | "PROJECT_ID"}}} Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

Task 1. Open BigQuery

Open the BigQuery console

1. In the Google Cloud Console, select Navigation menu > BigQuery.

The Welcome to BigQuery in the Cloud Console message box opens. This message box provides a link to the quickstart guide and the release notes.

2. Click Done.

The BigQuery console opens.

Task 2. Create a dataset

1. Under the Explorer section, click on the three dots next to the project that starts with qwiklabs-gcp-.

2. Click Create dataset.

3. Set Dataset ID to bq_logs.

4. Click CREATE DATASET.

Click Check my progress to verify the objective. Create a Dataset

Task 3. Run a query

First, run a simple query which generates a log. Later you will use this log to set up the log export from to BigQuery.

1. Copy and paste the following query into the BigQuery Query editor:

SELECT current_date

2. Click RUN.

Task 4. Set up log export from Cloud Logging

1. In the Cloud console, select Navigation menu > Logging > Logs Explorer.

Note: If prompted, Click LEAVE for Unsaved work.

2. In Resource, select BigQuery, then click Apply.

3. Now, click Run query button in the top right.

A few log entries from the query should appear.

Look for the entry that contains the word "jobcompleted".

4. Click on the arrow on the left to expand the entry.

Then click on Expand nested fields button on the right hand side.

This shows the full JSON log entry. Scroll down and have a look at the different fields.

5. Scroll back up to the header of the entry, click on jobcompleted and choose Show matching entries.

This sets up the search with the correct terms. You may need to toggle the Show Query button to see it.

Create sink

Now that you have the logs you need, time to set up a sink.

1. Click Create sink from the More actions drop-down.

2. Fill in the fields as follows:

• Sink name: JobComplete and click NEXT.
• Select sink service: BigQuery dataset
• Select Bigquery dataset (Destination): bq_logs (The dataset you setup previously)
• Leave the rest of the options at the default settings.

3. Click CREATE SINK.

Any subsequent log entries from BigQuery are now exported to a table in the bq_logs dataset.

Click Check my progress to verify the objective. Create a Sink

Task 5. Run example queries

To populate your new table with some logs, run some example queries.

• Navigate to Cloud Shell, then add each of the following BigQuery commands into Cloud Shell:

bq query --location=us --use_legacy_sql=false --use_cache=false \ 'SELECT fullName, AVG(CL.numberOfYears) avgyears FROM `qwiklabs-resources.qlbqsamples.persons_living`, UNNEST(citiesLived) as CL GROUP BY fullname' bq query --location=us --use_legacy_sql=false --use_cache=false \ 'select month, avg(mean_temp) as avgtemp from `qwiklabs-resources.qlweather_geo.gsod` where station_number = 947680 and year = 2010 group by month order by month' bq query --location=us --use_legacy_sql=false --use_cache=false \ 'select CONCAT(departure_airport, "-", arrival_airport) as route, count(*) as numberflights from `bigquery-samples.airline_ontime_data.airline_id_codes` ac, `qwiklabs-resources.qlairline_ontime_data.flights` fl where ac.code = fl.airline_code and regexp_contains(ac.airline , r"Alaska") group by 1 order by 2 desc LIMIT 10'

You should see the results of each query returned.

Click Check my progress to verify the objective. Run example queries

Task 6. Viewing the logs in BigQuery

1. Navigate back to BigQuery (Navigation menu > BigQuery).

2. Expand your resource starting with the name qwiklabs-gcp- and expand your dataset bq_logs.

The name may vary, but you should see a "cloudaudit_googleapis_com_data_access" table.

Note: You may have to re-run the example queries to get the table to show up.

3. Click on the table name, then inspect the schema of the table and notice it has a very large number of fields.

If you clicked Preview and wondered why it doesn't show the logs for the recently run queries, its because the logs are streamed into the table, which means that the new data can be queried but won't show up in Preview for a little while.

To make the table more usable, create a VIEW, which pulls out subset of fields and also performs some calculations to derive a metric for query time.

4. Click Compose New Query. In the BigQuery query EDITOR, run the following SQL after replacing with the name of your project (the Project ID can be easily copied from the Lab Details panel on the left side of the lab page):

CREATE OR REPLACE VIEW bq_logs.v_querylogs AS SELECT resource.labels.project_id, protopayload_auditlog.authenticationInfo.principalEmail, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobConfiguration.query.query, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobConfiguration.query.statementType, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatus.error.message, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.startTime, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.endTime, TIMESTAMP_DIFF(protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.endTime, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.startTime, MILLISECOND)/1000 AS run_seconds, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.totalProcessedBytes, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.totalSlotMs, ARRAY(SELECT as STRUCT datasetid, tableId FROM UNNEST(protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.referencedTables)) as tables_ref, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.totalTablesProcessed, protopayload_auditlog.servicedata_v1_bigquery.jobCompletedEvent.job.jobStatistics.queryOutputRowCount, severity FROM `<YOUR-PROJECT-ID>.bq_logs.cloudaudit_googleapis_com_data_access_*` ORDER BY startTime

Click Check my progress to verify the objective. Viewing the logs in BigQuery

5. Now query the VIEW. Compose a new query, and run the following command:

SELECT * FROM bq_logs.v_querylogs

6. Scroll through the results of the executed queries.

Congratulations!

You successfully exported BigQuery logs from Cloud Logging to a BigQuery table, then analyzed them with SQL.

Next steps / Learn more

• Read through the Cloud Logging documentation.
• Read through the BigQuery documentation.

Google Cloud training and certification

...helps you make the most of Google Cloud technologies. Our classes include technical skills and best practices to help you get up to speed quickly and continue your learning journey. We offer fundamental to advanced level training, with on-demand, live, and virtual options to suit your busy schedule. Certifications help you validate and prove your skill and expertise in Google Cloud technologies.

Manual Last Updated: February 5, 2024

Lab Last Tested: September 27 2023

Copyright 2024 Google LLC All rights reserved. Google and the Google logo are trademarks of Google LLC. All other company and product names may be trademarks of the respective companies with which they are associated.