How-to Guides

Writing Cloud Functions

• Overview

  Overview of writing Cloud Functions.

• HTTP Functions

  Invoke Cloud Functions from standard HTTP requests.

• Background Functions

  Use background functions to handle events from your cloud infrastructure, such as messages on a Cloud Pub/Sub topic, or changes in a Google Cloud Storage bucket.

• Specifying Dependencies for Node.js

  Learn how to specify dependencies for Cloud Functions written in Node.js.

• Specifying Dependencies for Python

  Learn how to specify dependencies for Cloud Functions written in Python.

• Specifying Dependencies for Go

  Learn how to specify dependencies for Cloud Functions written in Go.

Deploying Cloud Functions

• Overview

  Overview of deploying Cloud Functions.

• Deploying from Your Local Machine

  Deploy Cloud Functions from your local machine.

• Deploying from Source Control

  Deploy Cloud Functions from Google Cloud Source Repositories.

• Deploying from Cloud Console

  Deploy Cloud Functions from Cloud Console.

Calling Cloud Functions

• Overview

  Overview of calling Cloud Functions.

• HTTP Triggers

  Use HTTP methods to trigger Cloud Functions.

• Cloud Pub/Sub Triggers

  Asynchronously trigger Cloud Functions via a Pub/Sub topic.

• Cloud Storage Triggers

  Trigger Cloud Functions in response to change notifications from Google Cloud Storage.

• Direct Triggers

  Manually invoke a Cloud Function for quick iteration and debugging.

• Cloud Firestore Triggers

  Trigger Cloud Functions in response to Firestore events.

• Google Analytics for Firebase Triggers

  Trigger Cloud Functions in response to Google Analytics for Firebase events.

• Firebase Realtime Database Triggers

  Trigger Cloud Functions in response to Firebase Realtime Database events.

• Firebase Authentication Triggers

  Trigger Cloud Functions in response to Firebase authentication events.

• Second-Party Triggers with Stackdriver

  Trigger Cloud Functions in response to events from Google Cloud Platform services that produce Stackdriver audit logs.

• Using Cloud Scheduler to Trigger a Cloud Function

  Invoke a Cloud Function on a time-based schedule using Cloud Scheduler and a Cloud Pub/Sub trigger. This enables you to set up cron jobs which run periodically at specific time intervals.

Testing Cloud Functions

• Testing Basics

  Learn how to create unit, system, and integration testing with Cloud Functions.

• Testing HTTP Functions

  Learn how to test HTTP Cloud Functions. Cloud Functions can be either HTTP functions, or background functions.

• Testing Background Functions

  Learn how to test background Cloud Functions. You use background functions when you want to have your Cloud Function invoked indirectly in response to an event, such as a message on a Cloud Pub/Sub topic, a change in a Cloud Storage bucket, or a Firebase event.

• CI/CD

  Learn how to configure a continuous integration and deployment (CI/CD) pipeline to run Cloud Functions tests on an ongoing basis.

Securing Cloud Functions

• Function Identity

  Understand what identity your function runs as, how to configure this identity and change its permissions, and how to get identity and access tokens to securely call other functions or Cloud APIs.

Monitoring Cloud Functions

• Overview

  Overview of monitoring Cloud Functions.

• Writing and Viewing Logs

  Use logging with Cloud Functions.

• Reporting Errors

  Report errors from Cloud Functions.

• Viewing Monitored Metrics

  View Cloud Functions monitored metrics.

• Using Cloud Audit Logging

  Learn about the default and optional logs created by Google Cloud Functions as part of Cloud Audit Logging.

Migrating Cloud Functions

• Migrating Cloud Functions to newer Node.js runtimes

  Learn the changes introduced in newer Node.js runtimes and how to update your Node.js functions to run in newer runtimes.

Best Practices

• Tips & Tricks

  Learn best practices for writing, testing, and deploying Cloud Functions.

• Retrying Background Functions

  Learn how to enable retrying of background functions upon failure.

• Optimizing Networking

  Learn how to optimize networking in your functions to minimize the likelihood of running out of DNS or connection quotas.

Controlling Scaling Behavior

• Controlling Scaling Behavior

  Use the max instances feature to limit the degree to which your function will scale in response to incoming requests.

Connecting to Cloud SQL

• Connecting to Cloud SQL

  Connect your Cloud Functions to Cloud SQL instances using a local socket interface provided in the Cloud Functions execution environment.

Connecting to a VPC Network

• Connecting to a VPC Network

  Connect from your Cloud Functions directly to Compute Engine VM instances, Cloud Memorystore instances, Cloud SQL instances, and any other resources with an internal IP address.

Using Environment Variables

• Using Environment Variables

  Define environment variables that will be accessible to your Cloud Functions code at runtime.

Testing Locally

• Functions Framework

  Use the Functions Framework to run, and debug Cloud Functions on your local machine before deploying them to production.