|
| 1 | +// Package trace wraps a datastore where all datastore interactions are traced |
| 2 | +// with open telemetry. |
| 3 | +package trace |
| 4 | + |
| 5 | +import ( |
| 6 | + "context" |
| 7 | + "fmt" |
| 8 | + "io" |
| 9 | + |
| 10 | + ds "github.com/ipfs/go-datastore" |
| 11 | + dsq "github.com/ipfs/go-datastore/query" |
| 12 | + "go.opentelemetry.io/otel/attribute" |
| 13 | + otel "go.opentelemetry.io/otel/trace" |
| 14 | +) |
| 15 | + |
| 16 | +// New returns a new traced datastore. All datastore interactions are traced. |
| 17 | +func New(ds ds.Datastore, tracer otel.Tracer) *Datastore { |
| 18 | + return &Datastore{ds: ds, tracer: tracer} |
| 19 | +} |
| 20 | + |
| 21 | +// Datastore is an adapter that traces inner datastore interactions. |
| 22 | +type Datastore struct { |
| 23 | + ds ds.Datastore |
| 24 | + tracer otel.Tracer |
| 25 | +} |
| 26 | + |
| 27 | +var ( |
| 28 | + _ ds.Datastore = (*Datastore)(nil) |
| 29 | + _ ds.Batching = (*Datastore)(nil) |
| 30 | + _ ds.PersistentDatastore = (*Datastore)(nil) |
| 31 | + _ ds.TxnDatastore = (*Datastore)(nil) |
| 32 | + _ ds.CheckedDatastore = (*Datastore)(nil) |
| 33 | + _ ds.ScrubbedDatastore = (*Datastore)(nil) |
| 34 | + _ ds.GCDatastore = (*Datastore)(nil) |
| 35 | + _ io.Closer = (*Datastore)(nil) |
| 36 | +) |
| 37 | + |
| 38 | +// Put implements the ds.Datastore interface. |
| 39 | +func (t *Datastore) Put(ctx context.Context, key ds.Key, value []byte) (err error) { |
| 40 | + ctx, span := t.tracer.Start(ctx, "Put", otel.WithAttributes(attribute.String("key", key.String()))) |
| 41 | + defer span.End() |
| 42 | + return t.ds.Put(ctx, key, value) |
| 43 | +} |
| 44 | + |
| 45 | +// Sync implements Datastore.Sync |
| 46 | +func (t *Datastore) Sync(ctx context.Context, key ds.Key) error { |
| 47 | + ctx, span := t.tracer.Start(ctx, "Sync", otel.WithAttributes(attribute.String("key", key.String()))) |
| 48 | + defer span.End() |
| 49 | + return t.ds.Sync(ctx, key) |
| 50 | +} |
| 51 | + |
| 52 | +// Get implements the ds.Datastore interface. |
| 53 | +func (t *Datastore) Get(ctx context.Context, key ds.Key) (value []byte, err error) { |
| 54 | + ctx, span := t.tracer.Start(ctx, "Get", otel.WithAttributes(attribute.String("key", key.String()))) |
| 55 | + defer span.End() |
| 56 | + return t.ds.Get(ctx, key) |
| 57 | +} |
| 58 | + |
| 59 | +// Has implements the ds.Datastore interface. |
| 60 | +func (t *Datastore) Has(ctx context.Context, key ds.Key) (exists bool, err error) { |
| 61 | + ctx, span := t.tracer.Start(ctx, "Has", otel.WithAttributes(attribute.String("key", key.String()))) |
| 62 | + defer span.End() |
| 63 | + return t.ds.Has(ctx, key) |
| 64 | +} |
| 65 | + |
| 66 | +// GetSize implements the ds.Datastore interface. |
| 67 | +func (t *Datastore) GetSize(ctx context.Context, key ds.Key) (size int, err error) { |
| 68 | + ctx, span := t.tracer.Start(ctx, "GetSize", otel.WithAttributes(attribute.String("key", key.String()))) |
| 69 | + defer span.End() |
| 70 | + return t.ds.GetSize(ctx, key) |
| 71 | +} |
| 72 | + |
| 73 | +// Delete implements the ds.Datastore interface. |
| 74 | +func (t *Datastore) Delete(ctx context.Context, key ds.Key) (err error) { |
| 75 | + ctx, span := t.tracer.Start(ctx, "Delete", otel.WithAttributes(attribute.String("key", key.String()))) |
| 76 | + defer span.End() |
| 77 | + return t.ds.Delete(ctx, key) |
| 78 | +} |
| 79 | + |
| 80 | +// Query implements the ds.Datastore interface. |
| 81 | +func (t *Datastore) Query(ctx context.Context, q dsq.Query) (dsq.Results, error) { |
| 82 | + ctx, span := t.tracer.Start(ctx, "Query", otel.WithAttributes(attribute.String("query", q.String()))) |
| 83 | + defer span.End() |
| 84 | + return t.ds.Query(ctx, q) |
| 85 | +} |
| 86 | + |
| 87 | +// Batch implements the ds.Batching interface. |
| 88 | +func (t *Datastore) Batch(ctx context.Context) (ds.Batch, error) { |
| 89 | + ctx, span := t.tracer.Start(ctx, "Batch") |
| 90 | + defer span.End() |
| 91 | + |
| 92 | + if batch, ok := t.ds.(ds.Batching); ok { |
| 93 | + return batch.Batch(ctx) |
| 94 | + } |
| 95 | + |
| 96 | + return ds.NewBasicBatch(t), nil |
| 97 | +} |
| 98 | + |
| 99 | +// DiskUsage implements the ds.PersistentDatastore interface. |
| 100 | +func (t *Datastore) DiskUsage(ctx context.Context) (uint64, error) { |
| 101 | + ctx, span := t.tracer.Start(ctx, "DiskUsage") |
| 102 | + defer span.End() |
| 103 | + return ds.DiskUsage(ctx, t.ds) |
| 104 | +} |
| 105 | + |
| 106 | +// Scrub implements the ds.ScrubbedDatastore interface. |
| 107 | +func (t *Datastore) Scrub(ctx context.Context) error { |
| 108 | + ctx, span := t.tracer.Start(ctx, "Scrub") |
| 109 | + defer span.End() |
| 110 | + |
| 111 | + if dstore, ok := t.tracer.(ds.ScrubbedDatastore); ok { |
| 112 | + return dstore.Scrub(ctx) |
| 113 | + } |
| 114 | + |
| 115 | + return nil |
| 116 | +} |
| 117 | + |
| 118 | +// CollectGarbage implements the ds.GCDatastore interface. |
| 119 | +func (t *Datastore) CollectGarbage(ctx context.Context) error { |
| 120 | + ctx, span := t.tracer.Start(ctx, "CollectGarbage") |
| 121 | + defer span.End() |
| 122 | + |
| 123 | + if dstore, ok := t.tracer.(ds.GCDatastore); ok { |
| 124 | + return dstore.CollectGarbage(ctx) |
| 125 | + } |
| 126 | + |
| 127 | + return nil |
| 128 | +} |
| 129 | + |
| 130 | +// Check implements the ds.CheckedDatastore interface. |
| 131 | +func (t *Datastore) Check(ctx context.Context) error { |
| 132 | + ctx, span := t.tracer.Start(ctx, "Check") |
| 133 | + defer span.End() |
| 134 | + |
| 135 | + if dstore, ok := t.tracer.(ds.CheckedDatastore); ok { |
| 136 | + return dstore.Check(ctx) |
| 137 | + } |
| 138 | + |
| 139 | + return nil |
| 140 | +} |
| 141 | + |
| 142 | +// NewTransaction implements the ds.TxnDatastore interface. |
| 143 | +func (t *Datastore) NewTransaction(ctx context.Context, readOnly bool) (ds.Txn, error) { |
| 144 | + ctx, span := t.tracer.Start(ctx, "NewTransaction", otel.WithAttributes(attribute.Bool("readOnly", readOnly))) |
| 145 | + defer span.End() |
| 146 | + |
| 147 | + if txnDs, ok := t.ds.(ds.TxnDatastore); ok { |
| 148 | + txn, err := txnDs.NewTransaction(ctx, readOnly) |
| 149 | + if err != nil { |
| 150 | + return nil, err |
| 151 | + } |
| 152 | + return &Txn{txn: txn, tracer: t.tracer}, nil |
| 153 | + } |
| 154 | + |
| 155 | + return nil, fmt.Errorf("transactions are unsupported by traced datastore") |
| 156 | +} |
| 157 | + |
| 158 | +// Close closes the inner datastore (if it implements the io.Closer interface). |
| 159 | +func (t *Datastore) Close() error { |
| 160 | + if closer, ok := t.ds.(io.Closer); ok { |
| 161 | + return closer.Close() |
| 162 | + } |
| 163 | + return nil |
| 164 | +} |
| 165 | + |
| 166 | +// Txn is an adapter that traces datastore transactions |
| 167 | +type Txn struct { |
| 168 | + txn ds.Txn |
| 169 | + tracer otel.Tracer |
| 170 | +} |
| 171 | + |
| 172 | +var _ ds.Txn = (*Txn)(nil) |
| 173 | + |
| 174 | +// Put implements the ds.Txn interface. |
| 175 | +func (t *Txn) Put(ctx context.Context, key ds.Key, value []byte) (err error) { |
| 176 | + ctx, span := t.tracer.Start(ctx, "Put", otel.WithAttributes(attribute.String("key", key.String()))) |
| 177 | + defer span.End() |
| 178 | + return t.txn.Put(ctx, key, value) |
| 179 | +} |
| 180 | + |
| 181 | +// Get implements the ds.Txn interface. |
| 182 | +func (t *Txn) Get(ctx context.Context, key ds.Key) (value []byte, err error) { |
| 183 | + ctx, span := t.tracer.Start(ctx, "Get", otel.WithAttributes(attribute.String("key", key.String()))) |
| 184 | + defer span.End() |
| 185 | + return t.txn.Get(ctx, key) |
| 186 | +} |
| 187 | + |
| 188 | +// Has implements the ds.Txn interface. |
| 189 | +func (t *Txn) Has(ctx context.Context, key ds.Key) (exists bool, err error) { |
| 190 | + ctx, span := t.tracer.Start(ctx, "Has", otel.WithAttributes(attribute.String("key", key.String()))) |
| 191 | + defer span.End() |
| 192 | + return t.txn.Has(ctx, key) |
| 193 | +} |
| 194 | + |
| 195 | +// GetSize implements the ds.Txn interface. |
| 196 | +func (t *Txn) GetSize(ctx context.Context, key ds.Key) (size int, err error) { |
| 197 | + ctx, span := t.tracer.Start(ctx, "GetSize", otel.WithAttributes(attribute.String("key", key.String()))) |
| 198 | + defer span.End() |
| 199 | + return t.txn.GetSize(ctx, key) |
| 200 | +} |
| 201 | + |
| 202 | +// Delete implements the ds.Txn interface. |
| 203 | +func (t *Txn) Delete(ctx context.Context, key ds.Key) (err error) { |
| 204 | + ctx, span := t.tracer.Start(ctx, "Delete", otel.WithAttributes(attribute.String("key", key.String()))) |
| 205 | + defer span.End() |
| 206 | + return t.txn.Delete(ctx, key) |
| 207 | +} |
| 208 | + |
| 209 | +// Query implements the ds.Txn interface. |
| 210 | +func (t *Txn) Query(ctx context.Context, q dsq.Query) (dsq.Results, error) { |
| 211 | + ctx, span := t.tracer.Start(ctx, "Query", otel.WithAttributes(attribute.String("query", q.String()))) |
| 212 | + defer span.End() |
| 213 | + return t.txn.Query(ctx, q) |
| 214 | +} |
| 215 | + |
| 216 | +// Commit implements the ds.Txn interface. |
| 217 | +func (t *Txn) Commit(ctx context.Context) error { |
| 218 | + ctx, span := t.tracer.Start(ctx, "Commit") |
| 219 | + defer span.End() |
| 220 | + return t.txn.Commit(ctx) |
| 221 | +} |
| 222 | + |
| 223 | +// Discard implements the ds.Txn interface. |
| 224 | +func (t *Txn) Discard(ctx context.Context) { |
| 225 | + ctx, span := t.tracer.Start(ctx, "Discard") |
| 226 | + defer span.End() |
| 227 | + t.txn.Discard(ctx) |
| 228 | +} |
0 commit comments