Keepalive (#393)

* add connection keepalive * add period DB connection ping calls * change log messages * vet * start w/ idle connection check
google · Aug 27, 2020 · 3edafb7 · 3edafb7
1 parent 37e2f1f
commit 3edafb7
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 10 deletions.
diff --git a/pkg/database/config.go b/pkg/database/config.go
@@ -17,6 +17,7 @@ package database
 import (
 	"fmt"
 	"strings"
+	"time"
 
 	"github.com/google/exposure-notifications-server/pkg/keys"
 	"github.com/google/exposure-notifications-server/pkg/secrets"
@@ -25,16 +26,17 @@ import (
 
 // Config represents the env var based configuration for database connections.
 type Config struct {
-	Name              string `env:"DB_NAME" json:",omitempty"`
-	User              string `env:"DB_USER" json:",omitempty"`
-	Host              string `env:"DB_HOST, default=localhost" json:",omitempty"`
-	Port              string `env:"DB_PORT, default=5432" json:",omitempty"`
-	SSLMode           string `env:"DB_SSLMODE, default=require" json:",omitempty"`
-	ConnectionTimeout uint   `env:"DB_CONNECT_TIMEOUT" json:",omitempty"`
-	Password          string `env:"DB_PASSWORD" json:"-"` // ignored by zap's JSON formatter
-	SSLCertPath       string `env:"DB_SSLCERT" json:",omitempty"`
-	SSLKeyPath        string `env:"DB_SSLKEY" json:",omitempty"`
-	SSLRootCertPath   string `env:"DB_SSLROOTCERT" json:",omitempty"`
+	Name                  string        `env:"DB_NAME" json:",omitempty"`
+	User                  string        `env:"DB_USER" json:",omitempty"`
+	Host                  string        `env:"DB_HOST, default=localhost" json:",omitempty"`
+	Port                  string        `env:"DB_PORT, default=5432" json:",omitempty"`
+	SSLMode               string        `env:"DB_SSLMODE, default=require" json:",omitempty"`
+	ConnectionTimeout     uint          `env:"DB_CONNECT_TIMEOUT" json:",omitempty"`
+	Password              string        `env:"DB_PASSWORD" json:"-"` // ignored by zap's JSON formatter
+	SSLCertPath           string        `env:"DB_SSLCERT" json:",omitempty"`
+	SSLKeyPath            string        `env:"DB_SSLKEY" json:",omitempty"`
+	SSLRootCertPath       string        `env:"DB_SSLROOTCERT" json:",omitempty"`
+	MaxConnectionIdleTime time.Duration `env:"DB_MAX_CONN_IDLE_TIME, default=1m" json:",omitempty"`
 
 	// Debug is a boolean that indicates whether the database should log SQL
 	// commands.

diff --git a/pkg/database/database.go b/pkg/database/database.go
@@ -130,6 +130,10 @@ func (db *Database) OpenWithCacher(ctx context.Context, cacher cache.Cacher) err
 		return fmt.Errorf("database gorm.Open: %w", err)
 	}
 
+	if c.MaxConnectionIdleTime > 0 {
+		rawDB.DB().SetConnMaxIdleTime(c.MaxConnectionIdleTime)
+	}
+
 	// Log SQL statements in debug mode.
 	if c.Debug {
 		rawDB = rawDB.LogMode(true)

diff --git a/terraform/services.tf b/terraform/services.tf
@@ -45,6 +45,7 @@ locals {
     DB_SSLROOTCERT                    = "secret://${google_secret_manager_secret_version.db-secret-version["sslrootcert"].id}?target=file"
     DB_USER                           = google_sql_user.user.name
     DB_VERIFICATION_CODE_DATABASE_KEY = "secret://${google_secret_manager_secret_version.db-verification-code-hmac.id}"
+    DB_CONNECTION_KEEPALIVE_TIME      = "1m"
   }
 
   firebase_config = {