api

package

Go to main page

Versions in this module

v0

v0.2.13

Apr 11, 2026

v0.2.12

Apr 10, 2026

v0.2.11

Apr 7, 2026

v0.2.10

Apr 1, 2026

Changes in this version

+ const DriftQueryAPIPath

type TuskClient

+ func (c *TuskClient) AggregateDriftSpans(ctx context.Context, input *driftquery.AggregateSpansInput, auth AuthOptions) (json.RawMessage, error)

+ func (c *TuskClient) GetDriftSchema(ctx context.Context, input *driftquery.GetSchemaInput, auth AuthOptions) (json.RawMessage, error)

+ func (c *TuskClient) GetDriftSpansByIds(ctx context.Context, input *driftquery.GetSpansByIdsInput, auth AuthOptions) (json.RawMessage, error)

+ func (c *TuskClient) GetDriftTrace(ctx context.Context, input *driftquery.GetTraceInput, auth AuthOptions) (json.RawMessage, error)

+ func (c *TuskClient) ListDriftDistinctValues(ctx context.Context, input *driftquery.ListDistinctValuesInput, ...) (json.RawMessage, error)

+ func (c *TuskClient) ListDriftServices(ctx context.Context, auth AuthOptions) (json.RawMessage, error)

+ func (c *TuskClient) QueryDriftSpans(ctx context.Context, input *driftquery.QuerySpansInput, auth AuthOptions) (json.RawMessage, error)

v0.2.9

Mar 31, 2026

v0.2.8

Mar 30, 2026

v0.2.7

Mar 25, 2026

Changes in this version

type FetchAllTraceTestsOptions

+ StatusFilter *backend.TraceTestStatus

v0.2.6

Mar 24, 2026

Changes in this version

type TuskClient

+ func (c *TuskClient) RetryUnitTestRun(ctx context.Context, runID string, payload any, auth AuthOptions) (UnitTestRetryResult, error)

+ func (c *TuskClient) SubmitUnitTestFeedback(ctx context.Context, runID string, payload any, auth AuthOptions) (UnitTestFeedbackResult, error)

+ type UnitTestFeedbackResult map[string]any

+ type UnitTestRetryResult map[string]any

v0.2.5

Mar 23, 2026

Changes in this version

+ const ClientServiceAPIPath

+ const DefaultBaseURL

+ const DocsSetupURL

+ const SpanExportServiceAPIPath

+ const TestRunServiceAPIPath

+ 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 FetchAllTraceTests(ctx context.Context, client *TuskClient, auth AuthOptions, serviceID string, ...) ([]*backend.TraceTest, error)

+ func FetchAllTraceTestsWithCache(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)

+ 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 GetBaseURL() string

+ func IsSkippableError(err error) bool

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

+ func UserEmail(user *backend.UserAuthInfo) string

+ type ApiError struct

+ Message string

+ RawBody string

+ StatusCode int

+ func (e *ApiError) Error() string

+ 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 FetchAllTraceTestsOptions struct

+ Message string

+ PageSize int32

+ 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 RetryConfig struct

+ BaseBackoff time.Duration

+ JitterMax float64

+ JitterMin float64

+ MaxBackoff time.Duration

+ MaxRetries int

+ func DefaultRetryConfig(maxRetries int) RetryConfig

+ func FastRetryConfig(maxRetries int) RetryConfig

+ type SkippableError struct

+ Code string

+ Message string

+ func (e *SkippableError) Error() string

+ 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) CreateApiKey(ctx context.Context, in *backend.CreateApiKeyRequest, auth AuthOptions) (*backend.CreateApiKeyResponse, error)

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

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

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

+ 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) GetAllTraceTests(ctx context.Context, in *backend.GetAllTraceTestsRequest, auth AuthOptions) (*backend.GetAllTraceTestsResponseSuccess, error)

+ func (c *TuskClient) GetAuthInfo(ctx context.Context, in *backend.GetAuthInfoRequest, auth AuthOptions) (*backend.GetAuthInfoResponse, 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) GetGlobalSpansByIds(ctx context.Context, in *backend.GetGlobalSpansByIdsRequest, auth AuthOptions) (*backend.GetGlobalSpansByIdsResponseSuccess, error)

+ func (c *TuskClient) GetLatestUnitTestRun(ctx context.Context, repo string, branch string, auth AuthOptions) (UnitTestRunSummary, error)

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

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

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

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

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

+ func (c *TuskClient) GetUnitTestRun(ctx context.Context, runID string, auth AuthOptions) (UnitTestRunDetails, error)

+ func (c *TuskClient) GetUnitTestRunFiles(ctx context.Context, runID string, auth AuthOptions) (UnitTestRunFiles, error)

+ func (c *TuskClient) GetUnitTestScenario(ctx context.Context, runID string, scenarioID string, auth AuthOptions) (UnitTestScenarioDetails, error)

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

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

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

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

+ type UnitTestRunDetails map[string]any

+ type UnitTestRunFiles map[string]any

+ type UnitTestRunSummary map[string]any

+ type UnitTestScenarioDetails map[string]any

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