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

feat(tracing): improved tracing for persisters and requests #878

Merged
merged 4 commits into from
May 31, 2022
Merged
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
6 changes: 3 additions & 3 deletions internal/driver/daemon.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (

rts "github.com/ory/keto/proto/ory/keto/relation_tuples/v1alpha2"

"github.com/ory/x/otelx"
prometheus "github.com/ory/x/prometheusx"
grpcOtel "go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/otel"
Expand All @@ -36,6 +35,7 @@ import (
"github.com/ory/analytics-go/v4"
"github.com/ory/x/healthx"
"github.com/ory/x/metricsx"
"github.com/ory/x/otelx"
"github.com/spf13/cobra"

"github.com/ory/keto/internal/driver/config"
Expand Down Expand Up @@ -129,7 +129,7 @@ func (r *RegistryDefault) serveRead(ctx context.Context, done chan<- struct{}) f
rt, s := r.ReadRouter(ctx), r.ReadGRPCServer(ctx)

if tracer := r.Tracer(ctx); tracer.IsLoaded() {
rt = otelx.NewHandler(rt, "internal.driver.serveRead")
rt = otelx.TraceHandler(rt)
}

return func() error {
Expand All @@ -141,7 +141,7 @@ func (r *RegistryDefault) serveWrite(ctx context.Context, done chan<- struct{})
rt, s := r.WriteRouter(ctx), r.WriteGRPCServer(ctx)

if tracer := r.Tracer(ctx); tracer.IsLoaded() {
rt = otelx.NewHandler(rt, "internal.driver.serveWrite")
rt = otelx.TraceHandler(rt)
}

return func() error {
Expand Down
6 changes: 6 additions & 0 deletions internal/persistence/sql/namespaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import (
)

func (p *Persister) GetNamespaceByName(ctx context.Context, name string) (*namespace.Namespace, error) {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.GetNamespaceByName")
defer span.End()

nm, err := p.d.Config(ctx).NamespaceManager()
if err != nil {
return nil, err
Expand All @@ -15,6 +18,9 @@ func (p *Persister) GetNamespaceByName(ctx context.Context, name string) (*names
}

func (p *Persister) GetNamespaceByID(ctx context.Context, id int32) (*namespace.Namespace, error) {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.GetNamespaceByID")
defer span.End()

nm, err := p.d.Config(ctx).NamespaceManager()
if err != nil {
return nil, err
Expand Down
4 changes: 4 additions & 0 deletions internal/persistence/sql/persister.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ type (
dependencies interface {
config.Provider
x.LoggerProvider
x.TracingProvider
ketoctx.ContextualizerProvider

PopConnection(ctx context.Context) (*pop.Connection, error)
Expand Down Expand Up @@ -75,6 +76,9 @@ func (p *Persister) Connection(ctx context.Context) *pop.Connection {
}

func (p *Persister) CreateWithNetwork(ctx context.Context, v interface{}) error {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.CreateWithNetwork")
defer span.End()

rv := reflect.ValueOf(v)

if rv.Kind() != reflect.Ptr && rv.Elem().Kind() != reflect.Struct {
Expand Down
21 changes: 21 additions & 0 deletions internal/persistence/sql/relationtuples.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ func (r *RelationTuple) insertSubject(ctx context.Context, p *Persister, s relat
}

func (r *RelationTuple) FromInternal(ctx context.Context, p *Persister, rt *relationtuple.InternalRelationTuple) error {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.FromInternal")
defer span.End()

n, err := p.GetNamespaceByName(ctx, rt.Namespace)
if err != nil {
return err
Expand All @@ -126,6 +129,9 @@ func (r *RelationTuple) FromInternal(ctx context.Context, p *Persister, rt *rela
}

func (p *Persister) InsertRelationTuple(ctx context.Context, rel *relationtuple.InternalRelationTuple) error {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.InsertRelationTuple")
defer span.End()

if rel.Subject == nil {
return errors.WithStack(relationtuple.ErrNilSubject)
}
Expand Down Expand Up @@ -198,6 +204,9 @@ func (p *Persister) whereQuery(ctx context.Context, q *pop.Query, rq *relationtu
}

func (p *Persister) DeleteRelationTuples(ctx context.Context, rs ...*relationtuple.InternalRelationTuple) error {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.DeleteRelationTuples")
defer span.End()

return p.Transaction(ctx, func(ctx context.Context, _ *pop.Connection) error {
for _, r := range rs {
n, err := p.GetNamespaceByName(ctx, r.Namespace)
Expand All @@ -223,6 +232,9 @@ func (p *Persister) DeleteRelationTuples(ctx context.Context, rs ...*relationtup
}

func (p *Persister) DeleteAllRelationTuples(ctx context.Context, query *relationtuple.RelationQuery) error {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.DeleteAllRelationTuples")
defer span.End()

return p.Transaction(ctx, func(ctx context.Context, _ *pop.Connection) error {
sqlQuery := p.QueryWithNetwork(ctx)
err := p.whereQuery(ctx, sqlQuery, query)
Expand All @@ -236,6 +248,9 @@ func (p *Persister) DeleteAllRelationTuples(ctx context.Context, query *relation
}

func (p *Persister) GetRelationTuples(ctx context.Context, query *relationtuple.RelationQuery, options ...x.PaginationOptionSetter) ([]*relationtuple.InternalRelationTuple, string, error) {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.GetRelationTuples")
defer span.End()

pagination, err := internalPaginationFromOptions(options...)
if err != nil {
return nil, "", err
Expand Down Expand Up @@ -277,6 +292,9 @@ func (p *Persister) GetRelationTuples(ctx context.Context, query *relationtuple.
}

func (p *Persister) WriteRelationTuples(ctx context.Context, rs ...*relationtuple.InternalRelationTuple) error {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.WriteRelationTuples")
defer span.End()

return p.Transaction(ctx, func(ctx context.Context, _ *pop.Connection) error {
for _, r := range rs {
if err := p.InsertRelationTuple(ctx, r); err != nil {
Expand All @@ -288,6 +306,9 @@ func (p *Persister) WriteRelationTuples(ctx context.Context, rs ...*relationtupl
}

func (p *Persister) TransactRelationTuples(ctx context.Context, ins []*relationtuple.InternalRelationTuple, del []*relationtuple.InternalRelationTuple) error {
ctx, span := p.d.Tracer(ctx).Tracer().Start(ctx, "persistence.sql.TransactRelationTuples")
defer span.End()

return p.Transaction(ctx, func(ctx context.Context, _ *pop.Connection) error {
if err := p.WriteRelationTuples(ctx, ins...); err != nil {
return err
Expand Down
7 changes: 7 additions & 0 deletions internal/x/registry.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
package x

import (
"context"

"github.com/ory/herodot"
"github.com/ory/x/logrusx"
"github.com/ory/x/otelx"
)

type LoggerProvider interface {
Expand All @@ -12,3 +15,7 @@ type LoggerProvider interface {
type WriterProvider interface {
Writer() herodot.Writer
}

type TracingProvider interface {
Tracer(ctx context.Context) *otelx.Tracer
}