highlight

README

highlight-go

Official implementation of the Highlight backend client in Go.

Documentation

Index

• Constants
• Variables
• func ConsumeError(ctx context.Context, errorInput interface{}, tags ...string) error
• func InterceptRequest(r *http.Request) context.Context
• func InterceptRequestWithContext(ctx context.Context, r *http.Request) context.Context
• func SetFlushInterval(newFlushInterval int)
• func SetGraphqlClientAddress(newGraphqlClientAddress string)
• func Start()
• func StartWithContext(ctx context.Context)
• func Stop()
• type BackendErrorObjectInput
• type Requester

Constants

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

Variables

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

Functions

func ConsumeError

func ConsumeError(ctx context.Context, errorInput interface{}, tags ...string) error

ConsumeError adds an error to the queue of errors to be sent to our backend. the provided context must have the injected highlight keys from InterceptRequestWithContext.

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 SetFlushInterval

func SetFlushInterval(newFlushInterval int)

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

func SetGraphqlClientAddress

func SetGraphqlClientAddress(newGraphqlClientAddress string)

SetGraphqlClientAddress allows you to override the graphql client address, in case you are running Highlight on-prem, and need to point to your on-prem instance.

func Start

func Start()

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

func StartWithContext

func StartWithContext(ctx context.Context)

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 sends an interrupt signal to the main process, closing the channels and returning the goroutines.

Types

type BackendErrorObjectInput

type BackendErrorObjectInput struct {
	SessionSecureID graphql.String  `json:"session_secure_id"`
	RequestID       graphql.String  `json:"request_id"`
	Event           graphql.String  `json:"event"`
	Type            graphql.String  `json:"type"`
	URL             graphql.String  `json:"url"`
	Source          graphql.String  `json:"source"`
	StackTrace      graphql.String  `json:"stackTrace"`
	Timestamp       time.Time       `json:"timestamp"`
	Payload         *graphql.String `json:"payload"`
}

type Requester

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

Requester is used for making graphql requests in testing, a mock requester with an overwritten trigger function may be used