GSP1089

Overview

Cloud Run functions is a Google Cloud's Functions-as-a-Service offering. It comes with an advanced feature set and is powered by Cloud Run and Eventarc, giving you more advanced control over performance and scalability, and more control around the functions runtime and triggers from over 90+ event sources.

In this lab, you create Cloud Run functions that respond to HTTP calls, and get triggered by Cloud Storage events and Cloud Audit Logs. You also deploy multiple revisions of a Cloud Run function and explore new settings.

What's new?

This new version of Cloud Run functions provides an enhanced FaaS experience powered by Cloud Run, Cloud Build, Artifact Registry, and Eventarc.

Enhanced Infrastructure

• Longer request processing: Run your Cloud Run functions longer than the 5 minute default, making it easier to run longer request workloads such as processing large streams of data from Cloud Storage or BigQuery. For HTTP functions, this is up to 60 minutes. For event-driven functions, this is currently up to 10 minutes.
• Larger instances: Take advantage of up to 16GB of RAM and 4 vCPUs on Cloud Run functions allowing larger in-memory, compute-intensive and more parallel workloads.
• Concurrency: Process up to 1000 concurrent requests with a single function instance, minimizing cold starts and improving latency when scaling.
• Minimum instances: Provide for pre-warmed instances to cut your cold starts and make sure the bootstrap time of your application does not impact the application performance.
• Traffic splitting: Support multiple versions of your functions, split traffic between different versions and roll your function back to a prior version.

Broader Event coverage and CloudEvents support

• Eventarc Integration: Cloud Run functions now includes native support for Eventarc, which brings over 125+ event sources using Cloud Audit logs (BigQuery, Cloud SQL, Cloud Storage...), and of course Cloud Run functions still supports events from custom sources by publishing to Cloud Pub/Sub directly.
• CloudEvent format: All event-driven functions adhere to industry standard CloudEvents (cloudevents.io), regardless of the source, to ensure a consistent developer experience. The payloads are sent via a structured CloudEvent with a cloudevent.data payload and implement the CloudEvent standard.

Objectives

In this lab, you:

• Write a function that responds to HTTP calls.
• Write a function that responds to Cloud Storage events.
• Write a function that responds to Cloud Audit Logs.
• Deploy multiple revisions of a Cloud Run function.
• Get rid of cold starts with minimum instances.
• Set up concurrency

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 are made available to you.

This hands-on lab lets you do the lab activities in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials 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 (recommended) or private browser window to run this lab. This prevents 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: Use only the student account for this lab. If you use a different Google Cloud account, you may incur charges to that 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 dialog opens for you to select your payment method. On the left is the Lab Details pane 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 pane.

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 pane.

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 access Google Cloud products and services, click the Navigation menu or type the service or product name in the Search field.

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.

2. Click through the following windows:

   • Continue through the Cloud Shell information window.
   • Authorize Cloud Shell to use your credentials to make Google Cloud API calls.

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.

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

gcloud auth list

4. Click Authorize.

Output:

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

