Skip to content
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.

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

database_observability: use TiDB parser for parsing query samples #2807

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ Main (unreleased)

- Add support for proxy and headers in `prometheus.write.queue`. (@mattdurham)

v1.7.1
-----------------

Comment on lines -36 to -38
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving this entry as the change "better handling of truncated queries" was not included in 1.7.1.

- (_Experimental_) Various changes to the experimental component `database_observability.mysql`:
- `query_sample`: better handling of truncated queries (@cristiangreco)
- `query_sample`: add option to use TiDB sql parser (@cristiangreco)

v1.7.1
-----------------

### Bugfixes

Expand Down
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ require (
github.com/oschwald/maxminddb-golang v1.13.0
github.com/percona/mongodb_exporter v0.43.1
github.com/phayes/freeport v0.0.0-20220201140144-74d24b5ae9f5
github.com/pingcap/tidb/pkg/parser v0.0.0-20250220113329-fdf33cffaea7
github.com/pkg/errors v0.9.1
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2
github.com/prometheus-community/elasticsearch_exporter v1.5.0
Expand Down Expand Up @@ -747,6 +748,9 @@ require (
github.com/philhofer/fwd v1.1.3-0.20240916144458-20a13a1f6b7c // indirect
github.com/pierrec/lz4 v2.6.1+incompatible // indirect
github.com/pierrec/lz4/v4 v4.1.22 // indirect
github.com/pingcap/errors v0.11.5-0.20240311024730-e056997136bb // indirect
github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86 // indirect
github.com/pingcap/log v1.1.0 // indirect
github.com/pires/go-proxyproto v0.7.0 // indirect
github.com/pjbgf/sha1cd v0.3.0 // indirect
github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect
Expand Down Expand Up @@ -883,6 +887,7 @@ require (
gopkg.in/fsnotify/fsnotify.v1 v1.4.7 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 // indirect
gopkg.in/warnings.v0 v0.1.2 // indirect
gopkg.in/zorkian/go-datadog-api.v2 v2.30.0 // indirect
Expand Down
14 changes: 14 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -2235,6 +2235,15 @@ github.com/pierrec/lz4 v2.6.1+incompatible h1:9UY3+iC23yxF0UfGaYrGplQ+79Rg+h/q9F
github.com/pierrec/lz4 v2.6.1+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY=
github.com/pierrec/lz4/v4 v4.1.22 h1:cKFw6uJDK+/gfw5BcDL0JL5aBsAFdsIT18eRtLj7VIU=
github.com/pierrec/lz4/v4 v4.1.22/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
github.com/pingcap/errors v0.11.0/go.mod h1:Oi8TUi2kEtXXLMJk9l1cGmz20kV3TaQ0usTwv5KuLY8=
github.com/pingcap/errors v0.11.5-0.20240311024730-e056997136bb h1:3pSi4EDG6hg0orE1ndHkXvX6Qdq2cZn8gAPir8ymKZk=
github.com/pingcap/errors v0.11.5-0.20240311024730-e056997136bb/go.mod h1:X2r9ueLEUZgtx2cIogM0v4Zj5uvvzhuuiu7Pn8HzMPg=
github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86 h1:tdMsjOqUR7YXHoBitzdebTvOjs/swniBTOLy5XiMtuE=
github.com/pingcap/failpoint v0.0.0-20240528011301-b51a646c7c86/go.mod h1:exzhVYca3WRtd6gclGNErRWb1qEgff3LYta0LvRmON4=
github.com/pingcap/log v1.1.0 h1:ELiPxACz7vdo1qAvvaWJg1NrYFoY6gqAh/+Uo6aXdD8=
github.com/pingcap/log v1.1.0/go.mod h1:DWQW5jICDR7UJh4HtxXSM20Churx4CQL0fwL/SoOSA4=
github.com/pingcap/tidb/pkg/parser v0.0.0-20250220113329-fdf33cffaea7 h1:nLmoYd9OR1GitgJWDM/3ujpVywzAMC9mqj29GBjPCJ8=
github.com/pingcap/tidb/pkg/parser v0.0.0-20250220113329-fdf33cffaea7/go.mod h1:Hju1TEWZvrctQKbztTRwXH7rd41Yq0Pgmq4PrEKcq7o=
github.com/pires/go-proxyproto v0.7.0 h1:IukmRewDQFWC7kfnb66CSomk2q/seBuilHBYFwyq0Hs=
github.com/pires/go-proxyproto v0.7.0/go.mod h1:Vz/1JPY/OACxWGQNIRY2BeyDmpoaWmEP40O9LbuiFR4=
github.com/pjbgf/sha1cd v0.3.0 h1:4D5XXmUUBUl/xQ6IjCkEAbqXskkq/4O7LmGn0AqMDs4=
Expand Down Expand Up @@ -2918,6 +2927,7 @@ go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/
go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4=
go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU=
go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU=
go.uber.org/multierr v1.7.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak=
go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA=
Expand All @@ -2927,6 +2937,7 @@ go.uber.org/zap v1.13.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM=
go.uber.org/zap v1.14.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM=
go.uber.org/zap v1.17.0/go.mod h1:MXVU+bhUf/A7Xi2HNOnopQOrmycQ5Ih87HtOu4q5SSo=
go.uber.org/zap v1.18.1/go.mod h1:xg/QME4nWcxGxrpdeYfq7UvYrLh66cuVKdrbD1XF/NI=
go.uber.org/zap v1.19.0/go.mod h1:xg/QME4nWcxGxrpdeYfq7UvYrLh66cuVKdrbD1XF/NI=
go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
go4.org/netipx v0.0.0-20230125063823-8449b0a6169f h1:ketMxHg+vWm3yccyYiq+uK8D3fRmna2Fcj+awpQp84s=
Expand Down Expand Up @@ -3618,6 +3629,9 @@ gopkg.in/jcmturner/rpc.v1 v1.1.0/go.mod h1:YIdkC4XfD6GXbzje11McwsDuOlZQSb9W4vfLv
gopkg.in/ldap.v3 v3.1.0/go.mod h1:dQjCc0R0kfyFjIlWNMH1DORwUASZyDxo2Ry1B51dXaQ=
gopkg.in/mgo.v2 v2.0.0-20160818020120-3f83fa500528/go.mod h1:yeKp02qBN3iKW1OzL3MGk2IdtZzaj7SFntXj72NppTA=
gopkg.in/mgo.v2 v2.0.0-20180705113604-9856a29383ce/go.mod h1:yeKp02qBN3iKW1OzL3MGk2IdtZzaj7SFntXj72NppTA=
gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k=
gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc=
gopkg.in/olivere/elastic.v5 v5.0.70/go.mod h1:FylZT6jQWtfHsicejzOm3jIMVPOAksa80i3o+6qtQRk=
gopkg.in/ory-am/dockertest.v3 v3.3.4/go.mod h1:s9mmoLkaGeAh97qygnNj4xWkiN7e1SKekYC6CovU+ek=
gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
package collector
package parser_test

import (
"testing"

"github.com/go-kit/log"
"github.com/grafana/alloy/internal/component/database_observability/mysql/collector/parser"
"github.com/stretchr/testify/require"
)

Expand Down Expand Up @@ -130,12 +131,21 @@ func TestExtractTableNames(t *testing.T) {
}

for _, tc := range testcases {
t.Run(tc.name, func(t *testing.T) {
stmt, err := ParseSql(tc.sql)
t.Run(tc.name+"_xwbparser", func(t *testing.T) {
p := parser.NewXwbSqlParser()
stmt, err := p.ParseSql(tc.sql)
require.NoError(t, err)

got := ExtractTableNames(log.NewNopLogger(), "", stmt)
require.Equal(t, tc.tables, got)
got := p.ExtractTableNames(log.NewNopLogger(), "", stmt)
require.ElementsMatch(t, tc.tables, got)
})
t.Run(tc.name+"_tidbparser", func(t *testing.T) {
p := parser.NewTiDBSqlParser()
stmt, err := p.ParseSql(tc.sql)
require.NoError(t, err)

got := p.ExtractTableNames(log.NewNopLogger(), "", stmt)
require.ElementsMatch(t, tc.tables, got)
})
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
package parser

import (
"fmt"

"golang.org/x/exp/maps"

"github.com/go-kit/log"
"github.com/pingcap/tidb/pkg/parser"
"github.com/pingcap/tidb/pkg/parser/ast"
_ "github.com/pingcap/tidb/pkg/parser/test_driver"
)

type TiDBSqlParser struct{}

func NewTiDBSqlParser() *TiDBSqlParser {
return &TiDBSqlParser{}
}

func (p *TiDBSqlParser) ParseSql(sql string) (any, error) {
stmtNodes, _, err := parser.New().ParseSQL(sql)
if err != nil {
return nil, err
}

if len(stmtNodes) == 0 {
return nil, fmt.Errorf("no statements parsed")
}

return &stmtNodes[0], nil
}

func (p *TiDBSqlParser) RedactSQL(sql string) (string, error) {
res := parser.Normalize(sql, "ON")
if res == "" {
return "", fmt.Errorf("error normalizing SQL")
}
return res, nil
}

func (p *TiDBSqlParser) StmtType(stmt any) string {
s := stmt.(*ast.StmtNode)
switch ast.GetStmtLabel(*s) {
case "Select":
return "select"
case "Insert":
return "insert"
case "Update":
return "update"
case "Delete":
return "delete"
default:
return ""
}
}

func (p *TiDBSqlParser) ExtractTableNames(_ log.Logger, _ string, stmt any) []string {
v := &tableNameVisitor{
tables: map[string]struct{}{},
}
(*stmt.(*ast.StmtNode)).Accept(v)
return maps.Keys(v.tables)
}

func (p *TiDBSqlParser) ParseTableName(t any) string {
return parseTableName(t.(*ast.TableName))
}

type tableNameVisitor struct {
tables map[string]struct{}
}

func (v *tableNameVisitor) Enter(n ast.Node) (ast.Node, bool) {
if tableRef, ok := n.(*ast.TableName); ok {
tableName := parseTableName(tableRef)
v.tables[tableName] = struct{}{}
}
return n, false
}

func (v *tableNameVisitor) Leave(n ast.Node) (ast.Node, bool) {
return n, true
}

func parseTableName(t *ast.TableName) string {
schema := t.Schema.String()
tableName := t.Name.String()
if schema != "" {
return schema + "." + tableName
}
return tableName
}
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
package collector
package parser

import (
"github.com/go-kit/log"
"github.com/grafana/alloy/internal/runtime/logging/level"
"github.com/xwb1989/sqlparser"
)

func ParseSql(sql string) (sqlparser.Statement, error) {
type XwbSqlParser struct{}

func NewXwbSqlParser() *XwbSqlParser {
return &XwbSqlParser{}
}

func (p *XwbSqlParser) ParseSql(sql string) (any, error) {
return sqlparser.Parse(sql)
}

func RedactSQL(sql string) (string, error) {
func (p *XwbSqlParser) RedactSQL(sql string) (string, error) {
return sqlparser.RedactSQLQuery(sql)
}

func StmtType(stmt sqlparser.Statement) string {
func (p *XwbSqlParser) StmtType(stmt any) string {
switch stmt.(type) {
case *sqlparser.Select:
return "select"
Expand All @@ -31,7 +37,8 @@ func StmtType(stmt sqlparser.Statement) string {
}
}

func ParseTableName(t sqlparser.TableName) string {
func (p *XwbSqlParser) ParseTableName(table any) string {
t := table.(sqlparser.TableName)
qualifier := t.Qualifier.String()
tableName := t.Name.String()
if qualifier != "" {
Expand All @@ -40,7 +47,7 @@ func ParseTableName(t sqlparser.TableName) string {
return tableName
}

func ExtractTableNames(logger log.Logger, digest string, stmt sqlparser.Statement) []string {
func (p *XwbSqlParser) ExtractTableNames(logger log.Logger, digest string, stmt any) []string {
var parsedTables []string

switch stmt := stmt.(type) {
Expand All @@ -49,43 +56,43 @@ func ExtractTableNames(logger log.Logger, digest string, stmt sqlparser.Statemen
if expr, ok := selExpr.(*sqlparser.AliasedExpr); ok {
switch exp := expr.Expr.(type) {
case *sqlparser.Subquery:
parsedTables = append(parsedTables, ExtractTableNames(logger, digest, exp.Select)...)
parsedTables = append(parsedTables, p.ExtractTableNames(logger, digest, exp.Select)...)
default:
// ignore anything else
}
}
}
parsedTables = append(parsedTables, parseTableExprs(logger, digest, stmt.From)...)
parsedTables = append(parsedTables, p.parseTableExprs(logger, digest, stmt.From)...)
case *sqlparser.Update:
parsedTables = parseTableExprs(logger, digest, stmt.TableExprs)
parsedTables = p.parseTableExprs(logger, digest, stmt.TableExprs)
case *sqlparser.Delete:
parsedTables = parseTableExprs(logger, digest, stmt.TableExprs)
parsedTables = p.parseTableExprs(logger, digest, stmt.TableExprs)
case *sqlparser.Insert:
parsedTables = []string{ParseTableName(stmt.Table)}
parsedTables = []string{p.ParseTableName(stmt.Table)}
switch insRowsStmt := stmt.Rows.(type) {
case sqlparser.Values:
// ignore raw values
case *sqlparser.Select:
parsedTables = append(parsedTables, ExtractTableNames(logger, digest, insRowsStmt)...)
parsedTables = append(parsedTables, p.ExtractTableNames(logger, digest, insRowsStmt)...)
case *sqlparser.Union:
for _, side := range []sqlparser.SelectStatement{insRowsStmt.Left, insRowsStmt.Right} {
parsedTables = append(parsedTables, ExtractTableNames(logger, digest, side)...)
parsedTables = append(parsedTables, p.ExtractTableNames(logger, digest, side)...)
}
case *sqlparser.ParenSelect:
parsedTables = append(parsedTables, ExtractTableNames(logger, digest, insRowsStmt.Select)...)
parsedTables = append(parsedTables, p.ExtractTableNames(logger, digest, insRowsStmt.Select)...)
default:
level.Error(logger).Log("msg", "unknown insert type", "digest", digest)
}
case *sqlparser.Union:
for _, side := range []sqlparser.SelectStatement{stmt.Left, stmt.Right} {
parsedTables = append(parsedTables, ExtractTableNames(logger, digest, side)...)
parsedTables = append(parsedTables, p.ExtractTableNames(logger, digest, side)...)
}
case *sqlparser.Show:
if stmt.HasOnTable() {
parsedTables = append(parsedTables, ParseTableName(stmt.OnTable))
parsedTables = append(parsedTables, p.ParseTableName(stmt.OnTable))
}
case *sqlparser.DDL:
parsedTables = append(parsedTables, ParseTableName(stmt.Table))
parsedTables = append(parsedTables, p.ParseTableName(stmt.Table))
case *sqlparser.Begin, *sqlparser.Commit, *sqlparser.Rollback, *sqlparser.Set, *sqlparser.DBDDL:
// ignore
default:
Expand All @@ -95,25 +102,25 @@ func ExtractTableNames(logger log.Logger, digest string, stmt sqlparser.Statemen
return parsedTables
}

func parseTableExprs(logger log.Logger, digest string, tables sqlparser.TableExprs) []string {
func (p *XwbSqlParser) parseTableExprs(logger log.Logger, digest string, tables sqlparser.TableExprs) []string {
parsedTables := []string{}
for i := 0; i < len(tables); i++ {
t := tables[i]
switch tableExpr := t.(type) {
case *sqlparser.AliasedTableExpr:
switch expr := tableExpr.Expr.(type) {
case sqlparser.TableName:
parsedTables = append(parsedTables, ParseTableName(expr))
parsedTables = append(parsedTables, p.ParseTableName(expr))
case *sqlparser.Subquery:
switch subqueryExpr := expr.Select.(type) {
case *sqlparser.Select:
parsedTables = append(parsedTables, parseTableExprs(logger, digest, subqueryExpr.From)...)
parsedTables = append(parsedTables, p.parseTableExprs(logger, digest, subqueryExpr.From)...)
case *sqlparser.Union:
for _, side := range []sqlparser.SelectStatement{subqueryExpr.Left, subqueryExpr.Right} {
parsedTables = append(parsedTables, ExtractTableNames(logger, digest, side)...)
parsedTables = append(parsedTables, p.ExtractTableNames(logger, digest, side)...)
}
case *sqlparser.ParenSelect:
parsedTables = append(parsedTables, ExtractTableNames(logger, digest, subqueryExpr.Select)...)
parsedTables = append(parsedTables, p.ExtractTableNames(logger, digest, subqueryExpr.Select)...)
default:
level.Error(logger).Log("msg", "unknown subquery type", "digest", digest)
}
Expand Down
Loading
Loading