api

Feb 11, 2026

Changes in this version

+ func UserEmail(user *backend.UserAuthInfo) string

Feb 4, 2026

Changes in this version

+ var ErrFetchGlobalSpanIDs = errors.New("unable to fetch global span IDs from Tusk Cloud and no cache available")

+ var ErrFetchGlobalSpans = errors.New("unable to fetch global spans from Tusk Cloud")

+ var ErrFetchNewGlobalSpans = errors.New("unable to fetch new global spans from Tusk Cloud")

+ var ErrFetchNewPreAppStartSpans = errors.New("unable to fetch new pre-app-start spans from Tusk Cloud")

+ var ErrFetchNewTraceTests = errors.New("unable to fetch new tests from Tusk Cloud")

+ var ErrFetchPreAppStartSpanIDs = errors.New(...)

+ var ErrFetchPreAppStartSpans = errors.New("unable to fetch pre-app-start spans from Tusk Cloud")

+ var ErrFetchTraceTestIDs = errors.New("unable to fetch test IDs from Tusk Cloud and no cache available")

+ var ErrFetchTraceTests = errors.New("unable to fetch tests from Tusk Cloud")

+ func FetchAllGlobalSpans(ctx context.Context, client *TuskClient, auth AuthOptions, serviceID string) ([]*core.Span, error)

+ func FetchAllPreAppStartSpans(ctx context.Context, client *TuskClient, auth AuthOptions, serviceID string) ([]*core.Span, error)

+ func FetchAllTraceTestsWithCache(ctx context.Context, client *TuskClient, auth AuthOptions, serviceID string, ...) ([]*backend.TraceTest, error)

+ func FetchGlobalSpansWithCache(ctx context.Context, client *TuskClient, auth AuthOptions, serviceID string, ...) ([]*core.Span, error)

+ func FetchPreAppStartSpansWithCache(ctx context.Context, client *TuskClient, auth AuthOptions, serviceID string, ...) ([]*core.Span, error)

+ func IsPausedByLabelError(err error) bool

+ type PausedByLabelError struct

+ Message string

+ func (e *PausedByLabelError) Error() string

type TuskClient

+ func (c *TuskClient) GetAllGlobalSpanIds(ctx context.Context, in *backend.GetAllGlobalSpanIdsRequest, auth AuthOptions) (*backend.GetAllGlobalSpanIdsResponseSuccess, error)

+ func (c *TuskClient) GetAllPreAppStartSpanIds(ctx context.Context, in *backend.GetAllPreAppStartSpanIdsRequest, ...) (*backend.GetAllPreAppStartSpanIdsResponseSuccess, error)

+ func (c *TuskClient) GetAllTraceTestIds(ctx context.Context, in *backend.GetAllTraceTestIdsRequest, auth AuthOptions) (*backend.GetAllTraceTestIdsResponseSuccess, error)

+ func (c *TuskClient) GetGlobalSpansByIds(ctx context.Context, in *backend.GetGlobalSpansByIdsRequest, auth AuthOptions) (*backend.GetGlobalSpansByIdsResponseSuccess, error)

+ func (c *TuskClient) GetPreAppStartSpansByIds(ctx context.Context, in *backend.GetPreAppStartSpansByIdsRequest, ...) (*backend.GetPreAppStartSpansByIdsResponseSuccess, error)

+ func (c *TuskClient) GetTraceTestsByIds(ctx context.Context, in *backend.GetTraceTestsByIdsRequest, auth AuthOptions) (*backend.GetTraceTestsByIdsResponseSuccess, error)

Jan 28, 2026

Changes in this version

+ func IsNoSeatError(err error) bool

+ type NoSeatError struct

+ Message string

+ func (e *NoSeatError) Error() string

Jan 28, 2026

Changes in this version

+ const SpanExportServiceAPIPath

type TuskClient

+ func (c *TuskClient) ExportSpans(ctx context.Context, in *backend.ExportSpansRequest, auth AuthOptions) (*backend.ExportSpansResponse, error)

Jan 26, 2026

Changes in this version

+ func FetchAllTraceTests(ctx context.Context, client *TuskClient, auth AuthOptions, serviceID string, ...) ([]*backend.TraceTest, error)

+ func FetchDriftRunTraceTests(ctx context.Context, client *TuskClient, auth AuthOptions, driftRunID string, ...) ([]*backend.TraceTest, error)

+ type FetchAllTraceTestsOptions struct

+ Message string

+ PageSize int32

Dec 30, 2025

Changes in this version

type TuskClient

+ func (c *TuskClient) GetObservableServiceInfo(ctx context.Context, in *backend.GetObservableServiceInfoRequest, ...) (*backend.GetObservableServiceInfoResponseSuccess, error)

