arrow_back

Using Cloud Error Reporting to Remediate Workload Issues on GKE

Join Sign in

Using Cloud Error Reporting to Remediate Workload Issues on GKE

1 hour 1 Credit

GSP939

Google Cloud self-paced labs logo

Overview

Cloud Error Reporting automatically groups application errors based on stack trace message patterns and shows the frequency of each error group. On opening an error group report, SREs can access the exact line of code in an application where the error occurred and navigate to the line of the source code on Google Cloud Source Repository.

In this lab, you will explore leveraging Cloud Error Reporting to understand the error reports of an application and application issues

Objectives

In this lab, you will learn how to:

  1. Explore Cloud Error Reporting error group reports to view details about errors

  2. Understand how to view errors and service errors

  3. Change the resolution status of a noticed error

  4. Link Errors to an issue tracker to triage to development teams

Prerequisites

Familiarity with SRE principles and Cloud Operations tools made available by Google Cloud Platform

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 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 Console. 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 from the Lab Details panel and paste it into the Sign in dialog. Click Next.

  4. Copy the Password from the Lab Details panel and paste it into the Welcome dialog. Click Next.

    Important: You must use the credentials from the left panel. Do not use your Google Cloud Skills Boost credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.
  5. 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 Cloud Console opens in this tab.

Note: You can view the menu with a list of Google Cloud Products and Services by clicking the Navigation menu at the top-left. Navigation menu icon

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 Activate Cloud Shell icon 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 YOUR_PROJECT_ID

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

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

gcloud auth list
  1. Click Authorize.

  2. Your output should now look like this:

Output:

ACTIVE: * ACCOUNT: student-01-xxxxxxxxxxxx@qwiklabs.net To set the active account, run: $ gcloud config set account `ACCOUNT`
  1. (Optional) You can list the project ID with this command:

gcloud config list project

Output:

[core] project = <project_ID>

Example output:

[core] project = qwiklabs-gcp-44776a13dea667a6 Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

Error Reporting overview

Cloud Error Reporting (documentation) automatically groups errors depending on stack trace message patterns and shows the frequency of each error group. The error groups are generated automatically, based on stack traces.

On opening an error group report, operators can access to the exact line in the application code where the error occurred and reason about the cause by navigating to the line of the source code on Google Cloud Source Repository.

Task 1. Using Error Reporting

  1. You can access Error Reporting by selecting Error Reporting from the Google Cloud navigation menu (Navigation menu icon).
Note: Error Reporting can also let you know when new errors are received; for more information, refer to Notifications for Error Reporting.
  1. To get started, select any open error by clicking on the error in the Error field:

The Error Details page

The Error Details screen shows you when the error has been occurring in the timeline and provides the stack trace that was captured with the error.

  1. Scroll down to see samples of the error:

The Recent Samples section

  1. Open View Logs in another tab for one of the samples to see the log messages that match this particular error:

The Query results list displaying log messages for the following error: TypeError: Cannot read property 'debug' of undefined at raceExporter.export...

  1. You can expand any of the messages that matches the filter to see the full stack trace:

An expanded message on the Query results page

  1. Navigate back to Error reporting page, from the topbar click on the Open dropdown and select Acknowledeged to change the resolution status of the error group manually.

The top bar of the Error reporting page

Check if Error group was marked as Acknowledged

When you acknowledge an error group you can add a url to your issue tracker. Then you can go directly to your issue tracker from the error group.

  1. Click on Link to issue and enter the following as a sample issue tracker url:

https://my-issue-tracker.com/my-first-issue Check if linked to issue tracker

Congratulations!

In this lab, you explored Cloud Error Reporting error group reports to view details about errors, understand how to view errors and service errors, change the resolution status of a noticed error, link Errors to an issue tracker to triage to development teams.

Finish your quest

This self-paced lab is part of the Google Cloud's Operations Suite on GKE, Cloud Architecture, and DevOps Essentials quests and the Measure Site Reliability using Cloud Operations Suite quests. A quest is a series of related labs that form a learning path. Completing a quest earns you a badge to recognize your achievement. You can make your badge or badges public and link to them in your online resume or social media account. Enroll in any quest that contains this lab and get immediate completion credit. Refer to the Google Cloud Skills Boost catalog for all available quests.

Take your next lab

Continue your quest with Cloud Logging on Kubernetes Engine, or check out these suggestions:

Next steps

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: September 29, 2022

Lab Last Tested: December 14, 2021

End your lab

When you have completed your lab, click End Lab. Your account and the resources you've used are removed from the lab platform.

You will be given an opportunity to rate the lab experience. Select the applicable number of stars, type a comment, and then click Submit.

The number of stars indicates the following:

  • 1 star = Very dissatisfied
  • 2 stars = Dissatisfied
  • 3 stars = Neutral
  • 4 stars = Satisfied
  • 5 stars = Very satisfied

You can close the dialog box if you don't want to provide feedback.

For feedback, suggestions, or corrections, please use the Support tab.

Copyright 2022 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.