Skip to content

feat: allow excluding additional schemas from perf_schema.eventsstatements #1011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SuperQ merged 4 commits into from
Mar 18, 2026
Merged

feat: allow excluding additional schemas from perf_schema.eventsstatements #1011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0314fdd
feat: allow excluding additional schemas from perf_schema.eventsstate…
cristiangreco Mar 2, 2026
8577876
use string array
cristiangreco Mar 9, 2026
6ae6080
Update collector/perf_schema_events_statements.go
cristiangreco Mar 11, 2026
c4b641d
review feedback
cristiangreco Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions collector/perf_schema_events_statements.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import (
"context"
"fmt"
"log/slog"
"slices"
"strings"

"github.com/alecthomas/kingpin/v2"
"github.com/blang/semver/v4"
Expand All @@ -45,7 +47,7 @@ const perfEventsStatementsQuery = `
FROM (
SELECT *
FROM performance_schema.events_statements_summary_by_digest
WHERE SCHEMA_NAME NOT IN ('mysql', 'performance_schema', 'information_schema')
WHERE SCHEMA_NAME NOT IN (%s)
AND LAST_SEEN > DATE_SUB(NOW(), INTERVAL %d SECOND)
ORDER BY LAST_SEEN DESC
)Q
Expand Down Expand Up @@ -94,7 +96,7 @@ const perfEventsStatementsQueryMySQL = `
FROM (
SELECT *
FROM performance_schema.events_statements_summary_by_digest
WHERE SCHEMA_NAME NOT IN ('mysql', 'performance_schema', 'information_schema')
WHERE SCHEMA_NAME NOT IN (%s)
AND LAST_SEEN > DATE_SUB(NOW(), INTERVAL %d SECOND)
ORDER BY LAST_SEEN DESC
)Q
Expand Down Expand Up @@ -137,8 +139,14 @@ var (
"collect.perf_schema.eventsstatements.digest_text_limit",
"Maximum length of the normalized statement text",
).Default("120").Int()
perfEventsStatementsExcludeSchemas = kingpin.Flag(
"collect.perf_schema.eventsstatements.exclude_schemas",
"Additional schema name to exclude (always excludes mysql, performance_schema, information_schema). Repeatable",
).Default("").Strings()
)

var defaultExcludedSchemas = []string{"'mysql'", "'performance_schema'", "'information_schema'"}

// Metric descriptors.
var (
performanceSchemaEventsStatementsDesc = prometheus.NewDesc(
Expand Down Expand Up @@ -245,9 +253,12 @@ func (ScrapePerfEventsStatements) Scrape(ctx context.Context, instance *instance
perfQuery = perfEventsStatementsQueryMySQL
}

excludeSchemasList := buildExcludedSchemasList(*perfEventsStatementsExcludeSchemas)

perfQuery = fmt.Sprintf(
perfQuery,
*perfEventsStatementsDigestTextLimit,
excludeSchemasList,
*perfEventsStatementsTimeLimit,
*perfEventsStatementsLimit,
)
Expand Down Expand Up @@ -349,5 +360,17 @@ func (ScrapePerfEventsStatements) Scrape(ctx context.Context, instance *instance
return nil
}

func buildExcludedSchemasList(extraSchemas []string) string {
excludedSchemas := slices.Clone(defaultExcludedSchemas)
for _, s := range extraSchemas {
escaped := "'" + strings.ReplaceAll(s, "'", "''") + "'"
if !slices.Contains(excludedSchemas, escaped) {
excludedSchemas = append(excludedSchemas, escaped)
}
}

return strings.Join(excludedSchemas, ", ")
}

// check interface
var _ Scraper = ScrapePerfEventsStatements{}
4 changes: 2 additions & 2 deletions collector/perf_schema_events_statements_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func TestScrapePerfEventsStatements(t *testing.T) {
1, 2, 3,
100, 1)

query := fmt.Sprintf(perfEventsStatementsQuery, 120, 86400, 250)
query := fmt.Sprintf(perfEventsStatementsQuery, *perfEventsStatementsDigestTextLimit, buildExcludedSchemasList(*perfEventsStatementsExcludeSchemas), *perfEventsStatementsTimeLimit, *perfEventsStatementsLimit)
mock.ExpectQuery(sanitizeQuery(query)).WillReturnRows(rows)

ch := make(chan prometheus.Metric)
Expand Down Expand Up @@ -125,7 +125,7 @@ func TestScrapePerfEventsStatementsMySQL8028(t *testing.T) {
100, 1,
100, 150, 200)

query := fmt.Sprintf(perfEventsStatementsQueryMySQL, 120, 86400, 250)
query := fmt.Sprintf(perfEventsStatementsQueryMySQL, *perfEventsStatementsDigestTextLimit, buildExcludedSchemasList(*perfEventsStatementsExcludeSchemas), *perfEventsStatementsTimeLimit, *perfEventsStatementsLimit)
mock.ExpectQuery(sanitizeQuery(query)).WillReturnRows(rows)

ch := make(chan prometheus.Metric)
Expand Down