Files
zeekayandHanzo Dev 2965c80547 An address is measured from a root this package owns
The five claim verbs need the address an operation will answer at, which is a
root joined with a path. They used to ask the target for its prefix through a
struct written to answer with one — and that struct existed for a second reason
that has since gone: an operation with no declared id took a shape-derived one
qualified by the prefix of the occurrence it answered under, so a plain group
would have renamed every undeclared id. All 319 operations state their own id
now, so a declared id survives composition verbatim and the group is just a
group.

The roots are this package's own constants, so each group carries the one it was
made with and nothing can disagree about the address. The escape hatches name
their whole address and register through Raw, which says which method each one
answers.

The test that measured the gap reached zero and said so; it now holds the
property from the other side, that no operation goes undeclared.

Co-authored-by: Hanzo Dev <[email protected]>
2026-09-17 06:15:44 -07:00

312 lines
11 KiB
Go

package datastoretelemetrystore
import (
"context"
datastore "github.com/hanzo-ds/go"
"github.com/hanzo-ds/go/lib/driver"
"github.com/hanzoai/o11y/pkg/errors"
"github.com/hanzoai/o11y/pkg/factory"
"github.com/hanzoai/o11y/pkg/telemetrystore"
"github.com/hanzoai/o11y/pkg/types/telemetrystoretypes"
"go.opentelemetry.io/otel/metric"
)
var (
ErrCodeSyntaxError = errors.MustNewCode("syntax_error")
ErrCodeUnknownTable = errors.MustNewCode("unknown_table")
ErrCodeUnknownDatabase = errors.MustNewCode("unknown_database")
ErrCodeUnknownIdentifier = errors.MustNewCode("unknown_identifier")
ErrCodeIllegalArgument = errors.MustNewCode("illegal_argument")
ErrCodeQueryCanceled = errors.MustNewCode("query_canceled")
ErrCodeQueryTimeout = errors.MustNewCode("query_timeout")
ErrCodeExecutionFailed = errors.MustNewCode("execution_failed")
)
// Datastore server exception codes (stable wire values). Only the subset the
// query plane maps to typed errors is named; codes absent from
// datastoreExceptionWrappers fall through to the raw driver error in castError.
const (
codeUnknownElementInAst int32 = 37
codeNumberOfArgumentsDoesntMatch int32 = 42
codeIllegalTypeOfArgument int32 = 43
codeIllegalColumn int32 = 44
codeUnknownFunction int32 = 46
codeUnknownIdentifier int32 = 47
codeUnknownType int32 = 50
codeUnknownStorage int32 = 56
codeUnknownTable int32 = 60
codeSyntaxError int32 = 62
codeUnknownAggregateFunction int32 = 63
codeUnknownTypeOfQuery int32 = 78
codeUnknownDatabase int32 = 81
codeTooManyArgumentsForFunction int32 = 34
codeTooLessArgumentsForFunction int32 = 35
)
var datastoreExceptionWrappers = map[int32]func(cause error, ex *datastore.Exception) error{
codeSyntaxError: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeSyntaxError, "SQL syntax error: %s", ex.Message)
},
codeUnknownTable: func(cause error, ex *datastore.Exception) error {
return errors.WrapNotFoundf(cause, ErrCodeUnknownTable, "unknown table: %s", ex.Message)
},
codeUnknownDatabase: func(cause error, ex *datastore.Exception) error {
return errors.WrapNotFoundf(cause, ErrCodeUnknownDatabase, "unknown database: %s", ex.Message)
},
codeUnknownIdentifier: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeUnknownIdentifier, "unknown identifier: %s", ex.Message)
},
codeUnknownFunction: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeUnknownIdentifier, "unknown function: %s", ex.Message)
},
codeUnknownAggregateFunction: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeUnknownIdentifier, "unknown aggregate function: %s", ex.Message)
},
codeUnknownType: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeUnknownIdentifier, "unknown type: %s", ex.Message)
},
codeUnknownStorage: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeUnknownIdentifier, "unknown storage engine: %s", ex.Message)
},
codeIllegalColumn: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeUnknownIdentifier, "illegal column: %s", ex.Message)
},
codeUnknownElementInAst: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeSyntaxError, "unknown element in SQL AST: %s", ex.Message)
},
codeUnknownTypeOfQuery: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeSyntaxError, "unknown query type: %s", ex.Message)
},
codeIllegalTypeOfArgument: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeIllegalArgument, "illegal argument type: %s", ex.Message)
},
codeNumberOfArgumentsDoesntMatch: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeIllegalArgument, "wrong number of arguments: %s", ex.Message)
},
codeTooManyArgumentsForFunction: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeIllegalArgument, "too many arguments to function: %s", ex.Message)
},
codeTooLessArgumentsForFunction: func(cause error, ex *datastore.Exception) error {
return errors.WrapInvalidInputf(cause, ErrCodeIllegalArgument, "too few arguments to function: %s", ex.Message)
},
}
type provider struct {
settings factory.ScopedProviderSettings
datastoreConn datastore.Conn
cluster string
hooks []telemetrystore.TelemetryStoreHook
}
func NewFactory(hookFactories ...factory.ProviderFactory[telemetrystore.TelemetryStoreHook, telemetrystore.Config]) factory.ProviderFactory[telemetrystore.TelemetryStore, telemetrystore.Config] {
return factory.NewProviderFactory(factory.MustNewName("datastore"), func(ctx context.Context, providerSettings factory.ProviderSettings, config telemetrystore.Config) (telemetrystore.TelemetryStore, error) {
return New(ctx, providerSettings, config, hookFactories...)
})
}
func New(ctx context.Context, providerSettings factory.ProviderSettings, config telemetrystore.Config, hookFactories ...factory.ProviderFactory[telemetrystore.TelemetryStoreHook, telemetrystore.Config]) (telemetrystore.TelemetryStore, error) {
settings := factory.NewScopedProviderSettings(providerSettings, "github.com/hanzoai/o11y/pkg/telemetrystore/datastoretelemetrystore")
options, err := datastore.ParseDSN(config.Datastore.DSN)
if err != nil {
return nil, err
}
options.MaxIdleConns = config.Connection.MaxIdleConns
options.MaxOpenConns = config.Connection.MaxOpenConns
options.DialTimeout = config.Connection.DialTimeout
// This is to avoid the driver decoding issues with JSON columns
options.Settings["output_format_native_write_json_as_string"] = 1
chConn, err := datastore.Open(options)
if err != nil {
return nil, err
}
hooks := make([]telemetrystore.TelemetryStoreHook, len(hookFactories))
for i, hookFactory := range hookFactories {
hook, err := hookFactory.New(ctx, providerSettings, config)
if err != nil {
return nil, err
}
hooks[i] = hook
}
metrics, err := newMetrics(settings.Meter())
if err != nil {
return nil, err
}
_, err = settings.Meter().RegisterCallback(func(_ context.Context, observer metric.Observer) error {
stats := chConn.Stats()
observer.ObserveInt64(metrics.open, int64(stats.Open))
observer.ObserveInt64(metrics.idle, int64(stats.Idle))
observer.ObserveInt64(metrics.maxOpen, int64(stats.MaxOpenConns))
observer.ObserveInt64(metrics.maxIdle, int64(stats.MaxIdleConns))
return nil
}, metrics.open, metrics.idle, metrics.maxOpen, metrics.maxIdle)
if err != nil {
return nil, err
}
p := &provider{
settings: settings,
datastoreConn: chConn,
cluster: config.Datastore.Cluster,
hooks: hooks,
}
return p, nil
}
func (p *provider) Datastore() datastore.Conn {
return p
}
func (p *provider) Estimate(ctx context.Context, stmt string, args ...any) ([]telemetrystoretypes.EstimateEntry, error) {
return RunExplainEstimate(ctx, p, stmt, args...)
}
func (p *provider) Plan(ctx context.Context, stmt string, args ...any) error {
return RunExplainPlan(ctx, p, stmt, args...)
}
func (p *provider) Indexes(ctx context.Context, stmt string, args ...any) (telemetrystoretypes.Granules, bool, error) {
return RunExplainIndexes(ctx, p, stmt, args...)
}
func (p *provider) Cluster() string {
return p.cluster
}
func (p *provider) Close() error {
return p.datastoreConn.Close()
}
func (p *provider) Ping(ctx context.Context) error {
return p.datastoreConn.Ping(ctx)
}
func (p *provider) Stats() driver.Stats {
return p.datastoreConn.Stats()
}
func (p *provider) Query(ctx context.Context, query string, args ...interface{}) (driver.Rows, error) {
event := telemetrystore.NewQueryEvent(query, args)
ctx = telemetrystore.WrapBeforeQuery(p.hooks, ctx, event)
rows, err := p.datastoreConn.Query(ctx, query, args...)
if err != nil {
event.Err = err
telemetrystore.WrapAfterQuery(p.hooks, ctx, event)
return nil, castError(err)
}
return &rowsWithHooks{
Rows: rows,
ctx: ctx,
event: event,
onClose: func() { telemetrystore.WrapAfterQuery(p.hooks, ctx, event) },
}, nil
}
func (p *provider) QueryRow(ctx context.Context, query string, args ...interface{}) driver.Row {
event := telemetrystore.NewQueryEvent(query, args)
ctx = telemetrystore.WrapBeforeQuery(p.hooks, ctx, event)
row := p.datastoreConn.QueryRow(ctx, query, args...)
if row == nil {
telemetrystore.WrapAfterQuery(p.hooks, ctx, event)
return nil
}
event.Err = row.Err()
telemetrystore.WrapAfterQuery(p.hooks, ctx, event)
return &rowWithCastError{Row: row}
}
func (p *provider) Select(ctx context.Context, dest interface{}, query string, args ...interface{}) error {
event := telemetrystore.NewQueryEvent(query, args)
ctx = telemetrystore.WrapBeforeQuery(p.hooks, ctx, event)
err := p.datastoreConn.Select(ctx, dest, query, args...)
event.Err = err
telemetrystore.WrapAfterQuery(p.hooks, ctx, event)
return castError(err)
}
func (p *provider) Exec(ctx context.Context, query string, args ...interface{}) error {
event := telemetrystore.NewQueryEvent(query, args)
ctx = telemetrystore.WrapBeforeQuery(p.hooks, ctx, event)
err := p.datastoreConn.Exec(ctx, query, args...)
event.Err = err
telemetrystore.WrapAfterQuery(p.hooks, ctx, event)
return castError(err)
}
func (p *provider) AsyncInsert(ctx context.Context, query string, wait bool, args ...interface{}) error {
event := telemetrystore.NewQueryEvent(query, args)
ctx = telemetrystore.WrapBeforeQuery(p.hooks, ctx, event)
err := p.datastoreConn.Exec(datastore.Context(ctx, datastore.WithAsync(wait)), query, args...)
event.Err = err
telemetrystore.WrapAfterQuery(p.hooks, ctx, event)
return castError(err)
}
func (p *provider) PrepareBatch(ctx context.Context, query string, opts ...driver.PrepareBatchOption) (driver.Batch, error) {
event := telemetrystore.NewQueryEvent(query, nil)
ctx = telemetrystore.WrapBeforeQuery(p.hooks, ctx, event)
batch, err := p.datastoreConn.PrepareBatch(ctx, query, opts...)
event.Err = err
telemetrystore.WrapAfterQuery(p.hooks, ctx, event)
if batch == nil {
return nil, castError(err)
}
return &batchWithCastError{Batch: batch}, castError(err)
}
func (p *provider) ServerVersion() (*driver.ServerVersion, error) {
return p.datastoreConn.ServerVersion()
}
func (p *provider) Contributors() []string {
return p.datastoreConn.Contributors()
}
func castError(err error) error {
if err == nil {
return nil
}
if errors.Is(err, context.Canceled) {
return errors.WrapCanceledf(err, ErrCodeQueryCanceled, "query canceled")
}
if errors.Is(err, context.DeadlineExceeded) {
return errors.WrapTimeoutf(err, ErrCodeQueryTimeout, "query timed out")
}
var ex *datastore.Exception
if !errors.As(err, &ex) {
return err
}
if wrap, ok := datastoreExceptionWrappers[int32(ex.Code)]; ok {
return wrap(err, ex)
}
return err
}