spanutils

README

spanutils

import "github.com/carousell/Orion/utils/spanutils"

• Overview
• Imported Packages
• Index

Overview

Imported Packages

• github.com/carousell/Orion/utils
• github.com/carousell/Orion/utils/log
• github.com/newrelic/go-agent
• github.com/opentracing/opentracing-go
• github.com/opentracing/opentracing-go/ext
• go.elastic.co/apm
• google.golang.org/grpc/metadata

Index

• func ClientSpan(operationName string, ctx context.Context) (context.Context, opentracing.Span)
• func GRPCTracingSpan(operationName string, ctx context.Context) context.Context
• type TracingSpan
  • func NewDatastoreSpan(ctx context.Context, name string, datastore string) (TracingSpan, context.Context)
  • func NewExternalSpan(ctx context.Context, name string, url string) (TracingSpan, context.Context)
  • func NewHTTPExternalSpan(ctx context.Context, name string, url string, hdr http.Header) (TracingSpan, context.Context)
  • func NewInternalSpan(ctx context.Context, name string) (TracingSpan, context.Context)

Package files

spanutils.go

func ClientSpan

func ClientSpan(operationName string, ctx context.Context) (context.Context, opentracing.Span)

ClientSpan starts a new client span linked to the existing spans if any are found

func GRPCTracingSpan

func GRPCTracingSpan(operationName string, ctx context.Context) context.Context

type TracingSpan

type TracingSpan interface {
    End()
    Finish()
    SetTag(key string, value interface{})
    SetQuery(query string)
    SetError(msg string)
}

TracingSpan defines an interface for implementing a tracing span

func NewDatastoreSpan

func NewDatastoreSpan(ctx context.Context, name string, datastore string) (TracingSpan, context.Context)

NewDatastoreSpan starts a span for tracing data store actions

func NewExternalSpan

func NewExternalSpan(ctx context.Context, name string, url string) (TracingSpan, context.Context)

NewExternalSpan starts a span for tracing external actions

func NewHTTPExternalSpan

func NewHTTPExternalSpan(ctx context.Context, name string, url string, hdr http.Header) (TracingSpan, context.Context)

NewHTTPExternalSpan starts a span for tracing external HTTP actions

func NewInternalSpan

func NewInternalSpan(ctx context.Context, name string) (TracingSpan, context.Context)

NewInternalSpan starts a span for tracing internal actions

---

Generated by godoc2ghmd

Documentation

Index

• func ClientSpan(operationName string, ctx context.Context) (context.Context, opentracing.Span)
• func GRPCTracingSpan(operationName string, ctx context.Context) context.Context
• type TracingSpan
  • func NewDatastoreSpan(ctx context.Context, name string, datastore string) (TracingSpan, context.Context)
  • func NewExternalSpan(ctx context.Context, name string, url string) (TracingSpan, context.Context)
  • func NewHTTPExternalSpan(ctx context.Context, name string, url string, hdr http.Header) (TracingSpan, context.Context)
  • func NewInternalSpan(ctx context.Context, name string) (TracingSpan, context.Context)

Functions

func ClientSpan

func ClientSpan(operationName string, ctx context.Context) (context.Context, opentracing.Span)

ClientSpan starts a new client span linked to the existing spans if any are found

func GRPCTracingSpan

func GRPCTracingSpan(operationName string, ctx context.Context) context.Context

Types

type TracingSpan

type TracingSpan interface {
	End()
	Finish()
	SetTag(key string, value interface{})
	SetQuery(query string)
	SetError(msg string)
}

TracingSpan defines an interface for implementing a tracing span

func NewDatastoreSpan

func NewDatastoreSpan(ctx context.Context, name string, datastore string) (TracingSpan, context.Context)

NewDatastoreSpan starts a span for tracing data store actions

func NewExternalSpan

func NewExternalSpan(ctx context.Context, name string, url string) (TracingSpan, context.Context)

NewExternalSpan starts a span for tracing external actions

func NewHTTPExternalSpan

func NewHTTPExternalSpan(ctx context.Context, name string, url string, hdr http.Header) (TracingSpan, context.Context)

NewHTTPExternalSpan starts a span for tracing external HTTP actions

func NewInternalSpan

func NewInternalSpan(ctx context.Context, name string) (TracingSpan, context.Context)

NewInternalSpan starts a span for tracing internal actions