gocql

Documentation

Overview

Package gocql provides functions to trace the gocql/gocql package (https://github.com/gocql/gocql).

Index

• func CreateTracedSession(cluster *gocql.ClusterConfig, opts ...WrapOption) (*gocql.Session, error)
• type Batch
  • func WrapBatch(b *gocql.Batch, opts ...WrapOption) *Batch
  • func (tb *Batch) ExecuteBatch(session *gocql.Session) error
  • func (tb *Batch) WithContext(ctx context.Context) *Batch
  • func (tb *Batch) WithTimestamp(timestamp int64) *Batch
  • func (tb *Batch) WithWrapOptions(opts ...WrapOption) *Batch
• type ClusterConfig
  • func NewCluster(hosts []string, opts ...WrapOption) *ClusterConfig
  • func (c *ClusterConfig) CreateSession() (*Session, error)
• type Iter
  • func (tIter *Iter) Close() error
  • func (tIter *Iter) Scanner() gocql.Scanner
• type Observer
  • func NewObserver(cluster *gocql.ClusterConfig, opts ...WrapOption) *Observer
  • func (o *Observer) ObserveBatch(ctx context.Context, batch gocql.ObservedBatch)
  • func (o *Observer) ObserveConnect(connect gocql.ObservedConnect)
  • func (o *Observer) ObserveQuery(ctx context.Context, query gocql.ObservedQuery)
• type Query
  • func WrapQuery(q *gocql.Query, opts ...WrapOption) *Query
  • func (tq *Query) Exec() error
  • func (tq *Query) Iter() *Iter
  • func (tq *Query) MapScan(m map[string]interface{}) error
  • func (tq *Query) MapScanCAS(m map[string]interface{}) (applied bool, err error)
  • func (tq *Query) PageState(state []byte) *Query
  • func (tq *Query) Scan(dest ...interface{}) error
  • func (tq *Query) ScanCAS(dest ...interface{}) (applied bool, err error)
  • func (tq *Query) WithContext(ctx context.Context) *Query
  • func (tq *Query) WithWrapOptions(opts ...WrapOption) *Query
• type Scanner
  • func (s *Scanner) Err() error
• type Session
  • func (s *Session) NewBatch(typ gocql.BatchType) *Batch
  • func (s *Session) Query(stmt string, values ...interface{}) *Query
• type WrapOption
  • func NoDebugStack() WrapOption
  • func WithAnalytics(on bool) WrapOption
  • func WithAnalyticsRate(rate float64) WrapOption
  • func WithCustomTag(key string, value interface{}) WrapOption
  • func WithErrorCheck(fn func(err error) bool) WrapOption
  • func WithResourceName(name string) WrapOption
  • func WithServiceName(name string) WrapOption
  • func WithTraceBatch(enabled bool) WrapOption
  • func WithTraceConnect(enabled bool) WrapOption
  • func WithTraceQuery(enabled bool) WrapOption

Examples

• CreateTracedSession
• NewCluster
• NewObserver

Functions

func CreateTracedSession

func CreateTracedSession(cluster *gocql.ClusterConfig, opts ...WrapOption) (*gocql.Session, error)

CreateTracedSession returns a new session augmented with tracing.

Example

Types

type Batch

type Batch struct {
	*gocql.Batch
	// contains filtered or unexported fields
}

Batch inherits from gocql.Batch, it keeps the tracer and the context.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func WrapBatch

func WrapBatch(b *gocql.Batch, opts ...WrapOption) *Batch

WrapBatch wraps a gocql.Batch into a traced Batch under the given service name. Note that the returned Batch structure embeds the original gocql.Batch structure. This means that any method returning the batch for chaining that is not part of this package's Batch structure should be called before WrapBatch, otherwise the tracing context could be lost.

To be more specific: it is ok (and recommended) to use and chain the return value of `WithContext` and `WithTimestamp` but not that of `SerialConsistency`, `Trace`, `Observer`, etc.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func (*Batch) ExecuteBatch

func (tb *Batch) ExecuteBatch(session *gocql.Session) error

ExecuteBatch calls session.ExecuteBatch on the Batch, tracing the execution.

func (*Batch) WithContext

func (tb *Batch) WithContext(ctx context.Context) *Batch

WithContext adds the specified context to the traced Batch structure.

func (*Batch) WithTimestamp

func (tb *Batch) WithTimestamp(timestamp int64) *Batch

WithTimestamp will enable the with default timestamp flag on the query like DefaultTimestamp does. But also allows to define value for timestamp. It works the same way as USING TIMESTAMP in the query itself, but should not break prepared query optimization.

func (*Batch) WithWrapOptions

func (tb *Batch) WithWrapOptions(opts ...WrapOption) *Batch

WithWrapOptions applies the given set of options to the batch.

type ClusterConfig

type ClusterConfig struct {
	*gocql.ClusterConfig
	// contains filtered or unexported fields
}

ClusterConfig embeds gocql.ClusterConfig and keeps information relevant to tracing.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func NewCluster

func NewCluster(hosts []string, opts ...WrapOption) *ClusterConfig

NewCluster calls gocql.NewCluster and returns a wrapped instrumented version of it.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

Example

func (*ClusterConfig) CreateSession

func (c *ClusterConfig) CreateSession() (*Session, error)

CreateSession calls the underlying gocql.ClusterConfig's CreateSession method and returns a new Session augmented with tracing.

type Iter

type Iter struct {
	*gocql.Iter
	// contains filtered or unexported fields
}

Iter inherits from gocql.Iter and contains a span.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func (*Iter) Close

func (tIter *Iter) Close() error

Close closes the Iter and finish the span created on Iter call.

func (*Iter) Scanner

func (tIter *Iter) Scanner() gocql.Scanner

Scanner returns a row Scanner which provides an interface to scan rows in a manner which is similar to database/sql. The Iter should NOT be used again after calling this method.

type Observer

type Observer struct {
	// contains filtered or unexported fields
}

Observer implements gocql observer interfaces to support tracing.

func NewObserver

func NewObserver(cluster *gocql.ClusterConfig, opts ...WrapOption) *Observer

NewObserver creates a new Observer to trace gocql. This method is useful in case you want to attach the observer to individual traces / batches instead of instrumenting the whole client.

Example

func (*Observer) ObserveBatch

func (o *Observer) ObserveBatch(ctx context.Context, batch gocql.ObservedBatch)

ObserveBatch implements gocql.BatchObserver.

func (*Observer) ObserveConnect

func (o *Observer) ObserveConnect(connect gocql.ObservedConnect)

ObserveConnect implements gocql.ConnectObserver.

func (*Observer) ObserveQuery

func (o *Observer) ObserveQuery(ctx context.Context, query gocql.ObservedQuery)

ObserveQuery implements gocql.QueryObserver.

type Query

type Query struct {
	*gocql.Query
	// contains filtered or unexported fields
}

Query inherits from gocql.Query, it keeps the tracer and the context.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func WrapQuery

func WrapQuery(q *gocql.Query, opts ...WrapOption) *Query

WrapQuery wraps a gocql.Query into a traced Query under the given service name. Note that the returned Query structure embeds the original gocql.Query structure. This means that any method returning the query for chaining that is not part of this package's Query structure should be called before WrapQuery, otherwise the tracing context could be lost.

To be more specific: it is ok (and recommended) to use and chain the return value of `WithContext` and `PageState` but not that of `Consistency`, `Trace`, `Observer`, etc.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func (*Query) Exec

func (tq *Query) Exec() error

Exec is rewritten so that it passes by our custom Iter

func (*Query) Iter

func (tq *Query) Iter() *Iter

Iter starts a new span at query.Iter call.

func (*Query) MapScan

func (tq *Query) MapScan(m map[string]interface{}) error

MapScan wraps in a span query.MapScan call.

func (*Query) MapScanCAS

func (tq *Query) MapScanCAS(m map[string]interface{}) (applied bool, err error)

MapScanCAS wraps in a span query.MapScanCAS call.

func (*Query) PageState

func (tq *Query) PageState(state []byte) *Query

PageState rewrites the original function so that spans are aware of the change.

func (*Query) Scan

func (tq *Query) Scan(dest ...interface{}) error

Scan wraps in a span query.Scan call.

func (*Query) ScanCAS

func (tq *Query) ScanCAS(dest ...interface{}) (applied bool, err error)

ScanCAS wraps in a span query.ScanCAS call.

func (*Query) WithContext

func (tq *Query) WithContext(ctx context.Context) *Query

WithContext adds the specified context to the traced Query structure.

func (*Query) WithWrapOptions

func (tq *Query) WithWrapOptions(opts ...WrapOption) *Query

WithWrapOptions applies the given set of options to the query.

type Scanner

type Scanner struct {
	gocql.Scanner
	// contains filtered or unexported fields
}

Scanner inherits from a gocql.Scanner derived from an Iter.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func (*Scanner) Err

func (s *Scanner) Err() error

Err calls the wrapped Scanner.Err, releasing the Scanner resources and closing the span.

type Session

type Session struct {
	*gocql.Session
	// contains filtered or unexported fields
}

Session embeds gocql.Session and keeps information relevant to tracing.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func (*Session) NewBatch

func (s *Session) NewBatch(typ gocql.BatchType) *Batch

NewBatch calls the underlying gocql.Session's NewBatch method and returns a new Batch augmented with tracing.

Deprecated: use the Observer based method CreateTracedSession instead, which allows to use native gocql types instead of wrapped types.

func (*Session) Query

func (s *Session) Query(stmt string, values ...interface{}) *Query

Query calls the underlying gocql.Session's Query method and returns a new Query augmented with tracing.

type WrapOption

type WrapOption func(*config)

WrapOption represents an option that can be passed to WrapQuery.

func NoDebugStack

func NoDebugStack() WrapOption

NoDebugStack prevents stack traces from being attached to spans finishing with an error. This is useful in situations where errors are frequent and performance is critical.

func WithAnalytics

func WithAnalytics(on bool) WrapOption

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate

func WithAnalyticsRate(rate float64) WrapOption

WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.

func WithCustomTag

func WithCustomTag(key string, value interface{}) WrapOption

WithCustomTag will attach the value to the span tagged by the key.

func WithErrorCheck

func WithErrorCheck(fn func(err error) bool) WrapOption

WithErrorCheck specifies a function fn which determines whether the passed error should be marked as an error. The fn is called whenever a CQL request finishes with an error.

func WithResourceName

func WithResourceName(name string) WrapOption

WithResourceName sets a custom resource name to be used with the traced query. By default, the query statement is extracted automatically. This method should be used when a different resource name is desired or in performance critical environments. The gocql library returns the query statement using an fmt.Sprintf call, which can be costly when called repeatedly. Using WithResourceName will avoid that call. Under normal circumstances, it is safe to rely on the default.

func WithServiceName

func WithServiceName(name string) WrapOption

WithServiceName sets the given service name for the returned query.

func WithTraceBatch

func WithTraceBatch(enabled bool) WrapOption

WithTraceBatch will enable tracing for batches (default is true). This option only takes effect in CreateTracedSession and NewObserver.

func WithTraceConnect

func WithTraceConnect(enabled bool) WrapOption

WithTraceConnect will enable tracing for connections (default is true). This option only takes effect in CreateTracedSession and NewObserver.

func WithTraceQuery

func WithTraceQuery(enabled bool) WrapOption

WithTraceQuery will enable tracing for queries (default is true). This option only takes effect in CreateTracedSession and NewObserver.