log, server: Create new log.EventLog() API

This PR introduces a new log.EventLog() API that gives
first class support for writing to the system.eventlog
table. This API lives in the log package and doesn't
have a dependency on the sql package, making it easy
to use across the repo.

This is implemented using a new set of interfaces in
the log package that allows the system and tenant
servers to register new event log writers. The logic
for writing to the event log table is the same as
that which is sql/event_log.go. For now the code is
duplicated, but it will be removed in a future commit
when this file is updated to use the new API.

Epic: CRDB-42978
Release note: None

Author: kyle-a-wong

pkg/BUILD.bazel

@@ -753,6 +753,7 @@ ALL_TESTS = [
     "//pkg/util/json:json_test",
     "//pkg/util/jsonpath/parser:parser_test",
     "//pkg/util/limit:limit_test",
+    "//pkg/util/log/eventlog:eventlog_test",
     "//pkg/util/log/eventpb:eventpb_test",
     "//pkg/util/log/logconfig:logconfig_test",
     "//pkg/util/log/logcrash:logcrash_test",
@@ -2624,6 +2625,8 @@ GO_TARGETS = [
     "//pkg/util/limit:limit",
     "//pkg/util/limit:limit_test",
     "//pkg/util/log/channel:channel",
+    "//pkg/util/log/eventlog:eventlog",
+    "//pkg/util/log/eventlog:eventlog_test",
     "//pkg/util/log/eventpb/eventpbgen:eventpbgen",
     "//pkg/util/log/eventpb/eventpbgen:eventpbgen_lib",
     "//pkg/util/log/eventpb:eventpb",

pkg/base/serverident/server_ident.go

@@ -50,6 +50,10 @@ type ServerIdentificationPayload interface {
 	ServerIdentityString(key ServerIdentificationKey) string
 }
 
+type ServerIdentifier interface {
+	GetServerIdentificationPayload() ServerIdentificationPayload
+}
+
 // ServerIdentificationKey represents a possible parameter to the
 // ServerIdentityString() method in ServerIdentificationPayload.
 type ServerIdentificationKey int

pkg/ccl/telemetryccl/BUILD.bazel

@@ -30,6 +30,7 @@ go_test(
         "//pkg/testutils/testcluster",
         "//pkg/util/leaktest",
         "//pkg/util/log",
+        "//pkg/util/log/eventlog",
         "//pkg/util/log/eventpb",
         "//pkg/util/log/logpb",
         "//pkg/util/log/logtestutils",

pkg/ccl/telemetryccl/telemetry_logging_test.go

@@ -28,6 +28,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/testutils/sqlutils"
 	"github.com/cockroachdb/cockroach/pkg/util/leaktest"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
+	"github.com/cockroachdb/cockroach/pkg/util/log/eventlog"
 	"github.com/cockroachdb/cockroach/pkg/util/log/eventpb"
 	"github.com/cockroachdb/cockroach/pkg/util/log/logpb"
 	"github.com/cockroachdb/cockroach/pkg/util/log/logtestutils"
@@ -218,7 +219,7 @@ func TestBulkJobTelemetryLogging(t *testing.T) {
 	testCluster := serverutils.StartCluster(t, 1, base.TestClusterArgs{
 		ServerArgs: base.TestServerArgs{
 			Knobs: base.TestingKnobs{
-				EventLog: &sql.EventLogTestingKnobs{
+				EventLog: &eventlog.EventLogTestingKnobs{
 					// The sampling checks below need to have a deterministic
 					// number of statements run by internal executor.
 					SyncWrites: true,

pkg/server/BUILD.bazel

@@ -315,6 +315,7 @@ go_library(
         "//pkg/util/json",
         "//pkg/util/limit",
         "//pkg/util/log",
+        "//pkg/util/log/eventlog",
         "//pkg/util/log/eventpb",
         "//pkg/util/log/logcrash",
         "//pkg/util/log/logmetrics",

pkg/server/server.go

@@ -107,6 +107,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/util/hlc"
 	"github.com/cockroachdb/cockroach/pkg/util/hlc/logger"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
+	"github.com/cockroachdb/cockroach/pkg/util/log/eventlog"
 	"github.com/cockroachdb/cockroach/pkg/util/log/logmetrics"
 	"github.com/cockroachdb/cockroach/pkg/util/metric"
 	"github.com/cockroachdb/cockroach/pkg/util/mon"
@@ -1886,6 +1887,11 @@ func (s *topLevelServer) PreStart(ctx context.Context) error {
 
 	advHTTPAddrU := util.NewUnresolvedAddr("tcp", s.cfg.HTTPAdvertiseAddr)
 
+	// Registers an event log writer for the system tenant. This will enable the
+	// ability to persist structured events to the system tenant's
+	//system.eventlog table.
+	eventlog.Register(ctx, s.cfg.TestingKnobs.EventLog, s.node.execCfg.InternalDB, s.stopper, s.cfg.AmbientCtx, s.ClusterSettings())
+
 	if err := s.node.start(
 		ctx, workersCtx,
 		advAddrU,

pkg/server/server_sql.go

@@ -121,6 +121,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/util/envutil"
 	"github.com/cockroachdb/cockroach/pkg/util/hlc"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
+	"github.com/cockroachdb/cockroach/pkg/util/log/eventlog"
 	"github.com/cockroachdb/cockroach/pkg/util/metric"
 	"github.com/cockroachdb/cockroach/pkg/util/mon"
 	"github.com/cockroachdb/cockroach/pkg/util/netutil"
@@ -1116,7 +1117,7 @@ func newSQLServer(ctx context.Context, cfg sqlServerArgs) (*SQLServer, error) {
 		execCfg.SQLStatsTestingKnobs = sqlStatsKnobs.(*sqlstats.TestingKnobs)
 	}
 	if eventlogKnobs := cfg.TestingKnobs.EventLog; eventlogKnobs != nil {
-		execCfg.EventLogTestingKnobs = eventlogKnobs.(*sql.EventLogTestingKnobs)
+		execCfg.EventLogTestingKnobs = eventlogKnobs.(*eventlog.EventLogTestingKnobs)
 	}
 	if telemetryLoggingKnobs := cfg.TestingKnobs.TelemetryLoggingKnobs; telemetryLoggingKnobs != nil {
 		execCfg.TelemetryLoggingTestingKnobs = telemetryLoggingKnobs.(*sql.TelemetryLoggingTestingKnobs)

pkg/server/tenant.go

@@ -68,6 +68,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/util/admission"
 	"github.com/cockroachdb/cockroach/pkg/util/hlc"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
+	"github.com/cockroachdb/cockroach/pkg/util/log/eventlog"
 	"github.com/cockroachdb/cockroach/pkg/util/log/logmetrics"
 	"github.com/cockroachdb/cockroach/pkg/util/metric"
 	"github.com/cockroachdb/cockroach/pkg/util/netutil"
@@ -104,7 +105,7 @@ type SQLServerWrapper struct {
 	db           *kv.DB
 
 	// Metric registries.
-	// See the explanatory comments in server.go and status/recorder.g o
+	// See the explanatory comments in server.go and status/recorder.go
 	// for details.
 	registry    *metric.Registry
 	sysRegistry *metric.Registry
@@ -730,6 +731,10 @@ func (s *SQLServerWrapper) PreStart(ctx context.Context) error {
 		})
 	})
 
+	// Registers an event log writer for the tenant. This will enable the ability
+	// to persist structured events to the tenants system.eventlog table.
+	eventlog.Register(ctx, s.cfg.TestingKnobs.EventLog, s.sqlServer.execCfg.InternalDB, s.stopper, s.cfg.AmbientCtx, s.ClusterSettings())
+
 	// Init a log metrics registry.
 	logRegistry := logmetrics.NewRegistry()
 	if logRegistry == nil {

pkg/sql/BUILD.bazel

@@ -581,6 +581,7 @@ go_library(
         "//pkg/util/json",
         "//pkg/util/jsonpath/parser",
         "//pkg/util/log",
+        "//pkg/util/log/eventlog",
         "//pkg/util/log/eventpb",
         "//pkg/util/log/logcrash",
         "//pkg/util/log/logpb",
@@ -948,6 +949,7 @@ go_test(
         "//pkg/util/leaktest",
         "//pkg/util/log",
         "//pkg/util/log/channel",
+        "//pkg/util/log/eventlog",
         "//pkg/util/log/eventpb",
         "//pkg/util/log/logconfig",
         "//pkg/util/log/logpb",

pkg/sql/event_log.go

@@ -16,13 +16,13 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/jobs"
 	"github.com/cockroachdb/cockroach/pkg/jobs/jobspb"
 	"github.com/cockroachdb/cockroach/pkg/security/username"
-	"github.com/cockroachdb/cockroach/pkg/settings"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/isql"
 	"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scbuild"
 	"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scrun"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
+	"github.com/cockroachdb/cockroach/pkg/util/log/eventlog"
 	"github.com/cockroachdb/cockroach/pkg/util/log/eventpb"
 	"github.com/cockroachdb/cockroach/pkg/util/log/logpb"
 	"github.com/cockroachdb/cockroach/pkg/util/log/severity"
@@ -401,23 +401,6 @@ func LogEventForJobs(
 	)
 }
 
-var eventLogSystemTableEnabled = settings.RegisterBoolSetting(
-	settings.ApplicationLevel,
-	"server.eventlog.enabled",
-	"if set, logged notable events are also stored in the table system.eventlog",
-	true,
-	settings.WithPublic)
-
-// EventLogTestingKnobs provides hooks and knobs for event logging.
-type EventLogTestingKnobs struct {
-	// SyncWrites causes events to be written on the same txn as
-	// the SQL statement that causes them.
-	SyncWrites bool
-}
-
-// ModuleTestingKnobs implements base.ModuleTestingKnobs interface.
-func (*EventLogTestingKnobs) ModuleTestingKnobs() {}
-
 // LogEventDestination indicates for InsertEventRecords where the
 // event should be directed to.
 type LogEventDestination int
@@ -529,7 +512,7 @@ func insertEventRecords(
 	}
 
 	// If we only want to log externally and not write to the events table, early exit.
-	loggingToSystemTable := opts.dst.hasFlag(LogToSystemTable) && eventLogSystemTableEnabled.Get(&execCfg.Settings.SV)
+	loggingToSystemTable := opts.dst.hasFlag(LogToSystemTable) && eventlog.SystemTableEnabled.Get(&execCfg.Settings.SV)
 	if !loggingToSystemTable {
 		// Simply emit the events to their respective channels and call it a day.
 		if opts.dst.hasFlag(LogExternally) {