tracing

Documentation

Overview

Package tracing provides helpers for dealing with Open Tracing and Distributed Tracing.

Index

• Constants
• func HelpMessage(defaultName string) string
• type JaegerConfig
• type TracedBCrypt
  • func (b *TracedBCrypt) Compare(ctx context.Context, hash, data []byte) error
  • func (b *TracedBCrypt) Hash(ctx context.Context, data []byte) ([]byte, error)
• type Tracer
  • func (t *Tracer) Close()
  • func (t *Tracer) IsLoaded() bool
  • func (t *Tracer) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
  • func (t *Tracer) Setup() error

Constants

const (
	// BCryptHashOpName is the operation name for bcrypt hashing operations.
	BCryptHashOpName = "bcrypt.hash"

	// BCryptCompareOpName is the operation name for bcrypt comparation operations.
	BCryptCompareOpName = "bcrypt.compare"

	// BCryptWorkFactorTagName is the operation name for bcrypt workfactor settings.
	BCryptWorkFactorTagName = "bcrypt.workfactor"
)

Functions

func HelpMessage

func HelpMessage(defaultName string) string

HelpMessage returns a help message for CLIs using tracing.

Types

type JaegerConfig

type JaegerConfig struct {
	LocalAgentHostPort string
	SamplerType        string
	SamplerValue       float64
	SamplerServerURL   string
	Propagation        string
}

JaegerConfig encapsulates jaeger's configuration.

type TracedBCrypt

type TracedBCrypt struct {
	WorkFactor int
}

TracedBCrypt implements the Hasher interface.

func (*TracedBCrypt) Compare

func (b *TracedBCrypt) Compare(ctx context.Context, hash, data []byte) error

Compare returns nil if hash and data match.

func (*TracedBCrypt) Hash

func (b *TracedBCrypt) Hash(ctx context.Context, data []byte) ([]byte, error)

Hash returns the hashed string or an error.

type Tracer

type Tracer struct {
	ServiceName  string
	Provider     string
	Logger       logrus.FieldLogger
	JaegerConfig *JaegerConfig
	// contains filtered or unexported fields
}

Tracer encapsulates tracing abilities.

func (*Tracer) Close

func (t *Tracer) Close()

Close closes the tracer.

func (*Tracer) IsLoaded

func (t *Tracer) IsLoaded() bool

IsLoaded returns true if the tracer has been loaded.

func (*Tracer) ServeHTTP

func (t *Tracer) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

func (*Tracer) Setup

func (t *Tracer) Setup() error

Setup sets up the tracer. Currently supports jaeger.