sentrytemporal

package module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 13, 2022 License: MIT Imports: 7 Imported by: 0

README

Sentry Temporal Interceptor

The temporal interceptor captures panic and errors and report them to sentry server.

Installation

go get github.com/sdcxtech/sentrytemporal
	// The client and worker are heavyweight objects that should be created once per process.
	c, err := client.Dial(client.Options{})
	if err != nil {
		log.Fatalln("Unable to create client", err)
	}
	defer c.Close()

	w := worker.New(c, "taskQueue", worker.Options{
		// Create interceptor that will put started time on the logger
		Interceptors: []sdkinterceptor.WorkerInterceptor{
			sentrytemp.New(
				sentry.CurrentHub(),
				sentrytemp.Options{},
			),
		},
	})

Configuration

New accepts a struct of Options that allows you to configure how the inteceptor will behave.

type Options struct {
	// ActivityErrorSkipper configures a function to determine if an error from activity should be skipped.
	ActivityErrorSkipper ActivityErrorSkipper
	// WorkflowErrorSkipper configures a function to determine if an error from workflow should be skipped.
	WorkflowErrorSkipper WorkflowErrorSkipper
}

type (
	ActivityErrorSkipper func(context.Context, error) bool
	WorkflowErrorSkipper func(workflow.Context, error) bool
)

Example:

Only report retrieable error when attempt count is great then 1.

activityErrorSkipper := func(ctx context.Context, err error) bool {
	var errApp *temporal.ApplicationError
	if errors.As(err, &errApp) {
		if errApp.NonRetryable() {
			return false
		}

		info := activity.GetInfo(ctx)

		return !(info.Attempt > 1)
	}

	return false
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

New creates a worker interceptor which will report error to sentry.

Types

type ActivityErrorSkipper added in v0.3.0

type ActivityErrorSkipper func(context.Context, error) bool

type Options

type Options struct {
	// ActivityErrorSkipper configures a function to determine if an error from activity should be skipped.
	ActivityErrorSkipper ActivityErrorSkipper
	// WorkflowErrorSkipper configures a function to determine if an error from workflow should be skipped.
	WorkflowErrorSkipper WorkflowErrorSkipper
}

type WorkflowErrorSkipper added in v0.3.0

type WorkflowErrorSkipper func(workflow.Context, error) bool

Directories

Path Synopsis
tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL