highlight

README

highlight-go

Official implementation of the Highlight backend client in Go.

Usage

First, import the package

go get -u github.com/highlight/highlight/sdk/highlight-go

Then, add the following lines to your applications main function:

import (
	"github.com/highlight/highlight/sdk/highlight-go"
)

func main() {
	//...application logic...
	highlight.Start()
	defer highlight.Stop()
	//...application logic...
}

Then, use a highlight middleware in your apps router:

if you're using go-chi/chi:

import (
	highlightChi "github.com/highlight/highlight/sdk/highlight-go/middleware/chi"
)

func main() {
	//...
	r := chi.NewMux()
	r.Use(highlightChi.Middleware)
	//...
}

if you're using gin-gonic/gin:

import (
	highlightGin "github.com/highlight/highlight/sdk/highlight-go/middleware/gin"
)

func main() {
	//...
	r := gin.New()
	r.Use(highlightGin.Middleware())
	//...
}

Finally, it's time to consume errors. Add the following line to your error handling:

func someEndpoint() {
	err := someFuntionCall()
	if err != nil {
		highlight.ConsumeError(err)
		// including optional tags:
		highlight.ConsumeError(err, "environment:dev", "important")
	}
}

Documentation

Index

• Constants
• Variables
• func EndTrace(span trace.Span)
• func GetProjectID() string
• func GraphQLErrorPresenter(service string) func(ctx context.Context, e error) *gqlerror.Error
• func GraphQLRecoverFunc() graphql.RecoverFunc
• func InterceptRequest(r *http.Request) context.Context
• func InterceptRequestWithContext(ctx context.Context, r *http.Request) context.Context
• func IsRunning() bool
• func RecordError(ctx context.Context, err error, tags ...attribute.KeyValue) context.Context
• func RecordMetric(ctx context.Context, name string, value float64, tags ...attribute.KeyValue)
• func RecordSpanError(span trace.Span, err error, tags ...attribute.KeyValue)
• func RecordSpanErrorWithStack(span trace.Span, err ErrorWithStack)
• func SetDebugMode(l Logger)
• func SetFlushInterval(_ time.Duration)
• func SetOTLPEndpoint(newOtlpEndpoint string)
• func SetProjectID(id string)
• func Start(opts ...Option)
• func StartTrace(ctx context.Context, name string, tags ...attribute.KeyValue) (trace.Span, context.Context)
• func StartTraceWithTimestamp(ctx context.Context, name string, t time.Time, tags ...attribute.KeyValue) (trace.Span, context.Context)
• func StartTraceWithoutResourceAttributes(ctx context.Context, name string, tags ...attribute.KeyValue) (trace.Span, context.Context)
• func StartWithContext(ctx context.Context, opts ...Option)
• func Stop()
• type ErrorWithStack
• type GraphqlTracer
  • func NewGraphqlTracer(graphName string) GraphqlTracer
• type Logger
• type OTLP
  • func StartOTLP() (*OTLP, error)
• type Option
  • func WithServiceName(serviceName string) Option
  • func WithServiceVersion(serviceVersion string) Option
• type TraceType
• type Tracer
  • func (t Tracer) ExtensionName() string
  • func (t Tracer) InterceptField(ctx context.Context, next graphql.Resolver) (interface{}, error)
  • func (t Tracer) InterceptResponse(ctx context.Context, next graphql.ResponseHandler) *graphql.Response
  • func (t Tracer) Validate(graphql.ExecutableSchema) error
  • func (t Tracer) WithRequestFieldLogging() GraphqlTracer

Constants

const (
	Highlight       contextKey = "highlight"
	RequestID                  = Highlight + "RequestID"
	SessionSecureID            = Highlight + "SessionSecureID"
)

const DeprecatedProjectIDAttribute = "highlight_project_id"

const DeprecatedRequestIDAttribute = "highlight_trace_id"

const DeprecatedSessionIDAttribute = "highlight_session_id"

const DeprecatedSourceAttribute = "Source"

const ErrorURLAttribute = "URL"

const LogEvent = "log"

const LogMessageAttribute = "log.message"

const LogSeverityAttribute = "log.severity"

const MetricEvent = "metric"

const MetricEventName = "metric.name"

const MetricEventValue = "metric.value"

const OTLPDefaultEndpoint = "https://otel.highlight.io:4318"

const ProjectIDAttribute = "highlight.project_id"

const RequestIDAttribute = "highlight.trace_id"

const SessionIDAttribute = "highlight.session_id"

const SourceAttribute = "highlight.source"

const TraceTypeAttribute = "highlight.type"

Variables

var (
	ContextKeys = struct {
		RequestID       contextKey
		SessionSecureID contextKey
	}{
		RequestID:       RequestID,
		SessionSecureID: SessionSecureID,
	}
)

Functions

func EndTrace

func EndTrace(span trace.Span)

func GetProjectID

func GetProjectID() string

