Skip to main content

Serverless Redis on Google Cloud Functions

Google Cloud Functions is the second most popular serverless execution platform. Similar to AWS Lambda it is stateless, namely you need to access external resources to read or write your applications state. In this post, we will introduce Redis as a database for your Google Cloud functions.

This tutorial shows how to build a serverless API with Redis on Google Cloud Functions. The API will simply count the page views and show it in JSON format.

See the demo: https://us-central1-functions-317005.cloudfunctions.net/helloGET

See the code: https://github.com/upstash/examples/tree/master/using-google-cloud-functions

The Stack#

  • Serverless compute: Google Cloud Functions (Node.js)
  • Serverless data store: Redis via Upstash
  • Deployment tool: gcloud

Prerequisites:#

  • A GCP account for Google Cloud functions.
  • Install Google Cloud SDK.
  • An Upstash account for Serverless Redis.

Step 1: Init the Project#

  • Create a folder, then run npm init inside the folder.

Step 2: Install a Redis Client#

Our only dependency is redis client. Install go-redis via npm install ioredis

Step 3: Create a Redis Database#

Create a Redis database from Upstash console. Select the GCP US-Central-1 as the region. Free tier should be enough. It is pretty straight forward but if you need help, check getting started guide. In the database details page, click the Connect button. You will need the endpoint and password in the next step.

Step 4: The function Code#

Create index.js as below:

var Redis = require("ioredis");
if (typeof client === 'undefined') {
var client = new Redis("REPLACE_YOUR_UPSTASH_REDIS_URL");
}
exports.helloGET = async(req, res) => {
let count = await client.incr("counter");
res.send('Page view:' + count);
};

Replace the "REPLACE_YOUR_UPSTASH_REDIS_URL" with your database's ioredis url.

The code simply increments a counter in Redis database and returns its value in json format.

Step 5: Deployment#

Now we are ready to deploy our API. Deploy via:

gcloud functions deploy helloGET \
--runtime nodejs14 --trigger-http --allow-unauthenticated

You will see the URL of your Cloud Function. Click to the URL to check if it is working properly.

httpsTrigger:
securityLevel: SECURE_OPTIONAL
url: https://us-central1-functions-317005.cloudfunctions.net/helloGET

In case of an issue, you can check the logs of your Cloud Function in the GCP console as below.