+ func (c *TuskClient) GetValidationTraceTests(ctx context.Context, in *backend.GetValidationTraceTestsRequest, ...) (*backend.GetValidationTraceTestsResponseSuccess, error)

Dec 1, 2025

Changes in this version

+ const DefaultBaseURL

+ func GetBaseURL() string

Nov 11, 2025

Changes in this version

+ const ClientServiceAPIPath

type TuskClient

+ func (c *TuskClient) CreateApiKey(ctx context.Context, in *backend.CreateApiKeyRequest, auth AuthOptions) (*backend.CreateApiKeyResponse, error)

+ func (c *TuskClient) CreateObservableService(ctx context.Context, in *backend.CreateObservableServiceRequest, ...) (*backend.CreateObservableServiceResponse, error)

+ func (c *TuskClient) VerifyRepoAccess(ctx context.Context, in *backend.VerifyRepoAccessRequest, auth AuthOptions) (*backend.VerifyRepoAccessResponse, error)

Nov 5, 2025

Changes in this version

type TuskClient

+ func (c *TuskClient) GetAuthInfo(ctx context.Context, in *backend.GetAuthInfoRequest, auth AuthOptions) (*backend.GetAuthInfoResponse, error)

Oct 29, 2025

Changes in this version

+ type RetryConfig struct

+ BaseBackoff time.Duration

+ JitterMax float64

+ JitterMin float64

+ MaxBackoff time.Duration

+ MaxRetries int

+ func DefaultRetryConfig(maxRetries int) RetryConfig

+ func FastRetryConfig(maxRetries int) RetryConfig

Sep 29, 2025

Changes in this version

+ const TestRunServiceAPIPath

+ func SetupCloud(ctx context.Context, requireServiceID bool) (*TuskClient, AuthOptions, *config.Config, error)

+ type AuthOptions struct

+ APIKey string

+ BearerToken string

+ TuskClientID string

+ type Deviation struct

+ Actual any

+ Description string

+ Expected any

+ Field string

+ Severity string

+ Type string

+ type MockInteraction struct

+ Order int

+ Request RecordedRequest

+ Response RecordedResponse

+ Service string

+ Timestamp time.Time

+ type RecordedRequest struct

+ Body any

+ Headers map[string][]string

+ Method string

+ Path string

+ Query map[string][]string

+ type RecordedResponse struct

+ Body any

+ Headers map[string][]string

+ Status int

+ type TestRecording struct

+ ID string

+ Metadata map[string]any

+ Method string

+ Mocks []MockInteraction

+ Path string

+ Request RecordedRequest

+ Response RecordedResponse

+ ServiceID string

+ Timestamp time.Time

+ TraceID string

+ type TestResult struct

+ Deviations []Deviation

+ Duration int

+ Environment string

+ Error string

+ ExecutedAt time.Time

+ Passed bool

+ ServiceID string

+ TestID string

+ type TuskClient struct

+ func NewClient(baseURL, apiKey string) *TuskClient

+ func (c *TuskClient) CreateDriftRun(ctx context.Context, in *backend.CreateDriftRunRequest, auth AuthOptions) (string, error)

+ func (c *TuskClient) GetAllTraceTests(ctx context.Context, in *backend.GetAllTraceTestsRequest, auth AuthOptions) (*backend.GetAllTraceTestsResponseSuccess, error)

+ func (c *TuskClient) GetDriftRunTraceTests(ctx context.Context, in *backend.GetDriftRunTraceTestsRequest, ...) (*backend.GetDriftRunTraceTestsResponseSuccess, error)

+ func (c *TuskClient) GetGlobalSpans(ctx context.Context, in *backend.GetGlobalSpansRequest, auth AuthOptions) (*backend.GetGlobalSpansResponseSuccess, error)

+ func (c *TuskClient) GetPreAppStartSpans(ctx context.Context, in *backend.GetPreAppStartSpansRequest, auth AuthOptions) (*backend.GetPreAppStartSpansResponseSuccess, error)

+ func (c *TuskClient) GetTest(testID string) (*TestRecording, error)

+ func (c *TuskClient) GetTests(serviceID string) ([]TestRecording, error)

+ func (c *TuskClient) GetTraceTest(ctx context.Context, in *backend.GetTraceTestRequest, auth AuthOptions) (*backend.GetTraceTestResponseSuccess, error)

+ func (c *TuskClient) UpdateDriftRunCIStatus(ctx context.Context, in *backend.UpdateDriftRunCIStatusRequest, ...) error

+ func (c *TuskClient) UploadResults(results []TestResult) error

+ func (c *TuskClient) UploadTraceTestResults(ctx context.Context, in *backend.UploadTraceTestResultsRequest, ...) error