GOMODULES
/
ksql
mirror of https://github.com/VinGarcia/ksql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a few doc strings and rename a function

pull/40/head
Vinícius Garcia 2023-07-12 20:17:02 -03:00
parent 70fcedb8eb
commit a5444ff198
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
logger.go
View File

@ -9,9 +9,11 @@ import (
// This variable is only used during tests: // This variable is only used during tests:
var logPrinter = fmt.Println var logPrinter = fmt.Println
var _ LoggerFn = ErrorsLogger var _ LoggerFn = ErrorLogger
func ErrorsLogger(ctx context.Context, values LogValues) { // ErrorLogger is a builtin logger that can be passed to
// ksql.InjectLogger() to only log when an error occurs.
func ErrorLogger(ctx context.Context, values LogValues) {
if values.Err == nil { if values.Err == nil {
return return
} }
@ -21,6 +23,8 @@ func ErrorsLogger(ctx context.Context, values LogValues) {
var _ LoggerFn = Logger var _ LoggerFn = Logger
// Logger is a builtin logger that can be passed to
// ksql.InjectLogger() to log every query and every error.
func Logger(ctx context.Context, values LogValues) { func Logger(ctx context.Context, values LogValues) {
m := map[string]interface{}{ m := map[string]interface{}{
"query": values.Query, "query": values.Query,
@ -37,15 +41,23 @@ func Logger(ctx context.Context, values LogValues) {
type loggerKey struct{} type loggerKey struct{}
// LogValues is the argument type of ksql.LoggerFn which contains
// the data available for logging whenever a query is executed.
type LogValues struct { type LogValues struct {
Query string Query string
Params []interface{} Params []interface{}
Err error Err error
} }
// LoggerFn is a the type of function received as
// argument of the ksql.InjectLogger function.
type LoggerFn func(ctx context.Context, values LogValues) type LoggerFn func(ctx context.Context, values LogValues)
type loggerFn func(ctx context.Context, query string, params []interface{}, err error) type loggerFn func(ctx context.Context, query string, params []interface{}, err error)
// InjectLogger is a debugging tool that allows the user to force
// KSQL to log the query, query params and error response whenever
// a query is executed.
func InjectLogger( func InjectLogger(
ctx context.Context, ctx context.Context,
logFn LoggerFn, logFn LoggerFn,

4
logger_test.go
View File

@ -68,7 +68,7 @@ func TestBuiltinLoggers(t *testing.T) {
return 0, nil return 0, nil
} }
ErrorsLogger(ctx, LogValues{ ErrorLogger(ctx, LogValues{
Query: "FakeQuery", Query: "FakeQuery",
Params: []interface{}{"FakeParam"}, Params: []interface{}{"FakeParam"},
}) })
@ -83,7 +83,7 @@ func TestBuiltinLoggers(t *testing.T) {
return 0, nil return 0, nil
} }
ErrorsLogger(ctx, LogValues{ ErrorLogger(ctx, LogValues{
Query: "FakeQuery", Query: "FakeQuery",
Params: []interface{}{"FakeParam"}, Params: []interface{}{"FakeParam"},
Err: errors.New("fakeErrMsg"), Err: errors.New("fakeErrMsg"),