Note: Go 1.11 has reached end of support on January 30, 2024. Your existing Go 1.11 applications will continue to run and receive traffic. However, App Engine might block re-deployment of applications that use runtimes after their end of support date. We recommend that you migrate to the latest supported version of Go.

Caching data with Memorystore

High performance scalable web applications often use a distributed in-memory data cache in front of or in place of robust persistent storage for some tasks. We recommend using Memorystore for Redis as your caching service. Note that Memorystore for Redis does not provide a free tier. See Memorystore Pricing for details.

Before getting started, make sure your app will stay within the Memorystore for Redis quotas.

When to use a memory cache

Session data, user preferences, and other data returned by queries for web pages are good candidates for caching. In general, if a frequently run query returns a set of results that do not need to appear in your app immediately, you can cache the results. Subsequent requests can check the cache and only query the database if the results are absent or have expired.

If you store a value only in Memorystore without backing it up in persistent storage, be sure that your application behaves acceptably if the value expires and is removed from the cache. For example, if the sudden absence of a user's session data would cause the session to malfunction, that data should probably be stored in the database in addition to Memorystore.

Understanding Memorystore permissions

Every interaction with a Google Cloud service needs to be authorized. For example, to interact with a Redis database hosted by Memorystore, your app needs to supply the credentials of an account that is authorized to access Memorystore.

By default your app supplies the credentials of the App Engine default service account, which is authorized to access databases in the same project as your app.

If any of the following conditions are true, you need to use an alternative authentication technique that explicitly provides credentials:

Your app and the Memorystore database are in different Google Cloud projects.
You have changed the roles assigned to the default App Engine service account.

For information about alternative authentication techniques, see Setting up Authentication for Server to Server Production Applications.

Overview of using Memorystore

To use Memorystore in your app:

Set up Memorystore for Redis, which requires you to create a Redis instance on Memorystore and create a Serverless VPC Access that your app uses to communicate with the Redis instance. The order of creating these two independent entities is not strict and can be set up in any order. The instructions in this guide show setting up Serverless VPC Access first.
Install a client library for Redis and use Redis commands to cache data.

Memorystore for Redis is compatible with any client library for Redis. This guide describes using the redigo client library to send Redis commands from your app.
Test your updates.
Deploy your app to App Engine.

Setting up Memorystore for Redis

To set up Memorystore for Redis:

Connect your App Engine to a VPC network. Your app can only communicate with Memorystore through a VPC connector.

Be sure to add the VPC connection information to your app.yaml file as described in Configuring your app use the connector.
Note the IP address and port number of the Redis instance you create. You will use this information when you create a Redis client in your code.
Create a Redis instance in Memorystore.

When prompted to select a region for your Redis instance, select the same region in which your App Engine app is located.

Installing dependencies

To make the redigo client library available to your app when it runs in App Engine, add the library to your app's dependencies. For example, if you use a go.mod file to declare dependencies, add the following line to your go.mod file:

module github.com/GoogleCloudPlatform/golang-samples/tree/master/memorystore/redis

Learn more about specifying dependencies for your Go app.

Creating a Redis client

To interact with a Redis database, your code needs to create a Redis client to manage the connection to your Redis database. The following sections describe creating a Redis client using the redigo client library.

Specifying environment variables

The redigo client library uses two environment variables to assemble the URL for your Redis database:

A variable to identify the IP address of the Redis database you created in Memorystore.
A variable to identify the port number of the Redis database you created in Memorystore.

We recommend you define these variables in your app's app.yaml file instead of defining them directly in your code. This makes it easier to run your app in different environments, such as a local environment and App Engine.

For example, add the following lines to your app.yaml file:

 env_variables:
      REDISHOST: '10.112.12.112'
      REDISPORT: '6379'

Importing redigo and creating the client

After you define the REDISHOST and REDISPORT environment variables, use the following lines to import the redigo library, create a connection pool, and then retrieve a Redis client from the pool:


// Command redis is a basic app that connects to a managed Redis instance.
package main

import (
	"fmt"
	"log"
	"net/http"
	"os"

	"github.com/gomodule/redigo/redis"
)

var redisPool *redis.Pool

func incrementHandler(w http.ResponseWriter, r *http.Request) {
	conn := redisPool.Get()
	defer conn.Close()

	counter, err := redis.Int(conn.Do("INCR", "visits"))
	if err != nil {
		http.Error(w, "Error incrementing visitor counter", http.StatusInternalServerError)
		return
	}
	fmt.Fprintf(w, "Visitor number: %d", counter)
}

func main() {
	redisHost := os.Getenv("REDISHOST")
	redisPort := os.Getenv("REDISPORT")
	redisAddr := fmt.Sprintf("%s:%s", redisHost, redisPort)

	const maxConnections = 10
	redisPool = &redis.Pool{
		MaxIdle: maxConnections,
		Dial:    func() (redis.Conn, error) { return redis.Dial("tcp", redisAddr) },
	}

	http.HandleFunc("/", incrementHandler)

	port := os.Getenv("PORT")
	if port == "" {
		port = "8080"
	}
	log.Printf("Listening on port %s", port)
	if err := http.ListenAndServe(":"+port, nil); err != nil {
		log.Fatal(err)
	}
}

Using Redis commands to store and retrieve data in the cache

While the Memorystore Redis database supports most Redis commands, you only need to use a few commands to store and retrieve data from the cache. The following table suggests Redis commands you can use to cache data. To see how to call these commands from your app, view your client library's documentation.

Task	Redis command
Create an entry in the data cache and set an expiration time for the entry	SETNX MSETNX
Retrieve data from the cache	GET MGET
Replace existing cache values	SET MSET
Increment or decrement numeric cache values	INCR INCRBY DECR DECRBY
Delete entries from the cache	DEL UNLINK
Support concurrent interactions with the cache	See details about Redis transactions.

Testing your updates

When you test your app locally, consider running a local instance of Redis to avoid interacting with production data (Memorystore doesn't provide an emulator). To install and run Redis locally, follow the directions in the Redis documentation. Note that it currently isn't possible to run Redis locally on Windows.

Deploying your app

Once your app is running in the local development server without errors:

Test the app on App Engine.
If the app runs without errors, use traffic splitting to slowly ramp up traffic for your updated app. Monitor the app closely for any database issues before routing more traffic to the updated app.