As the bulk/recursive delete will require multiple connections to open at an instance, The default open connections limit will be reached which results in the following error ```FATAL: sorry, too many clients already``` By setting the open connections to a reasonable value - `2`, We ensure that the max open connections will not be exhausted and lie under bounds. The queries are simple inserts/updates/deletes which is operational and sufficient with the the maximum open connection limit is 2. Fixes #10553 Allow user configuration for MaxOpenConnections
445 lines
13 KiB
Go
445 lines
13 KiB
Go
/*
|
|
* MinIO Cloud Storage, (C) 2018 MinIO, Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
// PostgreSQL Notifier implementation. Two formats, "namespace" and
|
|
// "access" are supported.
|
|
//
|
|
// * Namespace format
|
|
//
|
|
// On each create or update object event in MinIO Object storage
|
|
// server, a row is created or updated in the table in Postgres. On
|
|
// each object removal, the corresponding row is deleted from the
|
|
// table.
|
|
//
|
|
// A table with a specific structure (column names, column types, and
|
|
// primary key/uniqueness constraint) is used. The user may set the
|
|
// table name in the configuration. A sample SQL command that creates
|
|
// a table with the required structure is:
|
|
//
|
|
// CREATE TABLE myminio (
|
|
// key VARCHAR PRIMARY KEY,
|
|
// value JSONB
|
|
// );
|
|
//
|
|
// PostgreSQL's "INSERT ... ON CONFLICT ... DO UPDATE ..." feature
|
|
// (UPSERT) is used here, so the minimum version of PostgreSQL
|
|
// required is 9.5.
|
|
//
|
|
// * Access format
|
|
//
|
|
// On each event, a row is appended to the configured table. There is
|
|
// no deletion or modification of existing rows.
|
|
//
|
|
// A different table schema is used for this format. A sample SQL
|
|
// commant that creates a table with the required structure is:
|
|
//
|
|
// CREATE TABLE myminio (
|
|
// event_time TIMESTAMP WITH TIME ZONE NOT NULL,
|
|
// event_data JSONB
|
|
// );
|
|
|
|
package target
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"net/url"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
_ "github.com/lib/pq" // Register postgres driver
|
|
|
|
"github.com/minio/minio/pkg/event"
|
|
xnet "github.com/minio/minio/pkg/net"
|
|
)
|
|
|
|
const (
|
|
psqlTableExists = `SELECT 1 FROM %s;`
|
|
psqlCreateNamespaceTable = `CREATE TABLE %s (key VARCHAR PRIMARY KEY, value JSONB);`
|
|
psqlCreateAccessTable = `CREATE TABLE %s (event_time TIMESTAMP WITH TIME ZONE NOT NULL, event_data JSONB);`
|
|
|
|
psqlUpdateRow = `INSERT INTO %s (key, value) VALUES ($1, $2) ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value;`
|
|
psqlDeleteRow = `DELETE FROM %s WHERE key = $1;`
|
|
psqlInsertRow = `INSERT INTO %s (event_time, event_data) VALUES ($1, $2);`
|
|
)
|
|
|
|
// Postgres constants
|
|
const (
|
|
PostgresFormat = "format"
|
|
PostgresConnectionString = "connection_string"
|
|
PostgresTable = "table"
|
|
PostgresHost = "host"
|
|
PostgresPort = "port"
|
|
PostgresUsername = "username"
|
|
PostgresPassword = "password"
|
|
PostgresDatabase = "database"
|
|
PostgresQueueDir = "queue_dir"
|
|
PostgresQueueLimit = "queue_limit"
|
|
PostgresMaxOpenConnections = "max_open_connections"
|
|
|
|
EnvPostgresEnable = "MINIO_NOTIFY_POSTGRES_ENABLE"
|
|
EnvPostgresFormat = "MINIO_NOTIFY_POSTGRES_FORMAT"
|
|
EnvPostgresConnectionString = "MINIO_NOTIFY_POSTGRES_CONNECTION_STRING"
|
|
EnvPostgresTable = "MINIO_NOTIFY_POSTGRES_TABLE"
|
|
EnvPostgresHost = "MINIO_NOTIFY_POSTGRES_HOST"
|
|
EnvPostgresPort = "MINIO_NOTIFY_POSTGRES_PORT"
|
|
EnvPostgresUsername = "MINIO_NOTIFY_POSTGRES_USERNAME"
|
|
EnvPostgresPassword = "MINIO_NOTIFY_POSTGRES_PASSWORD"
|
|
EnvPostgresDatabase = "MINIO_NOTIFY_POSTGRES_DATABASE"
|
|
EnvPostgresQueueDir = "MINIO_NOTIFY_POSTGRES_QUEUE_DIR"
|
|
EnvPostgresQueueLimit = "MINIO_NOTIFY_POSTGRES_QUEUE_LIMIT"
|
|
EnvPostgresMaxOpenConnections = "MINIO_NOTIFY_POSTGRES_MAX_OPEN_CONNECTIONS"
|
|
)
|
|
|
|
// PostgreSQLArgs - PostgreSQL target arguments.
|
|
type PostgreSQLArgs struct {
|
|
Enable bool `json:"enable"`
|
|
Format string `json:"format"`
|
|
ConnectionString string `json:"connectionString"`
|
|
Table string `json:"table"`
|
|
Host xnet.Host `json:"host"` // default: localhost
|
|
Port string `json:"port"` // default: 5432
|
|
Username string `json:"username"` // default: user running minio
|
|
Password string `json:"password"` // default: no password
|
|
Database string `json:"database"` // default: same as user
|
|
QueueDir string `json:"queueDir"`
|
|
QueueLimit uint64 `json:"queueLimit"`
|
|
MaxOpenConnections int `json:"maxOpenConnections"`
|
|
}
|
|
|
|
// Validate PostgreSQLArgs fields
|
|
func (p PostgreSQLArgs) Validate() error {
|
|
if !p.Enable {
|
|
return nil
|
|
}
|
|
if p.Table == "" {
|
|
return fmt.Errorf("empty table name")
|
|
}
|
|
if p.Format != "" {
|
|
f := strings.ToLower(p.Format)
|
|
if f != event.NamespaceFormat && f != event.AccessFormat {
|
|
return fmt.Errorf("unrecognized format value")
|
|
}
|
|
}
|
|
|
|
if p.ConnectionString != "" {
|
|
// No pq API doesn't help to validate connection string
|
|
// prior connection, so no validation for now.
|
|
} else {
|
|
// Some fields need to be specified when ConnectionString is unspecified
|
|
if p.Port == "" {
|
|
return fmt.Errorf("unspecified port")
|
|
}
|
|
if _, err := strconv.Atoi(p.Port); err != nil {
|
|
return fmt.Errorf("invalid port")
|
|
}
|
|
if p.Database == "" {
|
|
return fmt.Errorf("database unspecified")
|
|
}
|
|
}
|
|
|
|
if p.QueueDir != "" {
|
|
if !filepath.IsAbs(p.QueueDir) {
|
|
return errors.New("queueDir path should be absolute")
|
|
}
|
|
}
|
|
|
|
if p.MaxOpenConnections < 0 {
|
|
return errors.New("maxOpenConnections cannot be less than zero")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// PostgreSQLTarget - PostgreSQL target.
|
|
type PostgreSQLTarget struct {
|
|
id event.TargetID
|
|
args PostgreSQLArgs
|
|
updateStmt *sql.Stmt
|
|
deleteStmt *sql.Stmt
|
|
insertStmt *sql.Stmt
|
|
db *sql.DB
|
|
store Store
|
|
firstPing bool
|
|
connString string
|
|
loggerOnce func(ctx context.Context, err error, id interface{}, errKind ...interface{})
|
|
}
|
|
|
|
// ID - returns target ID.
|
|
func (target *PostgreSQLTarget) ID() event.TargetID {
|
|
return target.id
|
|
}
|
|
|
|
// HasQueueStore - Checks if the queueStore has been configured for the target
|
|
func (target *PostgreSQLTarget) HasQueueStore() bool {
|
|
return target.store != nil
|
|
}
|
|
|
|
// IsActive - Return true if target is up and active
|
|
func (target *PostgreSQLTarget) IsActive() (bool, error) {
|
|
if target.db == nil {
|
|
db, err := sql.Open("postgres", target.connString)
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
target.db = db
|
|
if target.args.MaxOpenConnections > 0 {
|
|
// Set the maximum connections limit
|
|
target.db.SetMaxOpenConns(target.args.MaxOpenConnections)
|
|
}
|
|
}
|
|
if err := target.db.Ping(); err != nil {
|
|
if IsConnErr(err) {
|
|
return false, errNotConnected
|
|
}
|
|
return false, err
|
|
}
|
|
return true, nil
|
|
}
|
|
|
|
// Save - saves the events to the store if questore is configured, which will be replayed when the PostgreSQL connection is active.
|
|
func (target *PostgreSQLTarget) Save(eventData event.Event) error {
|
|
if target.store != nil {
|
|
return target.store.Put(eventData)
|
|
}
|
|
_, err := target.IsActive()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return target.send(eventData)
|
|
}
|
|
|
|
// IsConnErr - To detect a connection error.
|
|
func IsConnErr(err error) bool {
|
|
return IsConnRefusedErr(err) || err.Error() == "sql: database is closed" || err.Error() == "sql: statement is closed" || err.Error() == "invalid connection"
|
|
}
|
|
|
|
// send - sends an event to the PostgreSQL.
|
|
func (target *PostgreSQLTarget) send(eventData event.Event) error {
|
|
if target.args.Format == event.NamespaceFormat {
|
|
objectName, err := url.QueryUnescape(eventData.S3.Object.Key)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
key := eventData.S3.Bucket.Name + "/" + objectName
|
|
|
|
if eventData.EventName == event.ObjectRemovedDelete {
|
|
_, err = target.deleteStmt.Exec(key)
|
|
} else {
|
|
var data []byte
|
|
if data, err = json.Marshal(struct{ Records []event.Event }{[]event.Event{eventData}}); err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = target.updateStmt.Exec(key, data)
|
|
}
|
|
return err
|
|
}
|
|
|
|
if target.args.Format == event.AccessFormat {
|
|
eventTime, err := time.Parse(event.AMZTimeFormat, eventData.EventTime)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
data, err := json.Marshal(struct{ Records []event.Event }{[]event.Event{eventData}})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if _, err = target.insertStmt.Exec(eventTime, data); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Send - reads an event from store and sends it to PostgreSQL.
|
|
func (target *PostgreSQLTarget) Send(eventKey string) error {
|
|
_, err := target.IsActive()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if !target.firstPing {
|
|
if err := target.executeStmts(); err != nil {
|
|
if IsConnErr(err) {
|
|
return errNotConnected
|
|
}
|
|
return err
|
|
}
|
|
}
|
|
|
|
eventData, eErr := target.store.Get(eventKey)
|
|
if eErr != nil {
|
|
// The last event key in a successful batch will be sent in the channel atmost once by the replayEvents()
|
|
// Such events will not exist and wouldve been already been sent successfully.
|
|
if os.IsNotExist(eErr) {
|
|
return nil
|
|
}
|
|
return eErr
|
|
}
|
|
|
|
if err := target.send(eventData); err != nil {
|
|
if IsConnErr(err) {
|
|
return errNotConnected
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Delete the event from store.
|
|
return target.store.Del(eventKey)
|
|
}
|
|
|
|
// Close - closes underneath connections to PostgreSQL database.
|
|
func (target *PostgreSQLTarget) Close() error {
|
|
if target.updateStmt != nil {
|
|
// FIXME: log returned error. ignore time being.
|
|
_ = target.updateStmt.Close()
|
|
}
|
|
|
|
if target.deleteStmt != nil {
|
|
// FIXME: log returned error. ignore time being.
|
|
_ = target.deleteStmt.Close()
|
|
}
|
|
|
|
if target.insertStmt != nil {
|
|
// FIXME: log returned error. ignore time being.
|
|
_ = target.insertStmt.Close()
|
|
}
|
|
|
|
return target.db.Close()
|
|
}
|
|
|
|
// Executes the table creation statements.
|
|
func (target *PostgreSQLTarget) executeStmts() error {
|
|
|
|
_, err := target.db.Exec(fmt.Sprintf(psqlTableExists, target.args.Table))
|
|
if err != nil {
|
|
createStmt := psqlCreateNamespaceTable
|
|
if target.args.Format == event.AccessFormat {
|
|
createStmt = psqlCreateAccessTable
|
|
}
|
|
|
|
if _, dbErr := target.db.Exec(fmt.Sprintf(createStmt, target.args.Table)); dbErr != nil {
|
|
return dbErr
|
|
}
|
|
}
|
|
|
|
switch target.args.Format {
|
|
case event.NamespaceFormat:
|
|
// insert or update statement
|
|
if target.updateStmt, err = target.db.Prepare(fmt.Sprintf(psqlUpdateRow, target.args.Table)); err != nil {
|
|
return err
|
|
}
|
|
// delete statement
|
|
if target.deleteStmt, err = target.db.Prepare(fmt.Sprintf(psqlDeleteRow, target.args.Table)); err != nil {
|
|
return err
|
|
}
|
|
case event.AccessFormat:
|
|
// insert statement
|
|
if target.insertStmt, err = target.db.Prepare(fmt.Sprintf(psqlInsertRow, target.args.Table)); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// NewPostgreSQLTarget - creates new PostgreSQL target.
|
|
func NewPostgreSQLTarget(id string, args PostgreSQLArgs, doneCh <-chan struct{}, loggerOnce func(ctx context.Context, err error, id interface{}, kind ...interface{}), test bool) (*PostgreSQLTarget, error) {
|
|
params := []string{args.ConnectionString}
|
|
if args.ConnectionString == "" {
|
|
params = []string{}
|
|
if !args.Host.IsEmpty() {
|
|
params = append(params, "host="+args.Host.String())
|
|
}
|
|
if args.Port != "" {
|
|
params = append(params, "port="+args.Port)
|
|
}
|
|
if args.Username != "" {
|
|
params = append(params, "username="+args.Username)
|
|
}
|
|
if args.Password != "" {
|
|
params = append(params, "password="+args.Password)
|
|
}
|
|
if args.Database != "" {
|
|
params = append(params, "dbname="+args.Database)
|
|
}
|
|
}
|
|
connStr := strings.Join(params, " ")
|
|
|
|
target := &PostgreSQLTarget{
|
|
id: event.TargetID{ID: id, Name: "postgresql"},
|
|
args: args,
|
|
firstPing: false,
|
|
connString: connStr,
|
|
loggerOnce: loggerOnce,
|
|
}
|
|
|
|
db, err := sql.Open("postgres", connStr)
|
|
if err != nil {
|
|
return target, err
|
|
}
|
|
target.db = db
|
|
|
|
if args.MaxOpenConnections > 0 {
|
|
// Set the maximum connections limit
|
|
target.db.SetMaxOpenConns(args.MaxOpenConnections)
|
|
}
|
|
|
|
var store Store
|
|
|
|
if args.QueueDir != "" {
|
|
queueDir := filepath.Join(args.QueueDir, storePrefix+"-postgresql-"+id)
|
|
store = NewQueueStore(queueDir, args.QueueLimit)
|
|
if oErr := store.Open(); oErr != nil {
|
|
target.loggerOnce(context.Background(), oErr, target.ID())
|
|
return target, oErr
|
|
}
|
|
target.store = store
|
|
}
|
|
|
|
err = target.db.Ping()
|
|
if err != nil {
|
|
if target.store == nil || !(IsConnRefusedErr(err) || IsConnResetErr(err)) {
|
|
target.loggerOnce(context.Background(), err, target.ID())
|
|
return target, err
|
|
}
|
|
} else {
|
|
if err = target.executeStmts(); err != nil {
|
|
target.loggerOnce(context.Background(), err, target.ID())
|
|
return target, err
|
|
}
|
|
target.firstPing = true
|
|
}
|
|
|
|
if target.store != nil && !test {
|
|
// Replays the events from the store.
|
|
eventKeyCh := replayEvents(target.store, doneCh, target.loggerOnce, target.ID())
|
|
// Start replaying events from the store.
|
|
go sendEvents(target, eventKeyCh, doneCh, target.loggerOnce)
|
|
}
|
|
|
|
return target, nil
|
|
}
|