5. (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. Enable APIs

Before you create the Cloud Run functions, you need to enable the relevant APIs.

1. In Cloud Shell, run the following command to set your Project ID variable.

export PROJECT_ID=$(gcloud config get-value project)

2. Run the following command to set the Region variable.

export REGION={{{project_0.default_region | ""}}} gcloud config set compute/region $REGION

3. Execute the following command to enable all necessary services.

gcloud services enable \ artifactregistry.googleapis.com \ cloudfunctions.googleapis.com \ cloudbuild.googleapis.com \ eventarc.googleapis.com \ run.googleapis.com \ logging.googleapis.com \ pubsub.googleapis.com

Task 2. Create an HTTP function

For the first function, you create an authenticated Node.js function that responds to HTTP requests, and use a 10 minute timeout to showcase how a function can have more time to respond to HTTP requests.

Create

1. Run the following command to create the folder and files for the app and navigate to the folder:

mkdir ~/hello-http && cd $_ touch index.js && touch package.json

2. Click the Open Editor button on the toolbar of Cloud Shell. (You can switch between Cloud Shell and the code editor by using the Open Editor and Open Terminal icons as required, or click the Open in new window button to leave the Editor open in a separate tab).

3. In the Editor, add the following code to the hello-http/index.js file that simply responds to HTTP requests:

const functions = require('@google-cloud/functions-framework'); functions.http('helloWorld', (req, res) => { res.status(200).send('HTTP with Node.js in GCF 2nd gen!'); });

4. Add the following content to the hello-http/package.json file to specify the dependencies.

{ "name": "nodejs-functions-gen2-codelab", "version": "0.0.1", "main": "index.js", "dependencies": { "@google-cloud/functions-framework": "^2.0.0" } }

Deploy

1. In Cloud Shell, run the following command to deploy the function:

gcloud functions deploy nodejs-http-function \ --gen2 \ --runtime nodejs18 \ --entry-point helloWorld \ --source . \ --region $REGION \ --trigger-http \ --timeout 600s \ --max-instances 1 Note: If you get permissions error, please wait a few minutes and try the deployment again. It takes a few minutes for the APIs to be enabled.

Although not strictly necessary for this step, there is a timeout of 600 seconds. This allows the function to have a longer timeout to respond to HTTP requests.

2. Once the function is deployed, from the Navigation Menu go to the Cloud Run functions page. Verify the function was deployed successfully.

Test

1. Test the function with the following command:

gcloud functions call nodejs-http-function \ --gen2 --region $REGION

You should see the following message as a response:

HTTP with Node.js in GCF 2nd gen!

Click Check my progress to verify the objective.

Create a HTTP Function

Task 3. Create a Cloud Storage function

In this section create a Node.js function that responds to events from a Cloud Storage bucket.

Setup

1. To use Cloud Storage functions, first grant the pubsub.publisher IAM role to the Cloud Storage service account:

PROJECT_NUMBER=$(gcloud projects list --filter="project_id:$PROJECT_ID" --format='value(project_number)') SERVICE_ACCOUNT=$(gsutil kms serviceaccount -p $PROJECT_NUMBER) gcloud projects add-iam-policy-binding $PROJECT_ID \ --member serviceAccount:$SERVICE_ACCOUNT \ --role roles/pubsub.publisher

Create

1. Run the following command to create the folder and files for the app and navigate to the folder:

mkdir ~/hello-storage && cd $_ touch index.js && touch package.json

2. Add the following code to the hello-storage/index.js file that simply responds to Cloud Storage events:

const functions = require('@google-cloud/functions-framework'); functions.cloudEvent('helloStorage', (cloudevent) => { console.log('Cloud Storage event with Node.js in GCF 2nd gen!'); console.log(cloudevent); });

3. Add the following content to the hello-storage/package.json file to specify the dependencies:

{ "name": "nodejs-functions-gen2-codelab", "version": "0.0.1", "main": "index.js", "dependencies": { "@google-cloud/functions-framework": "^2.0.0" } }

Deploy

1. First, create a Cloud Storage bucket to use for creating events:

BUCKET="gs://gcf-gen2-storage-$PROJECT_ID" gsutil mb -l $REGION $BUCKET

2. Deploy the function:

gcloud functions deploy nodejs-storage-function \ --gen2 \ --runtime nodejs18 \ --entry-point helloStorage \ --source . \ --region $REGION \ --trigger-bucket $BUCKET \ --trigger-location $REGION \ --max-instances 1

3. Once the function is deployed, verify that you can see it under the Cloud Run functions section of the Cloud Console.

Test

1. Test the function by uploading a file to the bucket:

echo "Hello World" > random.txt gsutil cp random.txt $BUCKET/random.txt

2. Run the following command. You should see the received CloudEvent in the logs:

gcloud functions logs read nodejs-storage-function \ --region $REGION --gen2 --limit=100 --format "value(log)" Note: it may take a minute to generate logs.

You should see output similar to the following:

} traceparent: '00-c74cb472d1e78f7225b6f617a31d9c08-96f0380bb62be2c1-01' }, etag: 'CKOx1L3wofoCEAE=' crc32c: 'R1jUOQ==', mediaLink: 'https://storage.googleapis.com/download/storage/v1/b/gcf-gen2-storage-qwiklabs-gcp-00-101b4b9ca9bb/o/random.txt?generation=1663625646643363&alt=media', md5Hash: '5Z/5eUEET4XfUpfhwwLSYA==', size: '12', timeStorageClassUpdated: '2022-09-19T22:14:06.657Z', storageClass: 'STANDARD', updated: '2022-09-19T22:14:06.657Z', timeCreated: '2022-09-19T22:14:06.657Z', contentType: 'text/plain', metageneration: '1', generation: '1663625646643363', bucket: 'gcf-gen2-storage-qwiklabs-gcp-00-101b4b9ca9bb', name: 'random.txt', selfLink: 'https://www.googleapis.com/storage/v1/b/gcf-gen2-storage-qwiklabs-gcp-00-101b4b9ca9bb/o/random.txt', id: 'gcf-gen2-storage-qwiklabs-gcp-00-101b4b9ca9bb/random.txt/1663625646643363', kind: 'storage#object', data: { bucket: 'gcf-gen2-storage-qwiklabs-gcp-00-101b4b9ca9bb', time: '2022-09-19T22:14:06.657124Z', subject: 'objects/random.txt', type: 'google.cloud.storage.object.v1.finalized', specversion: '1.0', source: '//storage.googleapis.com/projects/_/buckets/gcf-gen2-storage-qwiklabs-gcp-00-101b4b9ca9bb', id: '5693030851428996', { Cloud Storage event with Node.js in GCF 2nd gen!

Click Check my progress to verify the objective.

Create a Cloud Storage Function

Task 4. Create a Cloud Audit Logs function

In this section, you create a Node.js function that receives a Cloud Audit Log event when a Compute Engine VM instance is created. In response, it adds a label to the newly created VM, specifying the creator of the VM.

Determine newly created Compute Engine VMs

Compute Engine emits 2 Audit Logs when a VM is created.

The first one is emitted at the beginning of the VM creation and looks like this:

The second one is emitted after the VM creation and looks like this:

Notice the operation field with the first: true and last: true values. The second Audit Log contains all the information you need to label an instance, therefore you use the last: true flag to detect it in Cloud Run functions.

Setup

To use Cloud Audit Log functions, you must enable Audit Logs for Eventarc. You also need to use a service account with the eventarc.eventReceiver role.

1. From the Navigation Menu, go to IAM & Admin > Audit Logs.

Note: you can ignore the missing resourcemanager.folders.getIamPolicy permission warning.

2. Find the Compute Engine API and click the checkbox next to it. If you are unable to find the API, search it on the next page.

3. On the info pane on the right, check Admin Read, Data Read, and Data Write log types and click Save.

4. Grant the default Compute Engine service account the eventarc.eventReceiver IAM role:

gcloud projects add-iam-policy-binding $PROJECT_ID \ --member serviceAccount:$PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role roles/eventarc.eventReceiver

Get the code

1. Run the following code to clone the repo that contains the application:

cd ~ git clone https://github.com/GoogleCloudPlatform/eventarc-samples.git

2. Navigate to the app directory:

cd ~/eventarc-samples/gce-vm-labeler/gcf/nodejs

The index.js file contains the application code that receives the Audit Log wrapped into a CloudEvent. It then extracts the Compute Engine VM instance details and sets a label on the VM instance. Feel free to study index.js in more detail on your own.

Deploy

1. Deploy the function with gcloud as before. Notice how the function is filtering on Audit Logs for Compute Engine insertions with the --trigger-event-filters flag:

gcloud functions deploy gce-vm-labeler \ --gen2 \ --runtime nodejs18 \ --entry-point labelVmCreation \ --source . \ --region $REGION \ --trigger-event-filters="type=google.cloud.audit.log.v1.written,serviceName=compute.googleapis.com,methodName=beta.compute.instances.insert" \ --trigger-location $REGION \ --max-instances 1 Note: Although your Audit Log function trigger is created immediately, it can take up to 10 minutes for triggers to be fully functional.

Click Check my progress to verify the objective.

Create a Cloud Audit Logs Function

Test

To test your Audit Log function, you need to create a Compute Engine VM in the Cloud Console (You can also create VMs with gcloud but it does not seem to generate Audit Logs).

1. From the Navigation Menu, go to Compute Engine > VM instances.

2. Click Create Instance.

3. Leave all of the fields as the default values and click Create.

Once the VM creation completes, you should see the added creator label on the VM in the Cloud Console in the Basic information section.

4. Verify using the following command:

gcloud compute instances describe instance-1 --zone {{{project_0.default_zone | ""}}} Note: This assumes your VM is named instance-1 and is in the zone. If you modified these parameters, be sure to update the command.

You should see the label in the output like the following example:

... labelFingerprint: ULU6pAy2C7s= labels: creator: student-02-19b599a0f901 ...

Click Check my progress to verify the objective.

Create a VM Instance

5. Run the following command to delete the VM. Type Y when prompted to confirm.

gcloud compute instances delete instance-1 --zone {{{project_0.default_zone | ""}}}

Task 5. Deploy different revisions

Cloud Run functions supports multiple revisions of your functions, splitting traffic between different revisions, and rolling your function back to a prior version. In this section, you deploy two revisions of your Cloud Run function.

Create

1. Run the following command to create the folder and files for the app and navigate to the folder:

mkdir ~/hello-world-colored && cd $_ touch main.py touch requirements.txt

2. Add the following code to the hello-world-colored/main.py file with a Python function that reads a color environment variable and responds back with Hello World in that background color:

import os color = os.environ.get('COLOR') def hello_world(request): return f'<body style="background-color:{color}"><h1>Hello World!</h1></body>'

Deploy

1. Deploy the first revision of the function with an orange background:

COLOR=orange gcloud functions deploy hello-world-colored \ --gen2 \ --runtime python39 \ --entry-point hello_world \ --source . \ --region $REGION \ --trigger-http \ --allow-unauthenticated \ --update-env-vars COLOR=$COLOR \ --max-instances 1

At this point, if you test the function by viewing the HTTP trigger (the URI output of the above deployment command) in your browser, you should see Hello World with an orange background:

2. Navigate to the Cloud Run functions page in the Console and click the hello-world-colored function.

3. On the top right of the page under View in Cloud Run click hello-world-colored.

This redirects you to the Cloud Run service page.

4. Click the Revisions tab and then select Edit & Deploy New Revision.

5. Leave everything as default and scroll down and select Variables & Secrets tab and in the Environment Variables section. Update the COLOR environment variable to yellow.

6. Click Deploy.

Since this is the latest revision, if you test the function, you should see Hello World with a yellow background:

Click Check my progress to verify the objective.

Deploy different revisions

Task 6. Set up minimum instances

In Cloud Run functions, one can specify a minimum number of function instances to be kept warm and ready to serve requests. This is useful in limiting the number of cold starts. In this section, you deploy a function with slow initialization. You observe the cold start problem. Then, you deploy the function with the minimum instance value set to 1 to get rid of the cold start.

Create

1. Run the following command to create the folder and files for the app and navigate to the folder:

mkdir ~/min-instances && cd $_ touch main.go touch go.mod

2. Add the following code to the min-instances/main.go file. This Go service has an init function that sleeps for 10 seconds to simulate a long initialization. It also has a HelloWorld function that responds to HTTP calls:

package p import ( "fmt" "net/http" "time" ) func init() { time.Sleep(10 * time.Second) } func HelloWorld(w http.ResponseWriter, r *http.Request) { fmt.Fprint(w, "Slow HTTP Go in GCF 2nd gen!") }

3. Add the following code to the min-instances/go.mod file. This specifies the module path and Go language version:

module example.com/mod go 1.16

Deploy

1. Run the following command to deploy the first revision of the function with the default minimum instance value of zero:

gcloud functions deploy slow-function \ --gen2 \ --runtime go116 \ --entry-point HelloWorld \ --source . \ --region $REGION \ --trigger-http \ --allow-unauthenticated \ --max-instances 4

2. Test the function with this command:

gcloud functions call slow-function \ --gen2 --region $REGION

You should observe a 10 second delay (cold start) on the first call and then see the message. Subsequent calls should return immediately.

Slow HTTP Go in GCF 2nd gen!

Set minimum instances

To get rid of the cold start on the first request, redeploy the function with the --min-instances flag set to 1 as follows:

1. Navigate to the Cloud Run page in the Console and click the slow-function service.

2. Click the Revisions tab and then select Edit & Deploy New Revision.

3. Under the Autoscaling section, set Minimum number of instances to 1 and Maximum number of instances to 4.

4. Leave the rest of the fields as default and click Deploy.

Test

1. Test the function again:

gCloud Run functions call slow-function \ --gen2 --region $REGION

You should not see the 10 second delay anymore in the first request. The cold start problem for the first invocation (after a long time without) is gone, thanks to minimum instances! See using minimum instances for more information.

Click Check my progress to verify the objective.

Set up minimum instances

Task 7. Create a function with concurrency

In Cloud Run functions, a function instance handles 1 concurrent request by default but you can specify the number of concurrent requests that can be processed simultaneously by an instance. This can also be useful in preventing cold starts as a new function instance does not need to be created for every parallel request.

In this section, you use the function with slow initialization from the previous step. You send it 10 requests and observe the cold start problem again as new function instances need to be created to handle the requests.

To fix the cold-start problem, you deploy another function with a concurrency value of 100. You observe that the 10 requests now do not cause the cold start problem and a single function instance can handle all the requests.

Test without concurrency

1. Run the following command to get the URL of the function and save it as an environment variable:

SLOW_URL=$(gcloud functions describe slow-function --region $REGION --gen2 --format="value(serviceConfig.uri)")

2. Use an open source benchmarking tool called hey to send 10 concurrent requests to the slow function. hey is already installed in Cloud Shell:

hey -n 10 -c 10 $SLOW_URL

You should see in the output of hey that some requests are taking long:

Summary: Total: 10.9053 secs Slowest: 10.9048 secs Fastest: 0.4439 secs Average: 9.7930 secs Requests/sec: 0.9170 Total data: 310 bytes Size/request: 31 bytes Response time histogram: 0.444 [1] |■■■■ 1.490 [0] | 2.536 [0] | 3.582 [0] | 4.628 [0] | 5.674 [0] | 6.720 [0] | 7.767 [0] | 8.813 [0] | 9.859 [0] | 10.905 [9] |■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■

This is because more function instances are being created to handle the requests. If you check the active instances count for the function, you should also see that more than one instance was created as some point and these are causing the cold start problem:

3. Run the following command to delete the function. Type Y when prompted to confirm.

gcloud run services delete slow-function --region {{{project_0.default_region | ""}}}

Deploy

1. Deploy a new function identical to the previous function. Once deployed, you increase its concurrency:

gcloud functions deploy slow-concurrent-function \ --gen2 \ --runtime go116 \ --entry-point HelloWorld \ --source . \ --region $REGION \ --trigger-http \ --allow-unauthenticated \ --min-instances 1 \ --max-instances 4

Set concurrency

Now you set the concurrency of the underlying Cloud Run service for the function to 100 (it can be maximum 1000). This ensures that at least 100 requests can be handled by a single function instance.

1. From the Navigation Menu, go to Cloud Run.

2. Click the slow-concurrent-function service.

3. Click the Revisions tab and then select Edit & Deploy New Revision.

4. Under the Resources section, set the CPU to 1.

5. Under Requests, set the Maximum concurrent requests per instance to 100.

6. Under Autoscaling, set the Maximum number of instances to 4.

7. Leave the rest of the fields as default and click Deploy.

Test with concurrency

1. Once your function has deployed, run the following command to get the URL of the new function and save it as an environment variable:

SLOW_CONCURRENT_URL=$(gcloud functions describe slow-concurrent-function --region $REGION --gen2 --format="value(serviceConfig.uri)")

2. Now use hey to send 10 concurrent requests:

hey -n 10 -c 10 $SLOW_CONCURRENT_URL

You should see in the output of hey that all requests are processed quickly:

Summary: Total: 0.0652 secs Slowest: 0.0651 secs Fastest: 0.0619 secs Average: 0.0636 secs Requests/sec: 153.3751 Total data: 280 bytes Size/request: 28 bytes Response time histogram: 0.062 [1] |■■■■■■■■■■■■■■■■■■■■ 0.062 [1] |■■■■■■■■■■■■■■■■■■■■ 0.063 [0] | 0.063 [0] | 0.063 [0] | 0.063 [1] |■■■■■■■■■■■■■■■■■■■■ 0.064 [2] |■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 0.064 [2] |■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 0.064 [2] |■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■ 0.065 [0] | 0.065 [1] |■■■■■■■■■■■■■■■■■■■■

A single function instance was able to handle all the requests and the cold start problem is gone, thanks to the increased concurrency! See concurrency for more information.

Click Check my progress to verify the objective.

Create a function with concurrency

Congratulations!

In this lab, you deployed multiple Cloud Run functions that responded to HTTP Calls, Cloud Storage Events, and Cloud Audit Logs. You then deployed multiple revisions of the Cloud Run services running the functions and set concurrency values and got rid of cold starts with minimum instances.

Next steps / Learn more

For more information about Cloud Run functions, check out the following:

• Cloud Run functions overview
• Getting started with Cloud Run functions codelab

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 13, 2025

Lab Last Tested December 11, 2024

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