Enable Cloud Profiler API
Cloud Profiler: Qwik Start
Cloud Profiler is a statistical, low-overhead profiler that continuously gathers CPU usage and memory-allocation information from your production applications. It attributes that information to the application's source code, helping you identify the parts of the application consuming the most resources, and otherwise illuminating the performance characteristics of the code.
In this lab you will learn how to set up and use Cloud Profiler. First you'll download a sample Go program and run it with profiling enabled. Then you'll use the Cloud Profiler interface to explore the captured data.
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).
- Time to complete the lab---remember, once you start, you cannot pause a lab.
How to start your lab and sign in to the Google Cloud Console
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
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.
If necessary, copy the Username from the Lab Details panel and paste it into the Sign in dialog. Click Next.
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.
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.
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.
- 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:
gcloud is the command-line tool for Google Cloud. It comes pre-installed on Cloud Shell and supports tab-completion.
(Optional) You can list the active account name with this command:
Your output should now look like this:
(Optional) You can list the project ID with this command:
gcloud, in Google Cloud, refer to the gcloud CLI overview guide.
Task 1. Enable the Stackdriver Profiler API
To enable the Strackriver Profiler API:
In the Navigation menu , click APIs & services > Library.
Type "Stackdriver Profiler" in the search box.
Click the Stackdriver Profiler API, and then click Enable if it is not Enabled.
Task 2. Get a program to profile
The sample program,
profiler_quickstart, is in the golang-samples repository on GitHub.
- To get it, retrieve the package of Go samples:
Task 3. Profile the code
profiler_quickstart program creates a CPU-intensive workload to provide data to the profiler.
Your previous command imported the
profiler_quickstart program as a
Go module and you are now able to directly run the program.
Run the following to start the program. You can leave it running:
This program is designed to load the CPU as it runs, and configured to use Cloud Profiler. Cloud Profiler collects profiling data from the program as it runs and periodically saves it. Progress is indicated with a pair of messages:
The program will continue to emit these messages while it runs.
Let 2-3 profiles get created, then continue with the lab.
Task 4. Start the Profiler interface
- In the Console, go to Profiler.
- From the Navigation menu, in the Operations section, click on Profiler.
The Profiler interface opens:
The interface is divided into two general areas:
A control area for selecting the data to visualize.
A flame-graph representation of the selected data.
The interface offers an array of controls for exploring the profiling data. At the top of the interface, there are time controls, so you can examine data for the time range you choose.
Below that are options choosing the set of profile data to use:
- Service is for selecting the origin of the profiled data, useful if you are profiling several different applications.
- Profile type lets you choose the kind of profile data to display.
- Zone name and Version let you restrict display to data from Compute Engine zones or versions of the application.
Just below the selectors for Service, Profile, etc. is the filter selector. Filters allow you to refine how the graph displays data. In the screenshot above, the CPU time filter is on, so all the CPU time data is displayed.
Exploring the data
Below the selection controls, the selected data is displayed as a flame graph. This type of chart shows you the call stacks in the program. Each function is represented by a frame in the graph, and its relative size shows the proportion of resource consumption that function is responsible for.
The top frame represents the entire program. This frame always shows 100% of the resource consumption, and it indicates how many profiles are averaged together in this graph.
The sample program does not appear to have a complicated set of call stacks; in the preceding screenshot, you see 5 frames:
- The gray frame represents the entire executable, which accounts for 100% of the resources being consumed.
- The green
mainframe is the Go
- The orange
mainframe is the main routine of the sample program.
- The orange
busyloopframe is a routine called from the sample's
- The orange
main.loadframe is a routine called from the sample's
The filter selector lets you do things like filter out functions. For example, if there is a standard library of utility functions, you can remove them from the graph. You can also remove call stacks originating at a certain method, and simplify the graph in other ways.
profiler_quickstart application is very simple, so there's not much to filter out, but in a complex application, being able to remove elements from the graph is very useful.
To practice exploring the data, use a filter to hide the call stack from the main routine to let you see what's happening outside main.
This extra work accounts for a tiny 0.29% of the resource consumption, but it makes a much more interesting flame graph.
Click next to the CPU time filter to see other available filters.
Select Hide stacks then type in "main" as the value. Your flame graph will look something like this:
The more profiles that get generated, the more interesting your flame graph gets. In a few minutes refresh the Stackdriver Profiler console to see the graph develop. Wait a few more minutes and do it again.
You learned how to use Cloud Profiler on Google Cloud.
Finish your quest
This self-paced lab is part of the Cloud Development quest. A quest is a series of related labs that form a learning path. Completing this 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 this quest or any quest that contains this lab and get immediate completion credit. See the Google Cloud Skills Boost catalog to see all available quests.
Next steps / learn more
This lab is also part of a series of labs called Qwik Starts. These labs are designed to give you a little taste of the many features available with Google Cloud. Search for "Qwik Starts" in the lab catalog to find the next lab you'd like to take!
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 November 30, 2022
Lab last tested November 30, 2022
Copyright 2023 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.