plugin: add audit plugin extension point (#9136)

cmd/pluginpkg/pluginpkg.go

@@ -62,9 +62,18 @@ func PluginManifest() *plugin.Manifest {
 				},
 				{{end}}
 			},
-			Validate:   {{.validate}},
-			OnInit:     {{.onInit}},
-			OnShutdown: {{.onShutdown}},
+			{{if .validate }}
+				Validate:   {{.validate}},
+			{{end}}
+			{{if .onInit }}
+				OnInit:     {{.onInit}},
+			{{end}}
+			{{if .onShutdown }}
+				OnShutdown: {{.onShutdown}},
+			{{end}}
+			{{if .onFlush }}
+				OnFlush:    {{.onFlush}},
+			{{end}}
 		},
 		{{range .export}}
 		{{.extPoint}}: {{.impl}},

docs/design/2018-12-10-plugin-framework.md

@@ -140,7 +140,7 @@ validate = "Validate"
 onInit = "OnInit"
 onShutdown = "OnShutdown"
 export = [
-    {extPoint="NotifyEvent", impl="NotifyEvent"}
+    {extPoint="OnGeneralEvent", impl="OnGeneralEvent"}
 ]
 ```
 

executor/adapter.go

@@ -36,6 +36,7 @@ import (
 	"github.com/pingcap/tidb/metrics"
 	"github.com/pingcap/tidb/planner"
 	plannercore "github.com/pingcap/tidb/planner/core"
+	"github.com/pingcap/tidb/plugin"
 	"github.com/pingcap/tidb/sessionctx"
 	"github.com/pingcap/tidb/sessionctx/variable"
 	"github.com/pingcap/tidb/util/chunk"
@@ -129,6 +130,7 @@ func (a *recordSet) NewRecordBatch() *chunk.RecordBatch {
 func (a *recordSet) Close() error {
 	err := a.executor.Close()
 	a.stmt.LogSlowQuery(a.txnStartTS, a.lastErr == nil)
+	a.stmt.logAudit()
 	return errors.Trace(err)
 }
 
@@ -295,6 +297,7 @@ func (a *ExecStmt) handleNoDelayExecutor(ctx context.Context, sctx sessionctx.Co
 			}
 		}
 		a.LogSlowQuery(txnTS, err == nil)
+		a.logAudit()
 	}()
 
 	err = e.Next(ctx, chunk.NewRecordBatch(e.newFirstChunk()))
@@ -362,8 +365,27 @@ func (a *ExecStmt) buildExecutor(ctx sessionctx.Context) (Executor, error) {
 // QueryReplacer replaces new line and tab for grep result including query string.
 var QueryReplacer = strings.NewReplacer("\r", " ", "\n", " ", "\t", " ")
 
+func (a *ExecStmt) logAudit() {
+	sessVars := a.Ctx.GetSessionVars()
+	if sessVars.InRestrictedSQL {
+		return
+	}
+	err := plugin.ForeachPlugin(plugin.Audit, func(p *plugin.Plugin) error {
+		audit := plugin.DeclareAuditManifest(p.Manifest)
+		if audit.OnGeneralEvent != nil {
+			cmd := mysql.Command2Str[byte(atomic.LoadUint32(&a.Ctx.GetSessionVars().CommandValue))]
+			audit.OnGeneralEvent(context.Background(), sessVars, plugin.Log, cmd)
+		}
+		return nil
+	})
+	if err != nil {
+		log.Error("log audit log failure", zap.Error(err))
+	}
+}
+
 // LogSlowQuery is used to print the slow query in the log files.
 func (a *ExecStmt) LogSlowQuery(txnTS uint64, succ bool) {
+	sessVars := a.Ctx.GetSessionVars()
 	level := log.GetLevel()
 	if level > zapcore.WarnLevel {
 		return
@@ -378,7 +400,6 @@ func (a *ExecStmt) LogSlowQuery(txnTS uint64, succ bool) {
 	if maxQueryLen := atomic.LoadUint64(&cfg.Log.QueryLogMaxLen); uint64(len(sql)) > maxQueryLen {
 		sql = fmt.Sprintf("%.*q(len:%d)", maxQueryLen, sql, len(a.Text))
 	}
-	sessVars := a.Ctx.GetSessionVars()
 	sql = QueryReplacer.Replace(sql) + sessVars.GetExecuteArgumentsInfo()
 
 	var tableIDs, indexIDs string

executor/set.go

@@ -24,6 +24,7 @@ import (
 	"github.com/pingcap/parser/terror"
 	"github.com/pingcap/tidb/domain"
 	"github.com/pingcap/tidb/expression"
+	"github.com/pingcap/tidb/plugin"
 	"github.com/pingcap/tidb/sessionctx/variable"
 	"github.com/pingcap/tidb/types"
 	"github.com/pingcap/tidb/util/chunk"
@@ -138,6 +139,16 @@ func (e *SetExecutor) setSysVariable(name string, v *expression.VarAssignment) e
 		if err != nil {
 			return errors.Trace(err)
 		}
+		err = plugin.ForeachPlugin(plugin.Audit, func(p *plugin.Plugin) error {
+			auditPlugin := plugin.DeclareAuditManifest(p.Manifest)
+			if auditPlugin.OnGlobalVariableEvent != nil {
+				auditPlugin.OnGlobalVariableEvent(context.Background(), e.ctx.GetSessionVars(), name, svalue)
+			}
+			return nil
+		})
+		if err != nil {
+			return err
+		}
 	} else {
 		// Set session scope system variable.
 		if sysVar.Scope&variable.ScopeSession == 0 {

planner/core/planbuilder.go

@@ -30,6 +30,7 @@ import (
 	"github.com/pingcap/tidb/infoschema"
 	"github.com/pingcap/tidb/planner/property"
 	"github.com/pingcap/tidb/sessionctx"
+	"github.com/pingcap/tidb/sessionctx/stmtctx"
 	"github.com/pingcap/tidb/table"
 	"github.com/pingcap/tidb/types"
 	"github.com/pingcap/tidb/types/parser_driver"
@@ -159,6 +160,26 @@ func (b *PlanBuilder) GetVisitInfo() []visitInfo {
 	return b.visitInfo
 }
 
+// GetDBTableInfo gets the accessed dbs and tables info.
+func (b *PlanBuilder) GetDBTableInfo() []stmtctx.TableEntry {
+	var tables []stmtctx.TableEntry
+	existsFunc := func(tbls []stmtctx.TableEntry, tbl *stmtctx.TableEntry) bool {
+		for _, t := range tbls {
+			if t == *tbl {
+				return true
+			}
+		}
+		return false
+	}
+	for _, v := range b.visitInfo {
+		tbl := &stmtctx.TableEntry{DB: v.db, Table: v.table}
+		if !existsFunc(tables, tbl) {
+			tables = append(tables, *tbl)
+		}
+	}
+	return tables
+}
+
 // GetOptFlag gets the optFlag of the PlanBuilder.
 func (b *PlanBuilder) GetOptFlag() uint64 {
 	return b.optFlag

planner/optimize.go

@@ -40,6 +40,8 @@ func Optimize(ctx sessionctx.Context, node ast.Node, is infoschema.InfoSchema) (
 		return nil, err
 	}
 
+	ctx.GetSessionVars().StmtCtx.Tables = builder.GetDBTableInfo()
+
 	// Check privilege. Maybe it's better to move this to the Preprocess, but
 	// we need the table information to check privilege, which is collected
 	// into the visitInfo in the logical plan builder.

plugin/README.md

@@ -0,0 +1,3 @@
+# The Plugin Framework
+
+https://github.com/pingcap/tidb/blob/master/docs/design/2018-12-10-plugin-framework.md

plugin/audit.go

@@ -0,0 +1,87 @@
+// Copyright 2019 PingCAP, 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,
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package plugin
+
+import (
+	"context"
+
+	"github.com/pingcap/parser/auth"
+	"github.com/pingcap/tidb/sessionctx/variable"
+)
+
+// GeneralEvent presents TiDB generate event.
+type GeneralEvent byte
+
+const (
+	// Log presents log event.
+	Log GeneralEvent = iota
+	// Error presents error event.
+	Error
+	// Result presents result event.
+	Result
+	// Status presents status event.
+	Status
+)
+
+// ConnectionEvent presents TiDB connection event.
+type ConnectionEvent byte
+
+const (
+	// Connected presents new connection establish event(finish auth).
+	Connected ConnectionEvent = iota
+	// Disconnect presents disconnect event.
+	Disconnect
+	// ChangeUser presents change user.
+	ChangeUser
+	// PreAuth presents event before start auth.
+	PreAuth
+)
+
+func (c ConnectionEvent) String() string {
+	switch c {
+	case Connected:
+		return "Connected"
+	case Disconnect:
+		return "Disconnect"
+	case ChangeUser:
+		return "ChangeUser"
+	case PreAuth:
+		return "PreAuth"
+	}
+	return ""
+}
+
+// ParseEvent presents events happen around parser.
+type ParseEvent byte
+
+const (
+	// PreParse presents event before parse.
+	PreParse ParseEvent = 1 + iota
+	// PostParse presents event after parse.
+	PostParse
+)
+
+// AuditManifest presents a sub-manifest that every audit plugin must provide.
+type AuditManifest struct {
+	Manifest
+	// OnConnectionEvent will be called when TiDB receive or disconnect from client.
+	// return error will ignore and close current connection.
+	OnConnectionEvent func(ctx context.Context, identity *auth.UserIdentity, event ConnectionEvent, info *variable.ConnectionInfo) error
+	// OnGeneralEvent will be called during TiDB execution.
+	OnGeneralEvent func(ctx context.Context, sctx *variable.SessionVars, event GeneralEvent, cmd string)
+	// OnGlobalVariableEvent will be called when Change GlobalVariable.
+	OnGlobalVariableEvent func(ctx context.Context, sctx *variable.SessionVars, varName, varValue string)
+	// OnParseEvent will be called around parse logic.
+	OnParseEvent func(ctx context.Context, sctx *variable.SessionVars, event ParseEvent) error
+}

plugin/conn_ip_example/conn_ip_example.go

@@ -40,8 +40,8 @@ func OnShutdown(ctx context.Context, manifest *plugin.Manifest) error {
 	return nil
 }
 
-// NotifyEvent implements TiDB Audit plugin's NotifyEvent SPI.
-func NotifyEvent(ctx context.Context) error {
+// OnGeneralEvent implements TiDB Audit plugin's OnGeneralEvent SPI.
+func OnGeneralEvent(ctx context.Context, sctx *variable.SessionVars, event plugin.GeneralEvent, cmd byte, stmt string) error {
 	fmt.Println("conn_ip_example notifiy called")
 	fmt.Println("variable test: ", variable.GetSysVar("conn_ip_example_test_variable").Value)
 	fmt.Printf("new connection by %s\n", ctx.Value("ip"))

plugin/conn_ip_example/conn_ip_example_test.go

@@ -30,17 +30,24 @@ func LoadRunShutdownPluginExample() {
 		PluginVarNames: &pluginVarNames,
 	}
 
-	err := plugin.Init(ctx, cfg)
+	err := plugin.Load(ctx, cfg)
 	if err != nil {
 		panic(err)
 	}
 
-	ps := plugin.GetByKind(plugin.Audit)
-	for _, auditPlugin := range ps {
-		if auditPlugin.State != plugin.Ready {
-			continue
-		}
-		plugin.DeclareAuditManifest(auditPlugin.Manifest).NotifyEvent(context.Background(), nil)
+	// load and start TiDB domain.
+
+	err = plugin.Init(ctx, cfg)
+	if err != nil {
+		panic(err)
+	}
+
+	err = plugin.ForeachPlugin(plugin.Audit, func(auditPlugin *plugin.Plugin) error {
+		plugin.DeclareAuditManifest(auditPlugin.Manifest).OnGeneralEvent(context.Background(), nil, plugin.Log, "QUERY")
+		return nil
+	})
+	if err != nil {
+		panic(err)
 	}
 
 	plugin.Shutdown(context.Background())

plugin/conn_ip_example/manifest.toml

@@ -11,5 +11,5 @@ validate = "Validate"
 onInit = "OnInit"
 onShutdown = "OnShutdown"
 export = [
-    {extPoint="NotifyEvent", impl="NotifyEvent"}
+    {extPoint="OnGeneralEvent", impl="OnGeneralEvent"}
 ]