rename FilterTag to QueryLogFilterTag for consistency and clarity

Signed-off-by: Michael Demmer <mdemmer@slack-corp.com>
kosyd · May 31, 2019 · 1bfa92d · 1bfa92d
1 parent a0f2d1f
commit 1bfa92d
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 14 deletions.
diff --git a/go/streamlog/streamlog.go b/go/streamlog/streamlog.go
@@ -41,8 +41,8 @@ var (
 	// QueryLogFormat controls the format of the query log (either text or json)
 	QueryLogFormat = flag.String("querylog-format", "text", "format for query logs (\"text\" or \"json\")")
 
-	// FilterTag contains an optional string that must be present in the query for it to be logged
-	FilterTag = flag.String("querylog-filter-tag", "", "string that must be present in the query for it to be logged")
+	// QueryLogFilterTag contains an optional string that must be present in the query for it to be logged
+	QueryLogFilterTag = flag.String("querylog-filter-tag", "", "string that must be present in the query for it to be logged")
 
 	sendCount      = stats.NewCountersWithSingleLabel("StreamlogSend", "stream log send count", "logger_names")
 	deliveredCount = stats.NewCountersWithMultiLabels(
@@ -209,8 +209,8 @@ func GetFormatter(logger *StreamLogger) LogFormatter {
 // ShouldEmitLog returns whether the log with the given SQL query
 // should be emitted or filtered
 func ShouldEmitLog(sql string) bool {
-	if *FilterTag == "" {
+	if *QueryLogFilterTag == "" {
 		return true
 	}
-	return strings.Contains(sql, *FilterTag)
+	return strings.Contains(sql, *QueryLogFilterTag)
 }
diff --git a/go/vt/vtgate/logstats_test.go b/go/vt/vtgate/logstats_test.go
@@ -127,7 +127,7 @@ func TestLogStatsFormat(t *testing.T) {
 }
 
 func TestLogStatsFilter(t *testing.T) {
-	defer func() { *streamlog.FilterTag = "" }()
+	defer func() { *streamlog.QueryLogFilterTag = "" }()
 
 	logStats := NewLogStats(context.Background(), "test", "sql1 /* LOG_THIS_QUERY */", map[string]*querypb.BindVariable{"intVal": sqltypes.Int64BindVariable(1)})
 	logStats.StartTime = time.Date(2017, time.January, 1, 1, 2, 3, 0, time.UTC)
@@ -140,14 +140,14 @@ func TestLogStatsFilter(t *testing.T) {
 		t.Errorf("logstats format: got:\n%q\nwant:\n%q\n", got, want)
 	}
 
-	*streamlog.FilterTag = "LOG_THIS_QUERY"
+	*streamlog.QueryLogFilterTag = "LOG_THIS_QUERY"
 	got = testFormat(logStats, url.Values(params))
 	want = "test\t\t\t''\t''\t2017-01-01 01:02:03.000000\t2017-01-01 01:02:04.000001\t1.000001\t0.000000\t0.000000\t0.000000\t\t\"sql1 /* LOG_THIS_QUERY */\"\tmap[intVal:type:INT64 value:\"1\" ]\t0\t0\t\"\"\t\n"
 	if got != want {
 		t.Errorf("logstats format: got:\n%q\nwant:\n%q\n", got, want)
 	}
 
-	*streamlog.FilterTag = "NOT_THIS_QUERY"
+	*streamlog.QueryLogFilterTag = "NOT_THIS_QUERY"
 	got = testFormat(logStats, url.Values(params))
 	want = ""
 	if got != want {

diff --git a/go/vt/vtgate/querylogz_test.go b/go/vt/vtgate/querylogz_test.go
@@ -145,8 +145,8 @@ func TestQuerylogzHandlerFormatting(t *testing.T) {
 	checkQuerylogzHasStats(t, slowQueryPattern, logStats, body)
 
 	// ensure querylogz is not affected by the filter tag
-	*streamlog.FilterTag = "XXX_SKIP_ME"
-	defer func() { *streamlog.FilterTag = "" }()
+	*streamlog.QueryLogFilterTag = "XXX_SKIP_ME"
+	defer func() { *streamlog.QueryLogFilterTag = "" }()
 	ch = make(chan interface{}, 1)
 	ch <- logStats
 	querylogzHandler(ch, response, req)

diff --git a/go/vt/vttablet/tabletserver/querylogz_test.go b/go/vt/vttablet/tabletserver/querylogz_test.go
@@ -151,8 +151,8 @@ func TestQuerylogzHandler(t *testing.T) {
 	checkQuerylogzHasStats(t, slowQueryPattern, logStats, body)
 
 	// ensure querylogz is not affected by the filter tag
-	*streamlog.FilterTag = "XXX_SKIP_ME"
-	defer func() { *streamlog.FilterTag = "" }()
+	*streamlog.QueryLogFilterTag = "XXX_SKIP_ME"
+	defer func() { *streamlog.QueryLogFilterTag = "" }()
 	ch = make(chan interface{}, 1)
 	ch <- logStats
 	querylogzHandler(ch, response, req)

diff --git a/go/vt/vttablet/tabletserver/tabletenv/logstats_test.go b/go/vt/vttablet/tabletserver/tabletenv/logstats_test.go
@@ -150,7 +150,7 @@ func TestLogStatsFormat(t *testing.T) {
 }
 
 func TestLogStatsFilter(t *testing.T) {
-	defer func() { *streamlog.FilterTag = "" }()
+	defer func() { *streamlog.QueryLogFilterTag = "" }()
 
 	logStats := NewLogStats(context.Background(), "test")
 	logStats.StartTime = time.Date(2017, time.January, 1, 1, 2, 3, 0, time.UTC)
@@ -168,14 +168,14 @@ func TestLogStatsFilter(t *testing.T) {
 		t.Errorf("logstats format: got:\n%q\nwant:\n%q\n", got, want)
 	}
 
-	*streamlog.FilterTag = "LOG_THIS_QUERY"
+	*streamlog.QueryLogFilterTag = "LOG_THIS_QUERY"
 	got = testFormat(logStats, url.Values(params))
 	want = "test\t\t\t''\t''\t2017-01-01 01:02:03.000000\t2017-01-01 01:02:04.000001\t1.000001\t\t\"sql /* LOG_THIS_QUERY */\"\tmap[intVal:type:INT64 value:\"1\" ]\t1\t\"sql with pii\"\tmysql\t0.000000\t0.000000\t0\t1\t\"\"\t\n"
 	if got != want {
 		t.Errorf("logstats format: got:\n%q\nwant:\n%q\n", got, want)
 	}
 
-	*streamlog.FilterTag = "NOT_THIS_QUERY"
+	*streamlog.QueryLogFilterTag = "NOT_THIS_QUERY"
 	got = testFormat(logStats, url.Values(params))
 	want = ""
 	if got != want {