func GraphQLErrorPresenter

func GraphQLErrorPresenter(service string) func(ctx context.Context, e error) *gqlerror.Error

func GraphQLRecoverFunc

func GraphQLRecoverFunc() graphql.RecoverFunc

func InterceptRequest

func InterceptRequest(r *http.Request) context.Context

InterceptRequest calls InterceptRequestWithContext using the request object's context

func InterceptRequestWithContext

func InterceptRequestWithContext(ctx context.Context, r *http.Request) context.Context

InterceptRequestWithContext captures the highlight session and request ID for a particular request from the request headers, adding the values to the provided context.

func IsRunning

func IsRunning() bool

func RecordError

func RecordError(ctx context.Context, err error, tags ...attribute.KeyValue) context.Context

RecordError processes `err` to be recorded as a part of the session or network request. Highlight session and trace are inferred from the context. If no sessionID is set, then the error is associated with the project without a session context.

func RecordMetric

func RecordMetric(ctx context.Context, name string, value float64, tags ...attribute.KeyValue)

RecordMetric is used to record arbitrary metrics in your golang backend. Highlight will process these metrics in the context of your session and expose them through dashboards. For example, you may want to record the latency of a DB query as a metric that you would like to graph and monitor. You'll be able to view the metric in the context of the session and network request and recorded it.

func RecordSpanError

func RecordSpanError(span trace.Span, err error, tags ...attribute.KeyValue)

func RecordSpanErrorWithStack

func RecordSpanErrorWithStack(span trace.Span, err ErrorWithStack)

func SetDebugMode

func SetDebugMode(l Logger)

func SetFlushInterval

func SetFlushInterval(_ time.Duration)

SetFlushInterval allows you to override the amount of time in which the Highlight client will collect errors before sending them to our backend. - newFlushInterval is an integer representing seconds Deprecated - this is managed by the opentelemetry SDK.

func SetOTLPEndpoint

func SetOTLPEndpoint(newOtlpEndpoint string)

SetOTLPEndpoint allows you to override the otlp address used for sending errors and traces. Use the root http url. Eg: https://otel.highlight.io:4318

func SetProjectID

func SetProjectID(id string)

func Start

func Start(opts ...Option)

Start is used to start the Highlight client's collection service.

func StartTrace

func StartTrace(ctx context.Context, name string, tags ...attribute.KeyValue) (trace.Span, context.Context)

func StartTraceWithTimestamp

func StartTraceWithTimestamp(ctx context.Context, name string, t time.Time, tags ...attribute.KeyValue) (trace.Span, context.Context)

func StartTraceWithoutResourceAttributes

func StartTraceWithoutResourceAttributes(ctx context.Context, name string, tags ...attribute.KeyValue) (trace.Span, context.Context)

func StartWithContext

func StartWithContext(ctx context.Context, opts ...Option)

StartWithContext is used to start the Highlight client's collection service, but allows the user to pass in their own context.Context. This allows the user kill the highlight worker by canceling their context.CancelFunc.

func Stop

func Stop()

Stop flushes and shuts down the SDK.

Types

type ErrorWithStack

type ErrorWithStack interface {
	Error() string
	StackTrace() errors.StackTrace
}

type GraphqlTracer

type GraphqlTracer interface {
	graphql.HandlerExtension
	graphql.ResponseInterceptor
	graphql.FieldInterceptor
	WithRequestFieldLogging() GraphqlTracer
}

func NewGraphqlTracer

func NewGraphqlTracer(graphName string) GraphqlTracer

type Logger

type Logger interface {
	Error(v ...interface{})
	Errorf(format string, v ...interface{})
}

Logger is an interface that implements Log and Logf

type OTLP

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

func StartOTLP

func StartOTLP() (*OTLP, error)

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithServiceName

func WithServiceName(serviceName string) Option

func WithServiceVersion

func WithServiceVersion(serviceVersion string) Option

type TraceType

type TraceType string

const TraceTypeHighlightInternal TraceType = "highlight.internal"

const TraceTypeNetworkRequest TraceType = "http.request"

type Tracer

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

func (Tracer) ExtensionName

func (t Tracer) ExtensionName() string

func (Tracer) InterceptField

func (t Tracer) InterceptField(ctx context.Context, next graphql.Resolver) (interface{}, error)

InterceptField instruments timing of individual fields resolved.

func (Tracer) InterceptResponse

func (t Tracer) InterceptResponse(ctx context.Context, next graphql.ResponseHandler) *graphql.Response

InterceptResponse instruments timing, payload size, and error information of the response handler. The metric is grouped by the corresponding operation name.

func (Tracer) Validate

func (t Tracer) Validate(graphql.ExecutableSchema) error

func (Tracer) WithRequestFieldLogging

func (t Tracer) WithRequestFieldLogging() GraphqlTracer

WithRequestFieldLogging configures the tracer to log each graphql operation.