dash0

package module
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Jan 2, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

README

Dash0 Go API Client GoDoc

A Go client library for the Dash0 API.

Requirements

Go 1.25 or later.

Installation

go get github.com/dash0hq/dash0-api-client-go

Usage

package main

import (
    "context"
    "fmt"
    "log"

    "github.com/dash0hq/dash0-api-client-go"
)

func main() {
    // Create a new client
    client, err := dash0.NewClient(
        dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
        dash0.WithAuthToken("your-auth-token"),
    )
    if err != nil {
        log.Fatal(err)
    }

    // List dashboards in the "default" dataset
    dashboards, err := client.ListDashboards(context.Background(), dash0.String("default"))
    if err != nil {
        if dash0.IsUnauthorized(err) {
            log.Fatal("Invalid API token")
        }
        log.Fatal(err)
    }

    for _, d := range dashboards {
        fmt.Printf("Dashboard: %s (ID: %s)\n", d.Name, d.Id)
    }
}

Configuration Options

Option Description Default
WithApiUrl(url) Dash0 API URL (required) -
WithAuthToken(token) Auth token for authentication (required) -
WithMaxConcurrentRequests(n) Maximum concurrent API requests (1-10) 3
WithTimeout(duration) HTTP request timeout 30s
WithHTTPClient(client) Custom HTTP client -
WithUserAgent(ua) Custom User-Agent header dash0-api-client-go/1.0.0

Automatic Retries

The client automatically retries failed requests with exponential backoff:

  • Retried errors: 429 (rate limited) and 5xx (server errors)
  • Max retries: 3 attempts
  • Backoff: Exponential with jitter, starting at 500ms up to 30s
  • Retry-After: Respected when present in response headers

Only idempotent requests (GET, PUT, DELETE, HEAD, OPTIONS) are retried automatically.

Pagination with Iterators

For endpoints that return paginated results, use iterators to automatically fetch all pages:

// Iterate over all spans in a time range
iter := client.GetSpansIter(ctx, &dash0.GetSpansRequest{
    TimeRange: dash0.TimeReferenceRange{
        From: "now-1h",
        To:   "now",
    },
})

for iter.Next() {
    resourceSpan := iter.Current()
    // process resourceSpan
}
if err := iter.Err(); err != nil {
    log.Fatal(err)
}

Error Handling

All API errors are returned as *dash0.APIError, which includes the status code, message, and trace ID for support:

dashboards, err := client.ListDashboards(ctx, nil)
if err != nil {
    if apiErr, ok := err.(*dash0.APIError); ok {
        fmt.Printf("API error: %s (status: %d, trace_id: %s)\n",
            apiErr.Message, apiErr.StatusCode, apiErr.TraceID)
    }
}

Helper functions for common error checks:

if dash0.IsNotFound(err) {
    // Handle 404
}
if dash0.IsUnauthorized(err) {
    // Handle 401 - invalid or expired token
}
if dash0.IsForbidden(err) {
    // Handle 403 - insufficient permissions
}
if dash0.IsRateLimited(err) {
    // Handle 429 - too many requests
}
if dash0.IsServerError(err) {
    // Handle 5xx - server errors
}
if dash0.IsBadRequest(err) {
    // Handle 400 - invalid request
}
if dash0.IsConflict(err) {
    // Handle 409 - resource conflict
}

Testing

The dash0.Client is an interface, making it easy to mock in tests. Use dash0test.MockClient for a ready-to-use mock implementation:

package mypackage

import (
    "context"
    "testing"

    "github.com/dash0hq/dash0-api-client-go"
    "github.com/dash0hq/dash0-api-client-go/dash0test"
)

// MyService uses the Dash0 client
type MyService struct {
    client dash0.Client
}

func TestMyService(t *testing.T) {
    // Create a mock client with custom behavior
    mock := &dash0test.MockClient{
        ListDashboardsFunc: func(ctx context.Context, dataset *string) ([]*dash0.DashboardApiListItem, error) {
            return []*dash0.DashboardApiListItem{
                {Id: dash0.Ptr("dashboard-1"), Name: dash0.Ptr("My Dashboard")},
            }, nil
        },
    }

    // Inject the mock into your service
    svc := &MyService{client: mock}

    // Test your service...
    _ = svc
}

License

See LICENSE for details.

Documentation

Overview

Package dash0 provides a high-level client for the Dash0 API.

Package dash0 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Index

Constants

View Source
const (
	// DefaultMaxConcurrentRequests is the default maximum number of concurrent API requests.
	DefaultMaxConcurrentRequests = 3

	// MaxConcurrentRequests is the maximum allowed value for concurrent requests.
	MaxConcurrentRequests = 10

	// DefaultTimeout is the default HTTP request timeout.
	DefaultTimeout = 30 * time.Second

	// DefaultUserAgent is the default User-Agent header value.
	DefaultUserAgent = "dash0-api-client-go/1.0.0"

	// DefaultRetryWaitMin is the default minimum wait time between retries.
	DefaultRetryWaitMin = 500 * time.Millisecond

	// DefaultRetryWaitMax is the default maximum wait time between retries.
	DefaultRetryWaitMax = 30 * time.Second

	// MaxRetries is the maximum allowed number of retries.
	MaxRetries = 5
)

Variables

This section is empty.

Functions

func Bool

func Bool(v bool) *bool

Bool returns a pointer to the given bool value.

func BoolValue

func BoolValue(p *bool) bool

BoolValue returns the value of a bool pointer, or false if nil.

func Float64

func Float64(v float64) *float64

Float64 returns a pointer to the given float64 value.

func Float64Value

func Float64Value(p *float64) float64

Float64Value returns the value of a float64 pointer, or 0 if nil.

func Int64

func Int64(v int64) *int64

Int64 returns a pointer to the given int64 value.

func Int64Value

func Int64Value(p *int64) int64

Int64Value returns the value of an int64 pointer, or 0 if nil.

func IsBadRequest

func IsBadRequest(err error) bool

IsBadRequest returns true if the error is a 400 Bad Request.

func IsConflict

func IsConflict(err error) bool

IsConflict returns true if the error is a 409 Conflict.

func IsForbidden

func IsForbidden(err error) bool

IsForbidden returns true if the error is a 403 Forbidden.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns true if the error is a 404 Not Found.

func IsRateLimited

func IsRateLimited(err error) bool

IsRateLimited returns true if the error is a 429 Too Many Requests.

func IsServerError

func IsServerError(err error) bool

IsServerError returns true if the error is a 5xx server error.

func IsUnauthorized

func IsUnauthorized(err error) bool

IsUnauthorized returns true if the error is a 401 Unauthorized.

func NewDeleteApiAlertingCheckRulesOriginOrIdRequest

func NewDeleteApiAlertingCheckRulesOriginOrIdRequest(server string, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams) (*http.Request, error)

NewDeleteApiAlertingCheckRulesOriginOrIdRequest generates requests for DeleteApiAlertingCheckRulesOriginOrId

func NewDeleteApiDashboardsOriginOrIdRequest

func NewDeleteApiDashboardsOriginOrIdRequest(server string, originOrId string, params *DeleteApiDashboardsOriginOrIdParams) (*http.Request, error)

NewDeleteApiDashboardsOriginOrIdRequest generates requests for DeleteApiDashboardsOriginOrId

func NewDeleteApiSamplingRulesOriginOrIdRequest added in v1.1.0

func NewDeleteApiSamplingRulesOriginOrIdRequest(server string, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams) (*http.Request, error)

NewDeleteApiSamplingRulesOriginOrIdRequest generates requests for DeleteApiSamplingRulesOriginOrId

func NewDeleteApiSyntheticChecksOriginOrIdRequest

func NewDeleteApiSyntheticChecksOriginOrIdRequest(server string, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams) (*http.Request, error)

NewDeleteApiSyntheticChecksOriginOrIdRequest generates requests for DeleteApiSyntheticChecksOriginOrId

func NewDeleteApiViewsOriginOrIdRequest

func NewDeleteApiViewsOriginOrIdRequest(server string, originOrId string, params *DeleteApiViewsOriginOrIdParams) (*http.Request, error)

NewDeleteApiViewsOriginOrIdRequest generates requests for DeleteApiViewsOriginOrId

func NewGetApiAlertingCheckRulesOriginOrIdRequest

func NewGetApiAlertingCheckRulesOriginOrIdRequest(server string, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams) (*http.Request, error)

NewGetApiAlertingCheckRulesOriginOrIdRequest generates requests for GetApiAlertingCheckRulesOriginOrId

func NewGetApiAlertingCheckRulesRequest

func NewGetApiAlertingCheckRulesRequest(server string, params *GetApiAlertingCheckRulesParams) (*http.Request, error)

NewGetApiAlertingCheckRulesRequest generates requests for GetApiAlertingCheckRules

func NewGetApiDashboardsOriginOrIdRequest

func NewGetApiDashboardsOriginOrIdRequest(server string, originOrId string, params *GetApiDashboardsOriginOrIdParams) (*http.Request, error)

NewGetApiDashboardsOriginOrIdRequest generates requests for GetApiDashboardsOriginOrId

func NewGetApiDashboardsRequest

func NewGetApiDashboardsRequest(server string, params *GetApiDashboardsParams) (*http.Request, error)

NewGetApiDashboardsRequest generates requests for GetApiDashboards

func NewGetApiSamplingRulesOriginOrIdRequest added in v1.1.0

func NewGetApiSamplingRulesOriginOrIdRequest(server string, originOrId string, params *GetApiSamplingRulesOriginOrIdParams) (*http.Request, error)

NewGetApiSamplingRulesOriginOrIdRequest generates requests for GetApiSamplingRulesOriginOrId

func NewGetApiSamplingRulesRequest added in v1.1.0

func NewGetApiSamplingRulesRequest(server string, params *GetApiSamplingRulesParams) (*http.Request, error)

NewGetApiSamplingRulesRequest generates requests for GetApiSamplingRules

func NewGetApiSyntheticChecksOriginOrIdRequest

func NewGetApiSyntheticChecksOriginOrIdRequest(server string, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams) (*http.Request, error)

NewGetApiSyntheticChecksOriginOrIdRequest generates requests for GetApiSyntheticChecksOriginOrId

func NewGetApiSyntheticChecksRequest

func NewGetApiSyntheticChecksRequest(server string, params *GetApiSyntheticChecksParams) (*http.Request, error)

NewGetApiSyntheticChecksRequest generates requests for GetApiSyntheticChecks

func NewGetApiViewsOriginOrIdRequest

func NewGetApiViewsOriginOrIdRequest(server string, originOrId string, params *GetApiViewsOriginOrIdParams) (*http.Request, error)

NewGetApiViewsOriginOrIdRequest generates requests for GetApiViewsOriginOrId

func NewGetApiViewsRequest

func NewGetApiViewsRequest(server string, params *GetApiViewsParams) (*http.Request, error)

NewGetApiViewsRequest generates requests for GetApiViews

func NewPostApiAlertingCheckRulesRequest

func NewPostApiAlertingCheckRulesRequest(server string, params *PostApiAlertingCheckRulesParams, body PostApiAlertingCheckRulesJSONRequestBody) (*http.Request, error)

NewPostApiAlertingCheckRulesRequest calls the generic PostApiAlertingCheckRules builder with application/json body

func NewPostApiAlertingCheckRulesRequestWithBody

func NewPostApiAlertingCheckRulesRequestWithBody(server string, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiAlertingCheckRulesRequestWithBody generates requests for PostApiAlertingCheckRules with any type of body

func NewPostApiDashboardsRequest

func NewPostApiDashboardsRequest(server string, params *PostApiDashboardsParams, body PostApiDashboardsJSONRequestBody) (*http.Request, error)

NewPostApiDashboardsRequest calls the generic PostApiDashboards builder with application/json body

func NewPostApiDashboardsRequestWithBody

func NewPostApiDashboardsRequestWithBody(server string, params *PostApiDashboardsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiDashboardsRequestWithBody generates requests for PostApiDashboards with any type of body

func NewPostApiImportCheckRuleRequest

func NewPostApiImportCheckRuleRequest(server string, params *PostApiImportCheckRuleParams, body PostApiImportCheckRuleJSONRequestBody) (*http.Request, error)

NewPostApiImportCheckRuleRequest calls the generic PostApiImportCheckRule builder with application/json body

func NewPostApiImportCheckRuleRequestWithBody

func NewPostApiImportCheckRuleRequestWithBody(server string, params *PostApiImportCheckRuleParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportCheckRuleRequestWithBody generates requests for PostApiImportCheckRule with any type of body

func NewPostApiImportDashboardRequest

func NewPostApiImportDashboardRequest(server string, params *PostApiImportDashboardParams, body PostApiImportDashboardJSONRequestBody) (*http.Request, error)

NewPostApiImportDashboardRequest calls the generic PostApiImportDashboard builder with application/json body

func NewPostApiImportDashboardRequestWithBody

func NewPostApiImportDashboardRequestWithBody(server string, params *PostApiImportDashboardParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportDashboardRequestWithBody generates requests for PostApiImportDashboard with any type of body

func NewPostApiImportSyntheticCheckRequest

func NewPostApiImportSyntheticCheckRequest(server string, params *PostApiImportSyntheticCheckParams, body PostApiImportSyntheticCheckJSONRequestBody) (*http.Request, error)

NewPostApiImportSyntheticCheckRequest calls the generic PostApiImportSyntheticCheck builder with application/json body

func NewPostApiImportSyntheticCheckRequestWithBody

func NewPostApiImportSyntheticCheckRequestWithBody(server string, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportSyntheticCheckRequestWithBody generates requests for PostApiImportSyntheticCheck with any type of body

func NewPostApiImportViewRequest

func NewPostApiImportViewRequest(server string, params *PostApiImportViewParams, body PostApiImportViewJSONRequestBody) (*http.Request, error)

NewPostApiImportViewRequest calls the generic PostApiImportView builder with application/json body

func NewPostApiImportViewRequestWithBody

func NewPostApiImportViewRequestWithBody(server string, params *PostApiImportViewParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiImportViewRequestWithBody generates requests for PostApiImportView with any type of body

func NewPostApiLogsRequest

func NewPostApiLogsRequest(server string, body PostApiLogsJSONRequestBody) (*http.Request, error)

NewPostApiLogsRequest calls the generic PostApiLogs builder with application/json body

func NewPostApiLogsRequestWithBody

func NewPostApiLogsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiLogsRequestWithBody generates requests for PostApiLogs with any type of body

func NewPostApiSamplingRulesRequest added in v1.1.0

func NewPostApiSamplingRulesRequest(server string, params *PostApiSamplingRulesParams, body PostApiSamplingRulesJSONRequestBody) (*http.Request, error)

NewPostApiSamplingRulesRequest calls the generic PostApiSamplingRules builder with application/json body

func NewPostApiSamplingRulesRequestWithBody added in v1.1.0

func NewPostApiSamplingRulesRequestWithBody(server string, params *PostApiSamplingRulesParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSamplingRulesRequestWithBody generates requests for PostApiSamplingRules with any type of body

func NewPostApiSpansRequest

func NewPostApiSpansRequest(server string, body PostApiSpansJSONRequestBody) (*http.Request, error)

NewPostApiSpansRequest calls the generic PostApiSpans builder with application/json body

func NewPostApiSpansRequestWithBody

func NewPostApiSpansRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSpansRequestWithBody generates requests for PostApiSpans with any type of body

func NewPostApiSyntheticChecksRequest

func NewPostApiSyntheticChecksRequest(server string, params *PostApiSyntheticChecksParams, body PostApiSyntheticChecksJSONRequestBody) (*http.Request, error)

NewPostApiSyntheticChecksRequest calls the generic PostApiSyntheticChecks builder with application/json body

func NewPostApiSyntheticChecksRequestWithBody

func NewPostApiSyntheticChecksRequestWithBody(server string, params *PostApiSyntheticChecksParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSyntheticChecksRequestWithBody generates requests for PostApiSyntheticChecks with any type of body

func NewPostApiViewsRequest

func NewPostApiViewsRequest(server string, params *PostApiViewsParams, body PostApiViewsJSONRequestBody) (*http.Request, error)

NewPostApiViewsRequest calls the generic PostApiViews builder with application/json body

func NewPostApiViewsRequestWithBody

func NewPostApiViewsRequestWithBody(server string, params *PostApiViewsParams, contentType string, body io.Reader) (*http.Request, error)

NewPostApiViewsRequestWithBody generates requests for PostApiViews with any type of body

func NewPutApiAlertingCheckRulesOriginOrIdRequest

func NewPutApiAlertingCheckRulesOriginOrIdRequest(server string, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, body PutApiAlertingCheckRulesOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiAlertingCheckRulesOriginOrIdRequest calls the generic PutApiAlertingCheckRulesOriginOrId builder with application/json body

func NewPutApiAlertingCheckRulesOriginOrIdRequestWithBody

func NewPutApiAlertingCheckRulesOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiAlertingCheckRulesOriginOrIdRequestWithBody generates requests for PutApiAlertingCheckRulesOriginOrId with any type of body

func NewPutApiDashboardsOriginOrIdRequest

func NewPutApiDashboardsOriginOrIdRequest(server string, originOrId string, params *PutApiDashboardsOriginOrIdParams, body PutApiDashboardsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiDashboardsOriginOrIdRequest calls the generic PutApiDashboardsOriginOrId builder with application/json body

func NewPutApiDashboardsOriginOrIdRequestWithBody

func NewPutApiDashboardsOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiDashboardsOriginOrIdRequestWithBody generates requests for PutApiDashboardsOriginOrId with any type of body

func NewPutApiSamplingRulesOriginOrIdRequest added in v1.1.0

func NewPutApiSamplingRulesOriginOrIdRequest(server string, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, body PutApiSamplingRulesOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiSamplingRulesOriginOrIdRequest calls the generic PutApiSamplingRulesOriginOrId builder with application/json body

func NewPutApiSamplingRulesOriginOrIdRequestWithBody added in v1.1.0

func NewPutApiSamplingRulesOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiSamplingRulesOriginOrIdRequestWithBody generates requests for PutApiSamplingRulesOriginOrId with any type of body

func NewPutApiSyntheticChecksOriginOrIdRequest

func NewPutApiSyntheticChecksOriginOrIdRequest(server string, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, body PutApiSyntheticChecksOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiSyntheticChecksOriginOrIdRequest calls the generic PutApiSyntheticChecksOriginOrId builder with application/json body

func NewPutApiSyntheticChecksOriginOrIdRequestWithBody

func NewPutApiSyntheticChecksOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiSyntheticChecksOriginOrIdRequestWithBody generates requests for PutApiSyntheticChecksOriginOrId with any type of body

func NewPutApiViewsOriginOrIdRequest

func NewPutApiViewsOriginOrIdRequest(server string, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody) (*http.Request, error)

NewPutApiViewsOriginOrIdRequest calls the generic PutApiViewsOriginOrId builder with application/json body

func NewPutApiViewsOriginOrIdRequestWithBody

func NewPutApiViewsOriginOrIdRequestWithBody(server string, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader) (*http.Request, error)

NewPutApiViewsOriginOrIdRequestWithBody generates requests for PutApiViewsOriginOrId with any type of body

func Ptr

func Ptr[T any](v T) *T

Ptr returns a pointer to the given value. This is useful for creating pointers to literals when calling API methods that accept optional parameters.

Example:

client.ListDashboards(ctx, dash0.Ptr("default"))

func String

func String(v string) *string

String returns a pointer to the given string value. This is a convenience wrapper around Ptr for the common case of string pointers.

Example:

client.ListDashboards(ctx, dash0.String("default"))

func StringValue

func StringValue(p *string) string

StringValue returns the value of a string pointer, or empty string if nil.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) generatedClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

Types

type APIError

type APIError struct {
	// StatusCode is the HTTP status code.
	StatusCode int

	// Status is the HTTP status text.
	Status string

	// Body is the raw response body.
	Body string

	// Message is the error message extracted from the response.
	Message string

	// TraceID is the trace ID from the x-trace-id header if available.
	TraceID string
}

APIError represents an error response from the Dash0 API.

func NewAPIError

func NewAPIError(resp *http.Response) *APIError

NewAPIError creates an APIError from an HTTP response. Note: This function tries to read the response body. If the body has already been read (e.g., by oapi-codegen), use newAPIErrorWithBody instead.

func (*APIError) Error

func (e *APIError) Error() string

Error implements the error interface.

type AnyValue

type AnyValue struct {
	BoolValue   *bool    `json:"boolValue,omitempty"`
	BytesValue  *[]byte  `json:"bytesValue,omitempty"`
	DoubleValue *float64 `json:"doubleValue,omitempty"`
	IntValue    *string  `json:"intValue,omitempty"`
	StringValue *string  `json:"stringValue,omitempty"`
}

AnyValue AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.

type AttributeFilter

type AttributeFilter struct {
	// Key The attribute key to be filtered.
	Key AttributeFilterKey `json:"key"`

	// Operator The match operation for filtering attributes.
	//
	// #### Equality Operators
	// - `is` - equals (attribute exists and has a matching value)
	// - `is_not` - not equals (attribute exists and has a different value)
	//
	// #### Existence Operators
	// - `is_set` - is set (attribute exists)
	// - `is_not_set` - is not set (attribute does not exist)
	//
	// #### Multiple Value Operators
	// - `is_one_of` - is any of (attribute exists and has a value that is in the specified values)
	// - `is_not_one_of` - is not any of (attribute exists and has a value that is not in the specified values)
	//
	// #### Comparison Operators
	// - `gt` - greater than
	// - `lt` - less than
	// - `gte` - greater than or equal
	// - `lte` - less than or equal
	//
	// #### Pattern Matching Operators
	// - `matches` - match regex expression (attribute exists and matches the regular expression)
	// - `does_not_match` - does not match regex expression (attribute exists and does not match the regular expression)
	//
	// #### String Operators
	// - `contains` - contains (attribute exists and contains the specified value)
	// - `does_not_contain` - does not contain (attribute exists and does not contain the specified value)
	// - `starts_with` - starts with (attribute exists and starts with the specified value)
	// - `does_not_start_with` - does not start with (attribute exists and does not start with the specified value)
	// - `ends_with` - ends with (attribute exists and ends with the specified value)
	// - `does_not_end_with` - does not end with (attribute exists and does not end with the specified value)
	//
	// #### Special Operators
	// - `is_any` - matches any value, ignoring whether the key exists or not
	Operator AttributeFilterOperator `json:"operator"`
	Value    *AttributeFilter_Value  `json:"value,omitempty"`

	// Values List of values to match against. This parameter is mandatory for the is_one_of and is_not_one_of operators.
	Values *[]AttributeFilter_Values_Item `json:"values,omitempty"`
}

AttributeFilter defines model for AttributeFilter.

type AttributeFilterAnyValue

type AttributeFilterAnyValue = AnyValue

AttributeFilterAnyValue AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.

type AttributeFilterKey

type AttributeFilterKey = string

AttributeFilterKey The attribute key to be filtered.

type AttributeFilterOperator

type AttributeFilterOperator string

AttributeFilterOperator The match operation for filtering attributes.

#### Equality Operators - `is` - equals (attribute exists and has a matching value) - `is_not` - not equals (attribute exists and has a different value)

#### Existence Operators - `is_set` - is set (attribute exists) - `is_not_set` - is not set (attribute does not exist)

#### Multiple Value Operators - `is_one_of` - is any of (attribute exists and has a value that is in the specified values) - `is_not_one_of` - is not any of (attribute exists and has a value that is not in the specified values)

#### Comparison Operators - `gt` - greater than - `lt` - less than - `gte` - greater than or equal - `lte` - less than or equal

#### Pattern Matching Operators - `matches` - match regex expression (attribute exists and matches the regular expression) - `does_not_match` - does not match regex expression (attribute exists and does not match the regular expression)

#### String Operators - `contains` - contains (attribute exists and contains the specified value) - `does_not_contain` - does not contain (attribute exists and does not contain the specified value) - `starts_with` - starts with (attribute exists and starts with the specified value) - `does_not_start_with` - does not start with (attribute exists and does not start with the specified value) - `ends_with` - ends with (attribute exists and ends with the specified value) - `does_not_end_with` - does not end with (attribute exists and does not end with the specified value)

#### Special Operators - `is_any` - matches any value, ignoring whether the key exists or not

const (
	AttributeFilterOperatorContains         AttributeFilterOperator = "contains"
	AttributeFilterOperatorDoesNotContain   AttributeFilterOperator = "does_not_contain"
	AttributeFilterOperatorDoesNotEndWith   AttributeFilterOperator = "does_not_end_with"
	AttributeFilterOperatorDoesNotMatch     AttributeFilterOperator = "does_not_match"
	AttributeFilterOperatorDoesNotStartWith AttributeFilterOperator = "does_not_start_with"
	AttributeFilterOperatorEndsWith         AttributeFilterOperator = "ends_with"
	AttributeFilterOperatorGt               AttributeFilterOperator = "gt"
	AttributeFilterOperatorGte              AttributeFilterOperator = "gte"
	AttributeFilterOperatorIs               AttributeFilterOperator = "is"
	AttributeFilterOperatorIsAny            AttributeFilterOperator = "is_any"
	AttributeFilterOperatorIsNot            AttributeFilterOperator = "is_not"
	AttributeFilterOperatorIsNotOneOf       AttributeFilterOperator = "is_not_one_of"
	AttributeFilterOperatorIsNotSet         AttributeFilterOperator = "is_not_set"
	AttributeFilterOperatorIsOneOf          AttributeFilterOperator = "is_one_of"
	AttributeFilterOperatorIsSet            AttributeFilterOperator = "is_set"
	AttributeFilterOperatorLt               AttributeFilterOperator = "lt"
	AttributeFilterOperatorLte              AttributeFilterOperator = "lte"
	AttributeFilterOperatorMatches          AttributeFilterOperator = "matches"
	AttributeFilterOperatorStartsWith       AttributeFilterOperator = "starts_with"
)

Defines values for AttributeFilterOperator.

type AttributeFilterStringValue

type AttributeFilterStringValue = string

AttributeFilterStringValue AttributeFilterStringValue may contain a primitive value such as a regex pattern or string.

type AttributeFilter_Value

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

AttributeFilter_Value defines model for AttributeFilter.Value.

func (AttributeFilter_Value) AsAttributeFilterAnyValue

func (t AttributeFilter_Value) AsAttributeFilterAnyValue() (AttributeFilterAnyValue, error)

AsAttributeFilterAnyValue returns the union data inside the AttributeFilter_Value as a AttributeFilterAnyValue

func (AttributeFilter_Value) AsAttributeFilterStringValue

func (t AttributeFilter_Value) AsAttributeFilterStringValue() (AttributeFilterStringValue, error)

AsAttributeFilterStringValue returns the union data inside the AttributeFilter_Value as a AttributeFilterStringValue

func (*AttributeFilter_Value) FromAttributeFilterAnyValue

func (t *AttributeFilter_Value) FromAttributeFilterAnyValue(v AttributeFilterAnyValue) error

FromAttributeFilterAnyValue overwrites any union data inside the AttributeFilter_Value as the provided AttributeFilterAnyValue

func (*AttributeFilter_Value) FromAttributeFilterStringValue

func (t *AttributeFilter_Value) FromAttributeFilterStringValue(v AttributeFilterStringValue) error

FromAttributeFilterStringValue overwrites any union data inside the AttributeFilter_Value as the provided AttributeFilterStringValue

func (AttributeFilter_Value) MarshalJSON

func (t AttributeFilter_Value) MarshalJSON() ([]byte, error)

func (*AttributeFilter_Value) MergeAttributeFilterAnyValue

func (t *AttributeFilter_Value) MergeAttributeFilterAnyValue(v AttributeFilterAnyValue) error

MergeAttributeFilterAnyValue performs a merge with any union data inside the AttributeFilter_Value, using the provided AttributeFilterAnyValue

func (*AttributeFilter_Value) MergeAttributeFilterStringValue

func (t *AttributeFilter_Value) MergeAttributeFilterStringValue(v AttributeFilterStringValue) error

MergeAttributeFilterStringValue performs a merge with any union data inside the AttributeFilter_Value, using the provided AttributeFilterStringValue

func (*AttributeFilter_Value) UnmarshalJSON

func (t *AttributeFilter_Value) UnmarshalJSON(b []byte) error

type AttributeFilter_Values_Item

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

AttributeFilter_Values_Item defines model for AttributeFilter.values.Item.

func (AttributeFilter_Values_Item) AsAttributeFilterAnyValue

func (t AttributeFilter_Values_Item) AsAttributeFilterAnyValue() (AttributeFilterAnyValue, error)

AsAttributeFilterAnyValue returns the union data inside the AttributeFilter_Values_Item as a AttributeFilterAnyValue

func (AttributeFilter_Values_Item) AsAttributeFilterStringValue

func (t AttributeFilter_Values_Item) AsAttributeFilterStringValue() (AttributeFilterStringValue, error)

AsAttributeFilterStringValue returns the union data inside the AttributeFilter_Values_Item as a AttributeFilterStringValue

func (*AttributeFilter_Values_Item) FromAttributeFilterAnyValue

func (t *AttributeFilter_Values_Item) FromAttributeFilterAnyValue(v AttributeFilterAnyValue) error

FromAttributeFilterAnyValue overwrites any union data inside the AttributeFilter_Values_Item as the provided AttributeFilterAnyValue

func (*AttributeFilter_Values_Item) FromAttributeFilterStringValue

func (t *AttributeFilter_Values_Item) FromAttributeFilterStringValue(v AttributeFilterStringValue) error

FromAttributeFilterStringValue overwrites any union data inside the AttributeFilter_Values_Item as the provided AttributeFilterStringValue

func (AttributeFilter_Values_Item) MarshalJSON

func (t AttributeFilter_Values_Item) MarshalJSON() ([]byte, error)

func (*AttributeFilter_Values_Item) MergeAttributeFilterAnyValue

func (t *AttributeFilter_Values_Item) MergeAttributeFilterAnyValue(v AttributeFilterAnyValue) error

MergeAttributeFilterAnyValue performs a merge with any union data inside the AttributeFilter_Values_Item, using the provided AttributeFilterAnyValue

func (*AttributeFilter_Values_Item) MergeAttributeFilterStringValue

func (t *AttributeFilter_Values_Item) MergeAttributeFilterStringValue(v AttributeFilterStringValue) error

MergeAttributeFilterStringValue performs a merge with any union data inside the AttributeFilter_Values_Item, using the provided AttributeFilterStringValue

func (*AttributeFilter_Values_Item) UnmarshalJSON

func (t *AttributeFilter_Values_Item) UnmarshalJSON(b []byte) error

type AxisScale

type AxisScale string

AxisScale defines model for AxisScale.

const (
	AxisScaleLinear AxisScale = "linear"
	AxisScaleLog10  AxisScale = "log10"
)

Defines values for AxisScale.

type CheckThresholds

type CheckThresholds struct {
	// Degraded The threshold value that defines when the check is in a degraded state. The value will be
	// interpolated into the expression field as `$__threshold`.
	Degraded *float32 `json:"degraded,omitempty"`

	// Failed The threshold value that defines when the check is in a failed state. The value will be
	// interpolated into the expression field as `$__threshold`.
	Failed *float32 `json:"failed,omitempty"`
}

CheckThresholds Thresholds to use for the `$__threshold` variable in the expression field.

type Client

type Client interface {
	// Dashboards
	ListDashboards(ctx context.Context, dataset *string) ([]*DashboardApiListItem, error)
	GetDashboard(ctx context.Context, originOrID string, dataset *string) (*DashboardDefinition, error)
	CreateDashboard(ctx context.Context, dashboard *DashboardDefinition, dataset *string) (*DashboardDefinition, error)
	UpdateDashboard(ctx context.Context, originOrID string, dashboard *DashboardDefinition, dataset *string) (*DashboardDefinition, error)
	DeleteDashboard(ctx context.Context, originOrID string, dataset *string) error
	ListDashboardsIter(ctx context.Context, dataset *string) *Iter[DashboardApiListItem]

	// Check Rules
	ListCheckRules(ctx context.Context, dataset *string) ([]*PrometheusAlertRuleApiListItem, error)
	GetCheckRule(ctx context.Context, originOrID string, dataset *string) (*PrometheusAlertRule, error)
	CreateCheckRule(ctx context.Context, rule *PrometheusAlertRule, dataset *string) (*PrometheusAlertRule, error)
	UpdateCheckRule(ctx context.Context, originOrID string, rule *PrometheusAlertRule, dataset *string) (*PrometheusAlertRule, error)
	DeleteCheckRule(ctx context.Context, originOrID string, dataset *string) error
	ListCheckRulesIter(ctx context.Context, dataset *string) *Iter[PrometheusAlertRuleApiListItem]

	// Synthetic Checks
	ListSyntheticChecks(ctx context.Context, dataset *string) ([]*SyntheticChecksApiListItem, error)
	GetSyntheticCheck(ctx context.Context, originOrID string, dataset *string) (*SyntheticCheckDefinition, error)
	CreateSyntheticCheck(ctx context.Context, check *SyntheticCheckDefinition, dataset *string) (*SyntheticCheckDefinition, error)
	UpdateSyntheticCheck(ctx context.Context, originOrID string, check *SyntheticCheckDefinition, dataset *string) (*SyntheticCheckDefinition, error)
	DeleteSyntheticCheck(ctx context.Context, originOrID string, dataset *string) error
	ListSyntheticChecksIter(ctx context.Context, dataset *string) *Iter[SyntheticChecksApiListItem]

	// Views
	ListViews(ctx context.Context, dataset *string) ([]*ViewApiListItem, error)
	GetView(ctx context.Context, originOrID string, dataset *string) (*ViewDefinition, error)
	CreateView(ctx context.Context, view *ViewDefinition, dataset *string) (*ViewDefinition, error)
	UpdateView(ctx context.Context, originOrID string, view *ViewDefinition, dataset *string) (*ViewDefinition, error)
	DeleteView(ctx context.Context, originOrID string, dataset *string) error
	ListViewsIter(ctx context.Context, dataset *string) *Iter[ViewApiListItem]

	// Sampling Rules
	ListSamplingRules(ctx context.Context, dataset *string) ([]*SamplingDefinition, error)
	GetSamplingRule(ctx context.Context, originOrID string, dataset *string) (*SamplingDefinition, error)
	CreateSamplingRule(ctx context.Context, rule *SamplingDefinition, dataset *string) (*SamplingDefinition, error)
	UpdateSamplingRule(ctx context.Context, originOrID string, rule *SamplingDefinition, dataset *string) (*SamplingDefinition, error)
	DeleteSamplingRule(ctx context.Context, originOrID string, dataset *string) error
	ListSamplingRulesIter(ctx context.Context, dataset *string) *Iter[SamplingDefinition]

	// Spans
	GetSpans(ctx context.Context, request *GetSpansRequest) (*GetSpansResponse, error)
	GetSpansIter(ctx context.Context, request *GetSpansRequest) *Iter[ResourceSpans]

	// Logs
	GetLogRecords(ctx context.Context, request *GetLogRecordsRequest) (*GetLogRecordsResponse, error)
	GetLogRecordsIter(ctx context.Context, request *GetLogRecordsRequest) *Iter[ResourceLogs]

	// Import
	ImportCheckRule(ctx context.Context, rule *PostApiImportCheckRuleJSONRequestBody, dataset *string) (*PrometheusAlertRule, error)
	ImportDashboard(ctx context.Context, dashboard *PostApiImportDashboardJSONRequestBody, dataset *string) (*DashboardDefinition, error)
	ImportSyntheticCheck(ctx context.Context, check *PostApiImportSyntheticCheckJSONRequestBody, dataset *string) (*SyntheticCheckDefinition, error)
	ImportView(ctx context.Context, view *PostApiImportViewJSONRequestBody, dataset *string) (*ViewDefinition, error)

	// Inner returns the underlying generated client for advanced use cases.
	Inner() *ClientWithResponses
}

Client defines the Dash0 API client interface. Use NewClient to create a concrete implementation.

func NewClient

func NewClient(opts ...ClientOption) (Client, error)

NewClient creates a new Dash0 API client.

Required options:

  • WithApiUrl: The Dash0 API endpoint URL
  • WithAuthToken: The auth token for authentication

Example:

client, err := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("your-auth-token"),
)

type ClientInterface

type ClientInterface interface {
	// GetApiAlertingCheckRules request
	GetApiAlertingCheckRules(ctx context.Context, params *GetApiAlertingCheckRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiAlertingCheckRulesWithBody request with any body
	PostApiAlertingCheckRulesWithBody(ctx context.Context, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiAlertingCheckRules(ctx context.Context, params *PostApiAlertingCheckRulesParams, body PostApiAlertingCheckRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiAlertingCheckRulesOriginOrId request
	DeleteApiAlertingCheckRulesOriginOrId(ctx context.Context, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiAlertingCheckRulesOriginOrId request
	GetApiAlertingCheckRulesOriginOrId(ctx context.Context, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiAlertingCheckRulesOriginOrIdWithBody request with any body
	PutApiAlertingCheckRulesOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiAlertingCheckRulesOriginOrId(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, body PutApiAlertingCheckRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiDashboards request
	GetApiDashboards(ctx context.Context, params *GetApiDashboardsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiDashboardsWithBody request with any body
	PostApiDashboardsWithBody(ctx context.Context, params *PostApiDashboardsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiDashboards(ctx context.Context, params *PostApiDashboardsParams, body PostApiDashboardsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiDashboardsOriginOrId request
	DeleteApiDashboardsOriginOrId(ctx context.Context, originOrId string, params *DeleteApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiDashboardsOriginOrId request
	GetApiDashboardsOriginOrId(ctx context.Context, originOrId string, params *GetApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiDashboardsOriginOrIdWithBody request with any body
	PutApiDashboardsOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiDashboardsOriginOrId(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, body PutApiDashboardsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportCheckRuleWithBody request with any body
	PostApiImportCheckRuleWithBody(ctx context.Context, params *PostApiImportCheckRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportCheckRule(ctx context.Context, params *PostApiImportCheckRuleParams, body PostApiImportCheckRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportDashboardWithBody request with any body
	PostApiImportDashboardWithBody(ctx context.Context, params *PostApiImportDashboardParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportDashboard(ctx context.Context, params *PostApiImportDashboardParams, body PostApiImportDashboardJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportSyntheticCheckWithBody request with any body
	PostApiImportSyntheticCheckWithBody(ctx context.Context, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportSyntheticCheck(ctx context.Context, params *PostApiImportSyntheticCheckParams, body PostApiImportSyntheticCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiImportViewWithBody request with any body
	PostApiImportViewWithBody(ctx context.Context, params *PostApiImportViewParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiImportView(ctx context.Context, params *PostApiImportViewParams, body PostApiImportViewJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiLogsWithBody request with any body
	PostApiLogsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiLogs(ctx context.Context, body PostApiLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSamplingRules request
	GetApiSamplingRules(ctx context.Context, params *GetApiSamplingRulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSamplingRulesWithBody request with any body
	PostApiSamplingRulesWithBody(ctx context.Context, params *PostApiSamplingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSamplingRules(ctx context.Context, params *PostApiSamplingRulesParams, body PostApiSamplingRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSamplingRulesOriginOrId request
	DeleteApiSamplingRulesOriginOrId(ctx context.Context, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSamplingRulesOriginOrId request
	GetApiSamplingRulesOriginOrId(ctx context.Context, originOrId string, params *GetApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiSamplingRulesOriginOrIdWithBody request with any body
	PutApiSamplingRulesOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiSamplingRulesOriginOrId(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, body PutApiSamplingRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSpansWithBody request with any body
	PostApiSpansWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSpans(ctx context.Context, body PostApiSpansJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSyntheticChecks request
	GetApiSyntheticChecks(ctx context.Context, params *GetApiSyntheticChecksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSyntheticChecksWithBody request with any body
	PostApiSyntheticChecksWithBody(ctx context.Context, params *PostApiSyntheticChecksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSyntheticChecks(ctx context.Context, params *PostApiSyntheticChecksParams, body PostApiSyntheticChecksJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSyntheticChecksOriginOrId request
	DeleteApiSyntheticChecksOriginOrId(ctx context.Context, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSyntheticChecksOriginOrId request
	GetApiSyntheticChecksOriginOrId(ctx context.Context, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiSyntheticChecksOriginOrIdWithBody request with any body
	PutApiSyntheticChecksOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiSyntheticChecksOriginOrId(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, body PutApiSyntheticChecksOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiViews request
	GetApiViews(ctx context.Context, params *GetApiViewsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiViewsWithBody request with any body
	PostApiViewsWithBody(ctx context.Context, params *PostApiViewsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiViews(ctx context.Context, params *PostApiViewsParams, body PostApiViewsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiViewsOriginOrId request
	DeleteApiViewsOriginOrId(ctx context.Context, originOrId string, params *DeleteApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiViewsOriginOrId request
	GetApiViewsOriginOrId(ctx context.Context, originOrId string, params *GetApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutApiViewsOriginOrIdWithBody request with any body
	PutApiViewsOriginOrIdWithBody(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PutApiViewsOriginOrId(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*clientConfig)

ClientOption configures a Dash0 client.

func WithApiUrl

func WithApiUrl(url string) ClientOption

WithApiUrl sets the Dash0 API URL. This is required and must be a valid Dash0 API endpoint URL. Examples:

func WithAuthToken

func WithAuthToken(authToken string) ClientOption

WithAuthToken sets the auth token for authentication. This is required for all API requests.

func WithHTTPClient

func WithHTTPClient(client *http.Client) ClientOption

WithHTTPClient sets a custom HTTP client. The client's transport will be wrapped with rate limiting middleware. Other settings like CheckRedirect and Jar will be preserved.

func WithMaxConcurrentRequests

func WithMaxConcurrentRequests(n int64) ClientOption

WithMaxConcurrentRequests sets the maximum number of concurrent API calls. The value must be between 1 and 10 (inclusive). Values outside this range will be clamped. Default is 3.

func WithMaxRetries

func WithMaxRetries(n int) ClientOption

WithMaxRetries sets the maximum number of retries for failed requests. Only idempotent requests (GET, PUT, DELETE) and requests marked with withIdempotent context are retried. Default is 1. Maximum is 5. Set to 0 to disable retries.

Example:

client, _ := dash0.NewClient(
    dash0.WithApiUrl("https://api.eu-west-1.aws.dash0.com"),
    dash0.WithAuthToken("your-auth-token"),
    dash0.WithMaxRetries(3),
)

func WithRetryWaitMax

func WithRetryWaitMax(d time.Duration) ClientOption

WithRetryWaitMax sets the maximum wait time between retries. Default is 30s. The backoff will not exceed this value.

func WithRetryWaitMin

func WithRetryWaitMin(d time.Duration) ClientOption

WithRetryWaitMin sets the minimum wait time between retries. Default is 500ms. The actual wait time uses exponential backoff starting from this value.

func WithTimeout

func WithTimeout(d time.Duration) ClientOption

WithTimeout sets the HTTP request timeout. Default is 30 seconds.

func WithUserAgent

func WithUserAgent(ua string) ClientOption

WithUserAgent sets a custom User-Agent header. Default is "dash0-api-client-go/1.0.0".

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...generatedClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) DeleteApiAlertingCheckRulesOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiAlertingCheckRulesOriginOrIdResponse, error)

DeleteApiAlertingCheckRulesOriginOrIdWithResponse request returning *DeleteApiAlertingCheckRulesOriginOrIdResponse

func (*ClientWithResponses) DeleteApiDashboardsOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiDashboardsOriginOrIdResponse, error)

DeleteApiDashboardsOriginOrIdWithResponse request returning *DeleteApiDashboardsOriginOrIdResponse

func (*ClientWithResponses) DeleteApiSamplingRulesOriginOrIdWithResponse added in v1.1.0

func (c *ClientWithResponses) DeleteApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSamplingRulesOriginOrIdResponse, error)

DeleteApiSamplingRulesOriginOrIdWithResponse request returning *DeleteApiSamplingRulesOriginOrIdResponse

func (*ClientWithResponses) DeleteApiSyntheticChecksOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSyntheticChecksOriginOrIdResponse, error)

DeleteApiSyntheticChecksOriginOrIdWithResponse request returning *DeleteApiSyntheticChecksOriginOrIdResponse

func (*ClientWithResponses) DeleteApiViewsOriginOrIdWithResponse

func (c *ClientWithResponses) DeleteApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiViewsOriginOrIdResponse, error)

DeleteApiViewsOriginOrIdWithResponse request returning *DeleteApiViewsOriginOrIdResponse

func (*ClientWithResponses) GetApiAlertingCheckRulesOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesOriginOrIdResponse, error)

GetApiAlertingCheckRulesOriginOrIdWithResponse request returning *GetApiAlertingCheckRulesOriginOrIdResponse

func (*ClientWithResponses) GetApiAlertingCheckRulesWithResponse

func (c *ClientWithResponses) GetApiAlertingCheckRulesWithResponse(ctx context.Context, params *GetApiAlertingCheckRulesParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesResponse, error)

GetApiAlertingCheckRulesWithResponse request returning *GetApiAlertingCheckRulesResponse

func (*ClientWithResponses) GetApiDashboardsOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsOriginOrIdResponse, error)

GetApiDashboardsOriginOrIdWithResponse request returning *GetApiDashboardsOriginOrIdResponse

func (*ClientWithResponses) GetApiDashboardsWithResponse

func (c *ClientWithResponses) GetApiDashboardsWithResponse(ctx context.Context, params *GetApiDashboardsParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsResponse, error)

GetApiDashboardsWithResponse request returning *GetApiDashboardsResponse

func (*ClientWithResponses) GetApiSamplingRulesOriginOrIdWithResponse added in v1.1.0

func (c *ClientWithResponses) GetApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesOriginOrIdResponse, error)

GetApiSamplingRulesOriginOrIdWithResponse request returning *GetApiSamplingRulesOriginOrIdResponse

func (*ClientWithResponses) GetApiSamplingRulesWithResponse added in v1.1.0

func (c *ClientWithResponses) GetApiSamplingRulesWithResponse(ctx context.Context, params *GetApiSamplingRulesParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesResponse, error)

GetApiSamplingRulesWithResponse request returning *GetApiSamplingRulesResponse

func (*ClientWithResponses) GetApiSyntheticChecksOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksOriginOrIdResponse, error)

GetApiSyntheticChecksOriginOrIdWithResponse request returning *GetApiSyntheticChecksOriginOrIdResponse

func (*ClientWithResponses) GetApiSyntheticChecksWithResponse

func (c *ClientWithResponses) GetApiSyntheticChecksWithResponse(ctx context.Context, params *GetApiSyntheticChecksParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksResponse, error)

GetApiSyntheticChecksWithResponse request returning *GetApiSyntheticChecksResponse

func (*ClientWithResponses) GetApiViewsOriginOrIdWithResponse

func (c *ClientWithResponses) GetApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiViewsOriginOrIdResponse, error)

GetApiViewsOriginOrIdWithResponse request returning *GetApiViewsOriginOrIdResponse

func (*ClientWithResponses) GetApiViewsWithResponse

func (c *ClientWithResponses) GetApiViewsWithResponse(ctx context.Context, params *GetApiViewsParams, reqEditors ...RequestEditorFn) (*GetApiViewsResponse, error)

GetApiViewsWithResponse request returning *GetApiViewsResponse

func (*ClientWithResponses) PostApiAlertingCheckRulesWithBodyWithResponse

func (c *ClientWithResponses) PostApiAlertingCheckRulesWithBodyWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesResponse, error)

PostApiAlertingCheckRulesWithBodyWithResponse request with arbitrary body returning *PostApiAlertingCheckRulesResponse

func (*ClientWithResponses) PostApiDashboardsWithBodyWithResponse

func (c *ClientWithResponses) PostApiDashboardsWithBodyWithResponse(ctx context.Context, params *PostApiDashboardsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiDashboardsResponse, error)

PostApiDashboardsWithBodyWithResponse request with arbitrary body returning *PostApiDashboardsResponse

func (*ClientWithResponses) PostApiDashboardsWithResponse

func (*ClientWithResponses) PostApiImportCheckRuleWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportCheckRuleWithBodyWithResponse(ctx context.Context, params *PostApiImportCheckRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportCheckRuleResponse, error)

PostApiImportCheckRuleWithBodyWithResponse request with arbitrary body returning *PostApiImportCheckRuleResponse

func (*ClientWithResponses) PostApiImportCheckRuleWithResponse

func (*ClientWithResponses) PostApiImportDashboardWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportDashboardWithBodyWithResponse(ctx context.Context, params *PostApiImportDashboardParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportDashboardResponse, error)

PostApiImportDashboardWithBodyWithResponse request with arbitrary body returning *PostApiImportDashboardResponse

func (*ClientWithResponses) PostApiImportDashboardWithResponse

func (*ClientWithResponses) PostApiImportSyntheticCheckWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportSyntheticCheckWithBodyWithResponse(ctx context.Context, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportSyntheticCheckResponse, error)

PostApiImportSyntheticCheckWithBodyWithResponse request with arbitrary body returning *PostApiImportSyntheticCheckResponse

func (*ClientWithResponses) PostApiImportViewWithBodyWithResponse

func (c *ClientWithResponses) PostApiImportViewWithBodyWithResponse(ctx context.Context, params *PostApiImportViewParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportViewResponse, error)

PostApiImportViewWithBodyWithResponse request with arbitrary body returning *PostApiImportViewResponse

func (*ClientWithResponses) PostApiImportViewWithResponse

func (*ClientWithResponses) PostApiLogsWithBodyWithResponse

func (c *ClientWithResponses) PostApiLogsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

PostApiLogsWithBodyWithResponse request with arbitrary body returning *PostApiLogsResponse

func (*ClientWithResponses) PostApiLogsWithResponse

func (c *ClientWithResponses) PostApiLogsWithResponse(ctx context.Context, body PostApiLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

func (*ClientWithResponses) PostApiSamplingRulesWithBodyWithResponse added in v1.1.0

func (c *ClientWithResponses) PostApiSamplingRulesWithBodyWithResponse(ctx context.Context, params *PostApiSamplingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSamplingRulesResponse, error)

PostApiSamplingRulesWithBodyWithResponse request with arbitrary body returning *PostApiSamplingRulesResponse

func (*ClientWithResponses) PostApiSamplingRulesWithResponse added in v1.1.0

func (*ClientWithResponses) PostApiSpansWithBodyWithResponse

func (c *ClientWithResponses) PostApiSpansWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

PostApiSpansWithBodyWithResponse request with arbitrary body returning *PostApiSpansResponse

func (*ClientWithResponses) PostApiSpansWithResponse

func (c *ClientWithResponses) PostApiSpansWithResponse(ctx context.Context, body PostApiSpansJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

func (*ClientWithResponses) PostApiSyntheticChecksWithBodyWithResponse

func (c *ClientWithResponses) PostApiSyntheticChecksWithBodyWithResponse(ctx context.Context, params *PostApiSyntheticChecksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksResponse, error)

PostApiSyntheticChecksWithBodyWithResponse request with arbitrary body returning *PostApiSyntheticChecksResponse

func (*ClientWithResponses) PostApiSyntheticChecksWithResponse

func (*ClientWithResponses) PostApiViewsWithBodyWithResponse

func (c *ClientWithResponses) PostApiViewsWithBodyWithResponse(ctx context.Context, params *PostApiViewsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

PostApiViewsWithBodyWithResponse request with arbitrary body returning *PostApiViewsResponse

func (*ClientWithResponses) PostApiViewsWithResponse

func (c *ClientWithResponses) PostApiViewsWithResponse(ctx context.Context, params *PostApiViewsParams, body PostApiViewsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

func (*ClientWithResponses) PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiAlertingCheckRulesOriginOrIdResponse

func (*ClientWithResponses) PutApiDashboardsOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiDashboardsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiDashboardsOriginOrIdResponse, error)

PutApiDashboardsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiDashboardsOriginOrIdResponse

func (*ClientWithResponses) PutApiDashboardsOriginOrIdWithResponse

func (*ClientWithResponses) PutApiSamplingRulesOriginOrIdWithBodyWithResponse added in v1.1.0

func (c *ClientWithResponses) PutApiSamplingRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSamplingRulesOriginOrIdResponse, error)

PutApiSamplingRulesOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiSamplingRulesOriginOrIdResponse

func (*ClientWithResponses) PutApiSamplingRulesOriginOrIdWithResponse added in v1.1.0

func (*ClientWithResponses) PutApiSyntheticChecksOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiSyntheticChecksOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSyntheticChecksOriginOrIdResponse, error)

PutApiSyntheticChecksOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiSyntheticChecksOriginOrIdResponse

func (*ClientWithResponses) PutApiViewsOriginOrIdWithBodyWithResponse

func (c *ClientWithResponses) PutApiViewsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)

PutApiViewsOriginOrIdWithBodyWithResponse request with arbitrary body returning *PutApiViewsOriginOrIdResponse

func (*ClientWithResponses) PutApiViewsOriginOrIdWithResponse

func (c *ClientWithResponses) PutApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetApiAlertingCheckRulesWithResponse request
	GetApiAlertingCheckRulesWithResponse(ctx context.Context, params *GetApiAlertingCheckRulesParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesResponse, error)

	// PostApiAlertingCheckRulesWithBodyWithResponse request with any body
	PostApiAlertingCheckRulesWithBodyWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesResponse, error)

	PostApiAlertingCheckRulesWithResponse(ctx context.Context, params *PostApiAlertingCheckRulesParams, body PostApiAlertingCheckRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiAlertingCheckRulesResponse, error)

	// DeleteApiAlertingCheckRulesOriginOrIdWithResponse request
	DeleteApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiAlertingCheckRulesOriginOrIdResponse, error)

	// GetApiAlertingCheckRulesOriginOrIdWithResponse request
	GetApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiAlertingCheckRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiAlertingCheckRulesOriginOrIdResponse, error)

	// PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse request with any body
	PutApiAlertingCheckRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

	PutApiAlertingCheckRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiAlertingCheckRulesOriginOrIdParams, body PutApiAlertingCheckRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

	// GetApiDashboardsWithResponse request
	GetApiDashboardsWithResponse(ctx context.Context, params *GetApiDashboardsParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsResponse, error)

	// PostApiDashboardsWithBodyWithResponse request with any body
	PostApiDashboardsWithBodyWithResponse(ctx context.Context, params *PostApiDashboardsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiDashboardsResponse, error)

	PostApiDashboardsWithResponse(ctx context.Context, params *PostApiDashboardsParams, body PostApiDashboardsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiDashboardsResponse, error)

	// DeleteApiDashboardsOriginOrIdWithResponse request
	DeleteApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiDashboardsOriginOrIdResponse, error)

	// GetApiDashboardsOriginOrIdWithResponse request
	GetApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiDashboardsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiDashboardsOriginOrIdResponse, error)

	// PutApiDashboardsOriginOrIdWithBodyWithResponse request with any body
	PutApiDashboardsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiDashboardsOriginOrIdResponse, error)

	PutApiDashboardsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiDashboardsOriginOrIdParams, body PutApiDashboardsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiDashboardsOriginOrIdResponse, error)

	// PostApiImportCheckRuleWithBodyWithResponse request with any body
	PostApiImportCheckRuleWithBodyWithResponse(ctx context.Context, params *PostApiImportCheckRuleParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportCheckRuleResponse, error)

	PostApiImportCheckRuleWithResponse(ctx context.Context, params *PostApiImportCheckRuleParams, body PostApiImportCheckRuleJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportCheckRuleResponse, error)

	// PostApiImportDashboardWithBodyWithResponse request with any body
	PostApiImportDashboardWithBodyWithResponse(ctx context.Context, params *PostApiImportDashboardParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportDashboardResponse, error)

	PostApiImportDashboardWithResponse(ctx context.Context, params *PostApiImportDashboardParams, body PostApiImportDashboardJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportDashboardResponse, error)

	// PostApiImportSyntheticCheckWithBodyWithResponse request with any body
	PostApiImportSyntheticCheckWithBodyWithResponse(ctx context.Context, params *PostApiImportSyntheticCheckParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportSyntheticCheckResponse, error)

	PostApiImportSyntheticCheckWithResponse(ctx context.Context, params *PostApiImportSyntheticCheckParams, body PostApiImportSyntheticCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportSyntheticCheckResponse, error)

	// PostApiImportViewWithBodyWithResponse request with any body
	PostApiImportViewWithBodyWithResponse(ctx context.Context, params *PostApiImportViewParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiImportViewResponse, error)

	PostApiImportViewWithResponse(ctx context.Context, params *PostApiImportViewParams, body PostApiImportViewJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiImportViewResponse, error)

	// PostApiLogsWithBodyWithResponse request with any body
	PostApiLogsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

	PostApiLogsWithResponse(ctx context.Context, body PostApiLogsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiLogsResponse, error)

	// GetApiSamplingRulesWithResponse request
	GetApiSamplingRulesWithResponse(ctx context.Context, params *GetApiSamplingRulesParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesResponse, error)

	// PostApiSamplingRulesWithBodyWithResponse request with any body
	PostApiSamplingRulesWithBodyWithResponse(ctx context.Context, params *PostApiSamplingRulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSamplingRulesResponse, error)

	PostApiSamplingRulesWithResponse(ctx context.Context, params *PostApiSamplingRulesParams, body PostApiSamplingRulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSamplingRulesResponse, error)

	// DeleteApiSamplingRulesOriginOrIdWithResponse request
	DeleteApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSamplingRulesOriginOrIdResponse, error)

	// GetApiSamplingRulesOriginOrIdWithResponse request
	GetApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSamplingRulesOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSamplingRulesOriginOrIdResponse, error)

	// PutApiSamplingRulesOriginOrIdWithBodyWithResponse request with any body
	PutApiSamplingRulesOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSamplingRulesOriginOrIdResponse, error)

	PutApiSamplingRulesOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSamplingRulesOriginOrIdParams, body PutApiSamplingRulesOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSamplingRulesOriginOrIdResponse, error)

	// PostApiSpansWithBodyWithResponse request with any body
	PostApiSpansWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

	PostApiSpansWithResponse(ctx context.Context, body PostApiSpansJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSpansResponse, error)

	// GetApiSyntheticChecksWithResponse request
	GetApiSyntheticChecksWithResponse(ctx context.Context, params *GetApiSyntheticChecksParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksResponse, error)

	// PostApiSyntheticChecksWithBodyWithResponse request with any body
	PostApiSyntheticChecksWithBodyWithResponse(ctx context.Context, params *PostApiSyntheticChecksParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksResponse, error)

	PostApiSyntheticChecksWithResponse(ctx context.Context, params *PostApiSyntheticChecksParams, body PostApiSyntheticChecksJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSyntheticChecksResponse, error)

	// DeleteApiSyntheticChecksOriginOrIdWithResponse request
	DeleteApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiSyntheticChecksOriginOrIdResponse, error)

	// GetApiSyntheticChecksOriginOrIdWithResponse request
	GetApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiSyntheticChecksOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiSyntheticChecksOriginOrIdResponse, error)

	// PutApiSyntheticChecksOriginOrIdWithBodyWithResponse request with any body
	PutApiSyntheticChecksOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiSyntheticChecksOriginOrIdResponse, error)

	PutApiSyntheticChecksOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiSyntheticChecksOriginOrIdParams, body PutApiSyntheticChecksOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiSyntheticChecksOriginOrIdResponse, error)

	// GetApiViewsWithResponse request
	GetApiViewsWithResponse(ctx context.Context, params *GetApiViewsParams, reqEditors ...RequestEditorFn) (*GetApiViewsResponse, error)

	// PostApiViewsWithBodyWithResponse request with any body
	PostApiViewsWithBodyWithResponse(ctx context.Context, params *PostApiViewsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

	PostApiViewsWithResponse(ctx context.Context, params *PostApiViewsParams, body PostApiViewsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiViewsResponse, error)

	// DeleteApiViewsOriginOrIdWithResponse request
	DeleteApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *DeleteApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*DeleteApiViewsOriginOrIdResponse, error)

	// GetApiViewsOriginOrIdWithResponse request
	GetApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *GetApiViewsOriginOrIdParams, reqEditors ...RequestEditorFn) (*GetApiViewsOriginOrIdResponse, error)

	// PutApiViewsOriginOrIdWithBodyWithResponse request with any body
	PutApiViewsOriginOrIdWithBodyWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)

	PutApiViewsOriginOrIdWithResponse(ctx context.Context, originOrId string, params *PutApiViewsOriginOrIdParams, body PutApiViewsOriginOrIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PutApiViewsOriginOrIdResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Cursor

type Cursor = string

Cursor The cursor to another set of results. The value of this field is opaque to the client and may be used as a parameter to the next request to get the another set of results. Cursors do not implement any ordering.

type CursorPagination

type CursorPagination struct {
	// Cursor The cursor to another set of results. The value of this field is opaque to the
	// client and may be used as a parameter to the next request to get the another set of results.
	// Cursors do not implement any ordering.
	Cursor *Cursor `json:"cursor,omitempty"`

	// Limit The maximum number of results to return. If not set, there is a default limit to the number of results returned.
	Limit *int64 `json:"limit,omitempty"`
}

CursorPagination Cursor pagination is a technique for paging through a result set using a cursor. It is similar to offset pagination except that the cursor is an opaque value that encodes the position within the result set. This allows for fetching the next page of results from the current position without having to skip over a potentially large number of rows.

It is also more resilient against late-arriving data which otherwise would cause issues with offset pagination. For example, if a row is inserted between two pages of results then the second page would contain a duplicate row and the third page would be missing.

type DashboardAnnotations

type DashboardAnnotations struct {
	Dash0ComdeletedAt  *time.Time `json:"dash0.com/deleted-at,omitempty"`
	Dash0ComfolderPath *string    `json:"dash0.com/folder-path,omitempty"`
	Dash0Comsharing    *string    `json:"dash0.com/sharing,omitempty"`
}

DashboardAnnotations defines model for DashboardAnnotations.

type DashboardApiListItem

type DashboardApiListItem struct {
	Dataset string  `json:"dataset"`
	Id      string  `json:"id"`
	Name    *string `json:"name,omitempty"`
	Origin  *string `json:"origin,omitempty"`
}

DashboardApiListItem defines model for DashboardApiListItem.

type DashboardDefinition

type DashboardDefinition struct {
	Kind     DashboardDefinitionKind `json:"kind"`
	Metadata DashboardMetadata       `json:"metadata"`
	Spec     map[string]interface{}  `json:"spec"`
}

DashboardDefinition A dashboard definition that is compatible with Perses' dashboarding system.

type DashboardDefinitionKind

type DashboardDefinitionKind string

DashboardDefinitionKind defines model for DashboardDefinition.Kind.

const (
	Dashboard DashboardDefinitionKind = "Dashboard"
)

Defines values for DashboardDefinitionKind.

type DashboardMetadata

type DashboardMetadata struct {
	Annotations     *DashboardAnnotations        `json:"annotations,omitempty"`
	CreatedAt       *time.Time                   `json:"createdAt,omitempty"`
	Dash0Extensions *DashboardMetadataExtensions `json:"dash0Extensions,omitempty"`
	Name            string                       `json:"name"`
	Project         *string                      `json:"project,omitempty"`
	UpdatedAt       *time.Time                   `json:"updatedAt,omitempty"`
	Version         *int64                       `json:"version,omitempty"`
}

DashboardMetadata defines model for DashboardMetadata.

type DashboardMetadataExtensions

type DashboardMetadataExtensions struct {
	// CreatedBy The member ID of the user who created this dashboard or dashboard version.
	CreatedBy *string `json:"createdBy,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`

	// Id An immutable id field to support automatic dashboard creation based on Kubernetes CRDs. This
	// field essentially acts as an external ID for the dashboard. We support a way to upsert dashboards based
	// on this field.
	Id *string `json:"id,omitempty"`

	// Origin This field is deprecated and is replaced by id field.
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Origin *string   `json:"origin,omitempty"`
	Tags   *[]string `json:"tags,omitempty"`
}

DashboardMetadataExtensions defines model for DashboardMetadataExtensions.

type Dataset

type Dataset = string

Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.

type DeleteApiAlertingCheckRulesOriginOrIdParams

type DeleteApiAlertingCheckRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiAlertingCheckRulesOriginOrIdParams defines parameters for DeleteApiAlertingCheckRulesOriginOrId.

type DeleteApiAlertingCheckRulesOriginOrIdResponse

type DeleteApiAlertingCheckRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiAlertingCheckRulesOriginOrIdResponse

func ParseDeleteApiAlertingCheckRulesOriginOrIdResponse(rsp *http.Response) (*DeleteApiAlertingCheckRulesOriginOrIdResponse, error)

ParseDeleteApiAlertingCheckRulesOriginOrIdResponse parses an HTTP response from a DeleteApiAlertingCheckRulesOriginOrIdWithResponse call

func (DeleteApiAlertingCheckRulesOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiAlertingCheckRulesOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteApiDashboardsOriginOrIdParams

type DeleteApiDashboardsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiDashboardsOriginOrIdParams defines parameters for DeleteApiDashboardsOriginOrId.

type DeleteApiDashboardsOriginOrIdResponse

type DeleteApiDashboardsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiDashboardsOriginOrIdResponse

func ParseDeleteApiDashboardsOriginOrIdResponse(rsp *http.Response) (*DeleteApiDashboardsOriginOrIdResponse, error)

ParseDeleteApiDashboardsOriginOrIdResponse parses an HTTP response from a DeleteApiDashboardsOriginOrIdWithResponse call

func (DeleteApiDashboardsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiDashboardsOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSamplingRulesOriginOrIdParams added in v1.1.0

type DeleteApiSamplingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiSamplingRulesOriginOrIdParams defines parameters for DeleteApiSamplingRulesOriginOrId.

type DeleteApiSamplingRulesOriginOrIdResponse added in v1.1.0

type DeleteApiSamplingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiSamplingRulesOriginOrIdResponse added in v1.1.0

func ParseDeleteApiSamplingRulesOriginOrIdResponse(rsp *http.Response) (*DeleteApiSamplingRulesOriginOrIdResponse, error)

ParseDeleteApiSamplingRulesOriginOrIdResponse parses an HTTP response from a DeleteApiSamplingRulesOriginOrIdWithResponse call

func (DeleteApiSamplingRulesOriginOrIdResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (DeleteApiSamplingRulesOriginOrIdResponse) StatusCode added in v1.1.0

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSyntheticChecksOriginOrIdParams

type DeleteApiSyntheticChecksOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiSyntheticChecksOriginOrIdParams defines parameters for DeleteApiSyntheticChecksOriginOrId.

type DeleteApiSyntheticChecksOriginOrIdResponse

type DeleteApiSyntheticChecksOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiSyntheticChecksOriginOrIdResponse

func ParseDeleteApiSyntheticChecksOriginOrIdResponse(rsp *http.Response) (*DeleteApiSyntheticChecksOriginOrIdResponse, error)

ParseDeleteApiSyntheticChecksOriginOrIdResponse parses an HTTP response from a DeleteApiSyntheticChecksOriginOrIdWithResponse call

func (DeleteApiSyntheticChecksOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiSyntheticChecksOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteApiViewsOriginOrIdParams

type DeleteApiViewsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

DeleteApiViewsOriginOrIdParams defines parameters for DeleteApiViewsOriginOrId.

type DeleteApiViewsOriginOrIdResponse

type DeleteApiViewsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSONDefault  *ErrorResponse
}

func ParseDeleteApiViewsOriginOrIdResponse

func ParseDeleteApiViewsOriginOrIdResponse(rsp *http.Response) (*DeleteApiViewsOriginOrIdResponse, error)

ParseDeleteApiViewsOriginOrIdResponse parses an HTTP response from a DeleteApiViewsOriginOrIdWithResponse call

func (DeleteApiViewsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiViewsOriginOrIdResponse) StatusCode

func (r DeleteApiViewsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Duration

type Duration = string

Duration defines model for Duration.

type Error

type Error struct {
	Code    int     `json:"code"`
	Message string  `json:"message"`
	TraceId *string `json:"traceId,omitempty"`
}

Error defines model for Error.

type ErrorAssertion

type ErrorAssertion struct {
	Kind ErrorAssertionKind `json:"kind"`
	Spec ErrorAssertionSpec `json:"spec"`
}

ErrorAssertion defines model for ErrorAssertion.

type ErrorAssertionKind

type ErrorAssertionKind string

ErrorAssertionKind defines model for ErrorAssertion.Kind.

const (
	ErrorAssertionKindError ErrorAssertionKind = "error"
)

Defines values for ErrorAssertionKind.

type ErrorAssertionSpec

type ErrorAssertionSpec struct {
	Value SyntheticHttpErrorType `json:"value"`
}

ErrorAssertionSpec defines model for ErrorAssertionSpec.

type ErrorResponse

type ErrorResponse struct {
	Error Error `json:"error"`
}

ErrorResponse defines model for ErrorResponse.

type FilterCriteria

type FilterCriteria = []AttributeFilter

FilterCriteria defines model for FilterCriteria.

type FixedTime

type FixedTime = time.Time

FixedTime A fixed point in time represented as an RFC 3339 date-time string.

**Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)

**Examples**: - `2024-01-15T14:30:00Z` - `2024-01-15T14:30:00+08:00`

type FixedTimeUnix

type FixedTimeUnix = string

FixedTimeUnix The time corresponding to the given unix time in seconds and nanoseconds (as decimal places) since January 1, 1970 UTC.

type GetApiAlertingCheckRulesOriginOrIdParams

type GetApiAlertingCheckRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiAlertingCheckRulesOriginOrIdParams defines parameters for GetApiAlertingCheckRulesOriginOrId.

type GetApiAlertingCheckRulesOriginOrIdResponse

type GetApiAlertingCheckRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParseGetApiAlertingCheckRulesOriginOrIdResponse

func ParseGetApiAlertingCheckRulesOriginOrIdResponse(rsp *http.Response) (*GetApiAlertingCheckRulesOriginOrIdResponse, error)

ParseGetApiAlertingCheckRulesOriginOrIdResponse parses an HTTP response from a GetApiAlertingCheckRulesOriginOrIdWithResponse call

func (GetApiAlertingCheckRulesOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiAlertingCheckRulesOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiAlertingCheckRulesParams

type GetApiAlertingCheckRulesParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`

	// IdPrefix If provided, only check rules for which the origin starts with the given string are returned. (deprecated)
	//
	// The `originPrefix` query parameter takes precedence over this parameter if both are provided.
	IdPrefix *string `form:"idPrefix,omitempty" json:"idPrefix,omitempty"`

	// OriginPrefix If provided, only check rules for which the origin starts with the given string are returned.
	OriginPrefix *string `form:"originPrefix,omitempty" json:"originPrefix,omitempty"`
}

GetApiAlertingCheckRulesParams defines parameters for GetApiAlertingCheckRules.

type GetApiAlertingCheckRulesResponse

type GetApiAlertingCheckRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]PrometheusAlertRuleApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiAlertingCheckRulesResponse

func ParseGetApiAlertingCheckRulesResponse(rsp *http.Response) (*GetApiAlertingCheckRulesResponse, error)

ParseGetApiAlertingCheckRulesResponse parses an HTTP response from a GetApiAlertingCheckRulesWithResponse call

func (GetApiAlertingCheckRulesResponse) Status

Status returns HTTPResponse.Status

func (GetApiAlertingCheckRulesResponse) StatusCode

func (r GetApiAlertingCheckRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiDashboardsOriginOrIdParams

type GetApiDashboardsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiDashboardsOriginOrIdParams defines parameters for GetApiDashboardsOriginOrId.

type GetApiDashboardsOriginOrIdResponse

type GetApiDashboardsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiDashboardsOriginOrIdResponse

func ParseGetApiDashboardsOriginOrIdResponse(rsp *http.Response) (*GetApiDashboardsOriginOrIdResponse, error)

ParseGetApiDashboardsOriginOrIdResponse parses an HTTP response from a GetApiDashboardsOriginOrIdWithResponse call

func (GetApiDashboardsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiDashboardsOriginOrIdResponse) StatusCode

func (r GetApiDashboardsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiDashboardsParams

type GetApiDashboardsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiDashboardsParams defines parameters for GetApiDashboards.

type GetApiDashboardsResponse

type GetApiDashboardsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]DashboardApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiDashboardsResponse

func ParseGetApiDashboardsResponse(rsp *http.Response) (*GetApiDashboardsResponse, error)

ParseGetApiDashboardsResponse parses an HTTP response from a GetApiDashboardsWithResponse call

func (GetApiDashboardsResponse) Status

func (r GetApiDashboardsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiDashboardsResponse) StatusCode

func (r GetApiDashboardsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSamplingRulesOriginOrIdParams added in v1.1.0

type GetApiSamplingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSamplingRulesOriginOrIdParams defines parameters for GetApiSamplingRulesOriginOrId.

type GetApiSamplingRulesOriginOrIdResponse added in v1.1.0

type GetApiSamplingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SamplingRuleResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSamplingRulesOriginOrIdResponse added in v1.1.0

func ParseGetApiSamplingRulesOriginOrIdResponse(rsp *http.Response) (*GetApiSamplingRulesOriginOrIdResponse, error)

ParseGetApiSamplingRulesOriginOrIdResponse parses an HTTP response from a GetApiSamplingRulesOriginOrIdWithResponse call

func (GetApiSamplingRulesOriginOrIdResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (GetApiSamplingRulesOriginOrIdResponse) StatusCode added in v1.1.0

StatusCode returns HTTPResponse.StatusCode

type GetApiSamplingRulesParams added in v1.1.0

type GetApiSamplingRulesParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSamplingRulesParams defines parameters for GetApiSamplingRules.

type GetApiSamplingRulesResponse added in v1.1.0

type GetApiSamplingRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSamplingRulesResponse
	JSONDefault  *ErrorResponse
}

func ParseGetApiSamplingRulesResponse added in v1.1.0

func ParseGetApiSamplingRulesResponse(rsp *http.Response) (*GetApiSamplingRulesResponse, error)

ParseGetApiSamplingRulesResponse parses an HTTP response from a GetApiSamplingRulesWithResponse call

func (GetApiSamplingRulesResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (GetApiSamplingRulesResponse) StatusCode added in v1.1.0

func (r GetApiSamplingRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSyntheticChecksOriginOrIdParams

type GetApiSyntheticChecksOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSyntheticChecksOriginOrIdParams defines parameters for GetApiSyntheticChecksOriginOrId.

type GetApiSyntheticChecksOriginOrIdResponse

type GetApiSyntheticChecksOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiSyntheticChecksOriginOrIdResponse

func ParseGetApiSyntheticChecksOriginOrIdResponse(rsp *http.Response) (*GetApiSyntheticChecksOriginOrIdResponse, error)

ParseGetApiSyntheticChecksOriginOrIdResponse parses an HTTP response from a GetApiSyntheticChecksOriginOrIdWithResponse call

func (GetApiSyntheticChecksOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiSyntheticChecksOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiSyntheticChecksParams

type GetApiSyntheticChecksParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiSyntheticChecksParams defines parameters for GetApiSyntheticChecks.

type GetApiSyntheticChecksResponse

type GetApiSyntheticChecksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SyntheticChecksApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiSyntheticChecksResponse

func ParseGetApiSyntheticChecksResponse(rsp *http.Response) (*GetApiSyntheticChecksResponse, error)

ParseGetApiSyntheticChecksResponse parses an HTTP response from a GetApiSyntheticChecksWithResponse call

func (GetApiSyntheticChecksResponse) Status

Status returns HTTPResponse.Status

func (GetApiSyntheticChecksResponse) StatusCode

func (r GetApiSyntheticChecksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiViewsOriginOrIdParams

type GetApiViewsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiViewsOriginOrIdParams defines parameters for GetApiViewsOriginOrId.

type GetApiViewsOriginOrIdResponse

type GetApiViewsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParseGetApiViewsOriginOrIdResponse

func ParseGetApiViewsOriginOrIdResponse(rsp *http.Response) (*GetApiViewsOriginOrIdResponse, error)

ParseGetApiViewsOriginOrIdResponse parses an HTTP response from a GetApiViewsOriginOrIdWithResponse call

func (GetApiViewsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiViewsOriginOrIdResponse) StatusCode

func (r GetApiViewsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiViewsParams

type GetApiViewsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

GetApiViewsParams defines parameters for GetApiViews.

type GetApiViewsResponse

type GetApiViewsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ViewApiListItem
	JSONDefault  *ErrorResponse
}

func ParseGetApiViewsResponse

func ParseGetApiViewsResponse(rsp *http.Response) (*GetApiViewsResponse, error)

ParseGetApiViewsResponse parses an HTTP response from a GetApiViewsWithResponse call

func (GetApiViewsResponse) Status

func (r GetApiViewsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiViewsResponse) StatusCode

func (r GetApiViewsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLogRecordsRequest

type GetLogRecordsRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset        `json:"dataset,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// Pagination Cursor pagination is a technique for paging through a result set using a cursor. It is
	// similar to offset pagination except that the cursor is an opaque value that encodes the
	// position within the result set. This allows for fetching the next page of results from
	// the current position without having to skip over a potentially large number of rows.
	//
	// It is also more resilient against late-arriving data which otherwise would cause issues
	// with offset pagination. For example, if a row is inserted between two pages of results
	// then the second page would contain a duplicate row and the third page would be missing.
	Pagination *CursorPagination `json:"pagination,omitempty"`
	Sampling   *Sampling         `json:"sampling,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

GetLogRecordsRequest defines model for GetLogRecordsRequest.

type GetLogRecordsResponse

type GetLogRecordsResponse struct {
	Cursors *NextCursors `json:"cursors,omitempty"`

	// ExecutionTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	ExecutionTime *FixedTime `json:"executionTime,omitempty"`

	// ResourceLogs There is one `ResourceLogs` per resource. This is aligned to the data most OTLP batching algorithms would
	// produce, where there is one `ResourceLogs` per resource. This is done to aid compatibility with existing
	// OTLP consumers.
	//
	// `ResourceLogs` are **NOT** sorted. There is no guarantee that `ResourceLogs` are sorted or that
	// `LogRecord`s within them are sorted. However, it is guaranteed that all data is sorted across paged
	// requests.
	//
	// Clients are advised to implement sorting within a page descending by the `LogRecord`'s `timeUnixNano`,
	// `observedTimeUnixNano` and then `id`.
	ResourceLogs []ResourceLogs `json:"resourceLogs"`
	TimeRange    *TimeRange     `json:"timeRange,omitempty"`
}

GetLogRecordsResponse Response for the `GetLogRecords` API. The response contains the log records that match the request.

This API deliberately reuses the full OTLP JSON format for logs. This is done to aid compatibility with existing OTLP consumers.

type GetSamplingRulesResponse added in v1.1.0

type GetSamplingRulesResponse struct {
	SamplingRules []SamplingDefinition `json:"samplingRules"`
}

GetSamplingRulesResponse defines model for GetSamplingRulesResponse.

type GetSpansRequest

type GetSpansRequest struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset        `json:"dataset,omitempty"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// Ordering Any supported attribute keys to order by.
	Ordering *OrderingCriteria `json:"ordering,omitempty"`

	// Pagination Cursor pagination is a technique for paging through a result set using a cursor. It is
	// similar to offset pagination except that the cursor is an opaque value that encodes the
	// position within the result set. This allows for fetching the next page of results from
	// the current position without having to skip over a potentially large number of rows.
	//
	// It is also more resilient against late-arriving data which otherwise would cause issues
	// with offset pagination. For example, if a row is inserted between two pages of results
	// then the second page would contain a duplicate row and the third page would be missing.
	Pagination *CursorPagination `json:"pagination,omitempty"`
	Sampling   *Sampling         `json:"sampling,omitempty"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

GetSpansRequest defines model for GetSpansRequest.

type GetSpansResponse

type GetSpansResponse struct {
	Cursors *NextCursors `json:"cursors,omitempty"`

	// ExecutionTime A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	ExecutionTime *FixedTime `json:"executionTime,omitempty"`

	// ResourceSpans There is one `ResourceSpan` per resource. This is aligned to the data most OTLP batching algorithms would
	// produce, where there is one `ResourceSpan` per resource. This is done to aid compatibility with existing
	// OTLP consumers.
	//
	// `Spans` nested in `ResourceSpans` are **ONLY** sorted if an explicit ordering has been defined. However,
	// it is guaranteed that all data is sorted across paged requests.
	ResourceSpans []ResourceSpans `json:"resourceSpans"`
	TimeRange     *TimeRange      `json:"timeRange,omitempty"`
}

GetSpansResponse Response for the `GetSpans` API. The response contains the spans that match the request.

This API deliberately reuses the full OTLP JSON format for spans. This is done to aid compatibility with existing OTLP consumers.

type HttpBasicAuthentication

type HttpBasicAuthentication struct {
	Password string `json:"password"`
	Username string `json:"username"`
}

HttpBasicAuthentication defines model for HttpBasicAuthentication.

type HttpCheckAssertion

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

HttpCheckAssertion defines model for HttpCheckAssertion.

func (HttpCheckAssertion) AsErrorAssertion

func (t HttpCheckAssertion) AsErrorAssertion() (ErrorAssertion, error)

AsErrorAssertion returns the union data inside the HttpCheckAssertion as a ErrorAssertion

func (HttpCheckAssertion) AsHttpResponseHeaderAssertion

func (t HttpCheckAssertion) AsHttpResponseHeaderAssertion() (HttpResponseHeaderAssertion, error)

AsHttpResponseHeaderAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseHeaderAssertion

func (HttpCheckAssertion) AsHttpResponseJsonBodyAssertion

func (t HttpCheckAssertion) AsHttpResponseJsonBodyAssertion() (HttpResponseJsonBodyAssertion, error)

AsHttpResponseJsonBodyAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseJsonBodyAssertion

func (HttpCheckAssertion) AsHttpResponseStatusCodeAssertion

func (t HttpCheckAssertion) AsHttpResponseStatusCodeAssertion() (HttpResponseStatusCodeAssertion, error)

AsHttpResponseStatusCodeAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseStatusCodeAssertion

func (HttpCheckAssertion) AsHttpResponseTextBodyAssertion

func (t HttpCheckAssertion) AsHttpResponseTextBodyAssertion() (HttpResponseTextBodyAssertion, error)

AsHttpResponseTextBodyAssertion returns the union data inside the HttpCheckAssertion as a HttpResponseTextBodyAssertion

func (HttpCheckAssertion) AsSslCertificateAssertion

func (t HttpCheckAssertion) AsSslCertificateAssertion() (SslCertificateAssertion, error)

AsSslCertificateAssertion returns the union data inside the HttpCheckAssertion as a SslCertificateAssertion

func (HttpCheckAssertion) AsTimingAssertion

func (t HttpCheckAssertion) AsTimingAssertion() (TimingAssertion, error)

AsTimingAssertion returns the union data inside the HttpCheckAssertion as a TimingAssertion

func (*HttpCheckAssertion) FromErrorAssertion

func (t *HttpCheckAssertion) FromErrorAssertion(v ErrorAssertion) error

FromErrorAssertion overwrites any union data inside the HttpCheckAssertion as the provided ErrorAssertion

func (*HttpCheckAssertion) FromHttpResponseHeaderAssertion

func (t *HttpCheckAssertion) FromHttpResponseHeaderAssertion(v HttpResponseHeaderAssertion) error

FromHttpResponseHeaderAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseHeaderAssertion

func (*HttpCheckAssertion) FromHttpResponseJsonBodyAssertion

func (t *HttpCheckAssertion) FromHttpResponseJsonBodyAssertion(v HttpResponseJsonBodyAssertion) error

FromHttpResponseJsonBodyAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseJsonBodyAssertion

func (*HttpCheckAssertion) FromHttpResponseStatusCodeAssertion

func (t *HttpCheckAssertion) FromHttpResponseStatusCodeAssertion(v HttpResponseStatusCodeAssertion) error

FromHttpResponseStatusCodeAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseStatusCodeAssertion

func (*HttpCheckAssertion) FromHttpResponseTextBodyAssertion

func (t *HttpCheckAssertion) FromHttpResponseTextBodyAssertion(v HttpResponseTextBodyAssertion) error

FromHttpResponseTextBodyAssertion overwrites any union data inside the HttpCheckAssertion as the provided HttpResponseTextBodyAssertion

func (*HttpCheckAssertion) FromSslCertificateAssertion

func (t *HttpCheckAssertion) FromSslCertificateAssertion(v SslCertificateAssertion) error

FromSslCertificateAssertion overwrites any union data inside the HttpCheckAssertion as the provided SslCertificateAssertion

func (*HttpCheckAssertion) FromTimingAssertion

func (t *HttpCheckAssertion) FromTimingAssertion(v TimingAssertion) error

FromTimingAssertion overwrites any union data inside the HttpCheckAssertion as the provided TimingAssertion

func (HttpCheckAssertion) MarshalJSON

func (t HttpCheckAssertion) MarshalJSON() ([]byte, error)

func (*HttpCheckAssertion) MergeErrorAssertion

func (t *HttpCheckAssertion) MergeErrorAssertion(v ErrorAssertion) error

MergeErrorAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided ErrorAssertion

func (*HttpCheckAssertion) MergeHttpResponseHeaderAssertion

func (t *HttpCheckAssertion) MergeHttpResponseHeaderAssertion(v HttpResponseHeaderAssertion) error

MergeHttpResponseHeaderAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseHeaderAssertion

func (*HttpCheckAssertion) MergeHttpResponseJsonBodyAssertion

func (t *HttpCheckAssertion) MergeHttpResponseJsonBodyAssertion(v HttpResponseJsonBodyAssertion) error

MergeHttpResponseJsonBodyAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseJsonBodyAssertion

func (*HttpCheckAssertion) MergeHttpResponseStatusCodeAssertion

func (t *HttpCheckAssertion) MergeHttpResponseStatusCodeAssertion(v HttpResponseStatusCodeAssertion) error

MergeHttpResponseStatusCodeAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseStatusCodeAssertion

func (*HttpCheckAssertion) MergeHttpResponseTextBodyAssertion

func (t *HttpCheckAssertion) MergeHttpResponseTextBodyAssertion(v HttpResponseTextBodyAssertion) error

MergeHttpResponseTextBodyAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided HttpResponseTextBodyAssertion

func (*HttpCheckAssertion) MergeSslCertificateAssertion

func (t *HttpCheckAssertion) MergeSslCertificateAssertion(v SslCertificateAssertion) error

MergeSslCertificateAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided SslCertificateAssertion

func (*HttpCheckAssertion) MergeTimingAssertion

func (t *HttpCheckAssertion) MergeTimingAssertion(v TimingAssertion) error

MergeTimingAssertion performs a merge with any union data inside the HttpCheckAssertion, using the provided TimingAssertion

func (*HttpCheckAssertion) UnmarshalJSON

func (t *HttpCheckAssertion) UnmarshalJSON(b []byte) error

type HttpCheckAssertions

type HttpCheckAssertions = []HttpCheckAssertion

HttpCheckAssertions defines model for HttpCheckAssertions.

type HttpHeaders

type HttpHeaders = []NameValuePair

HttpHeaders defines model for HttpHeaders.

type HttpQueryParameters

type HttpQueryParameters = []NameValuePair

HttpQueryParameters defines model for HttpQueryParameters.

type HttpRedirects

type HttpRedirects string

HttpRedirects defines model for HttpRedirects.

const (
	HttpRedirectsDisabled HttpRedirects = "disabled"
	HttpRedirectsFollow   HttpRedirects = "follow"
)

Defines values for HttpRedirects.

type HttpRequestBody

type HttpRequestBody struct {
	Kind HttpRequestBodyKind `json:"kind"`
	Spec struct {
		Content string `json:"content"`
	} `json:"spec"`
}

HttpRequestBody defines model for HttpRequestBody.

type HttpRequestBodyKind

type HttpRequestBodyKind string

HttpRequestBodyKind defines model for HttpRequestBodyKind.

const (
	Form    HttpRequestBodyKind = "form"
	Graphql HttpRequestBodyKind = "graphql"
	Json    HttpRequestBodyKind = "json"
	Raw     HttpRequestBodyKind = "raw"
)

Defines values for HttpRequestBodyKind.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type HttpRequestMethod

type HttpRequestMethod string

HttpRequestMethod defines model for HttpRequestMethod.

const (
	Delete HttpRequestMethod = "delete"
	Get    HttpRequestMethod = "get"
	Head   HttpRequestMethod = "head"
	Patch  HttpRequestMethod = "patch"
	Post   HttpRequestMethod = "post"
	Put    HttpRequestMethod = "put"
)

Defines values for HttpRequestMethod.

type HttpRequestSpec

type HttpRequestSpec struct {
	BasicAuthentication *HttpBasicAuthentication `json:"basicAuthentication,omitempty"`
	Body                *HttpRequestBody         `json:"body,omitempty"`
	Headers             HttpHeaders              `json:"headers"`
	Method              HttpRequestMethod        `json:"method"`
	QueryParameters     HttpQueryParameters      `json:"queryParameters"`
	Redirects           HttpRedirects            `json:"redirects"`
	Tls                 TlsSettings              `json:"tls"`
	Tracing             TracingSettings          `json:"tracing"`
	Url                 string                   `json:"url"`
}

HttpRequestSpec defines model for HttpRequestSpec.

type HttpResponseHeaderAssertion

type HttpResponseHeaderAssertion struct {
	Kind HttpResponseHeaderAssertionKind `json:"kind"`
	Spec HttpResponseHeaderAssertionSpec `json:"spec"`
}

HttpResponseHeaderAssertion defines model for HttpResponseHeaderAssertion.

type HttpResponseHeaderAssertionKind

type HttpResponseHeaderAssertionKind string

HttpResponseHeaderAssertionKind defines model for HttpResponseHeaderAssertion.Kind.

const (
	ResponseHeader HttpResponseHeaderAssertionKind = "response_header"
)

Defines values for HttpResponseHeaderAssertionKind.

type HttpResponseHeaderAssertionSpec

type HttpResponseHeaderAssertionSpec struct {
	Key      string                  `json:"key"`
	Operator StringAssertionOperator `json:"operator"`
	Value    string                  `json:"value"`
}

HttpResponseHeaderAssertionSpec defines model for HttpResponseHeaderAssertionSpec.

type HttpResponseJsonBodyAssertion

type HttpResponseJsonBodyAssertion struct {
	Kind HttpResponseJsonBodyAssertionKind `json:"kind"`
	Spec HttpResponseJsonBodyAssertionSpec `json:"spec"`
}

HttpResponseJsonBodyAssertion defines model for HttpResponseJsonBodyAssertion.

type HttpResponseJsonBodyAssertionKind

type HttpResponseJsonBodyAssertionKind string

HttpResponseJsonBodyAssertionKind defines model for HttpResponseJsonBodyAssertion.Kind.

const (
	JsonBody HttpResponseJsonBodyAssertionKind = "json_body"
)

Defines values for HttpResponseJsonBodyAssertionKind.

type HttpResponseJsonBodyAssertionSpec

type HttpResponseJsonBodyAssertionSpec struct {
	JsonPath string                  `json:"jsonPath"`
	Operator StringAssertionOperator `json:"operator"`
	Value    string                  `json:"value"`
}

HttpResponseJsonBodyAssertionSpec defines model for HttpResponseJsonBodyAssertionSpec.

type HttpResponseStatusCodeAssertion

type HttpResponseStatusCodeAssertion struct {
	Kind HttpResponseStatusCodeAssertionKind `json:"kind"`
	Spec HttpResponseStatusCodeAssertionSpec `json:"spec"`
}

HttpResponseStatusCodeAssertion defines model for HttpResponseStatusCodeAssertion.

type HttpResponseStatusCodeAssertionKind

type HttpResponseStatusCodeAssertionKind string

HttpResponseStatusCodeAssertionKind defines model for HttpResponseStatusCodeAssertion.Kind.

const (
	StatusCode HttpResponseStatusCodeAssertionKind = "status_code"
)

Defines values for HttpResponseStatusCodeAssertionKind.

type HttpResponseStatusCodeAssertionSpec

type HttpResponseStatusCodeAssertionSpec struct {
	Operator NumericAssertionOperator `json:"operator"`
	Value    string                   `json:"value"`
}

HttpResponseStatusCodeAssertionSpec defines model for HttpResponseStatusCodeAssertionSpec.

type HttpResponseTextBodyAssertion

type HttpResponseTextBodyAssertion struct {
	Kind HttpResponseTextBodyAssertionKind `json:"kind"`
	Spec HttpResponseTextBodyAssertionSpec `json:"spec"`
}

HttpResponseTextBodyAssertion defines model for HttpResponseTextBodyAssertion.

type HttpResponseTextBodyAssertionKind

type HttpResponseTextBodyAssertionKind string

HttpResponseTextBodyAssertionKind defines model for HttpResponseTextBodyAssertion.Kind.

const (
	TextBody HttpResponseTextBodyAssertionKind = "text_body"
)

Defines values for HttpResponseTextBodyAssertionKind.

type HttpResponseTextBodyAssertionSpec

type HttpResponseTextBodyAssertionSpec struct {
	Operator StringAssertionOperator `json:"operator"`
	Value    string                  `json:"value"`
}

HttpResponseTextBodyAssertionSpec defines model for HttpResponseTextBodyAssertionSpec.

type InstrumentationScope

type InstrumentationScope struct {
	// Attributes Additional attributes that describe the scope. [Optional]. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
	Attributes             []KeyValue `json:"attributes"`
	DroppedAttributesCount *int64     `json:"droppedAttributesCount,omitempty"`

	// Name An empty instrumentation scope name means the name is unknown.
	Name    *string `json:"name,omitempty"`
	Version *string `json:"version,omitempty"`
}

InstrumentationScope InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.

type Iter

type Iter[T any] struct {
	// contains filtered or unexported fields
}

Iter provides iteration over paginated API results. Use Next() to advance, Current() to get the item, and Err() to check for errors.

Example:

iter := client.GetSpansIter(ctx, request)
for iter.Next() {
    span := iter.Current()
    // process span
}
if err := iter.Err(); err != nil {
    // handle error
}

Iterators are not thread-safe. Do not share an iterator across goroutines.

func (*Iter[T]) Current

func (it *Iter[T]) Current() *T

Current returns the current item in the iteration. Returns nil if Next() has not been called or returned false.

func (*Iter[T]) Err

func (it *Iter[T]) Err() error

Err returns any error that occurred during iteration. Should be checked after Next() returns false.

func (*Iter[T]) Next

func (it *Iter[T]) Next() bool

Next advances the iterator to the next item. Returns true if there is a next item, false if iteration is complete or an error occurred.

type KeyValue

type KeyValue struct {
	Key string `json:"key"`

	// Value AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.
	Value AnyValue `json:"value"`
}

KeyValue KeyValue is a key-value pair that is used to store Span attributes, Link attributes, etc.

type LogRecord

type LogRecord struct {
	Attributes []KeyValue `json:"attributes"`

	// Body AnyValue is used to represent any type of attribute value. AnyValue may contain a primitive value such as a string or integer or it may contain an arbitrary nested object containing arrays, key-value lists and primitives.
	Body *AnyValue `json:"body,omitempty"`

	// Dash0EventId The ID of the log record. This is a non-standard OTLP field. The property is only included when
	// `includeOTLPSchemaExtensions` is `true`.
	Dash0EventId           *string `json:"dash0EventId,omitempty"`
	DroppedAttributesCount *int64  `json:"droppedAttributesCount,omitempty"`
	EventName              *string `json:"eventName,omitempty"`
	Flags                  *int64  `json:"flags,omitempty"`

	// Id The ID of the log record. This is a non-standard OTLP field. The property is only included when
	// `includeOTLPSchemaExtensions` is `true`.
	Id                   *string `json:"id,omitempty"`
	ObservedTimeUnixNano string  `json:"observedTimeUnixNano"`

	// SeverityNumber SEVERITY_NUMBER_UNSPECIFIED = 0;
	// SEVERITY_NUMBER_TRACE  = 1;
	// SEVERITY_NUMBER_TRACE2 = 2;
	// SEVERITY_NUMBER_TRACE3 = 3;
	// SEVERITY_NUMBER_TRACE4 = 4;
	// SEVERITY_NUMBER_DEBUG  = 5;
	// SEVERITY_NUMBER_DEBUG2 = 6;
	// SEVERITY_NUMBER_DEBUG3 = 7;
	// SEVERITY_NUMBER_DEBUG4 = 8;
	// SEVERITY_NUMBER_INFO   = 9;
	// SEVERITY_NUMBER_INFO2  = 10;
	// SEVERITY_NUMBER_INFO3  = 11;
	// SEVERITY_NUMBER_INFO4  = 12;
	// SEVERITY_NUMBER_WARN   = 13;
	// SEVERITY_NUMBER_WARN2  = 14;
	// SEVERITY_NUMBER_WARN3  = 15;
	// SEVERITY_NUMBER_WARN4  = 16;
	// SEVERITY_NUMBER_ERROR  = 17;
	// SEVERITY_NUMBER_ERROR2 = 18;
	// SEVERITY_NUMBER_ERROR3 = 19;
	// SEVERITY_NUMBER_ERROR4 = 20;
	// SEVERITY_NUMBER_FATAL  = 21;
	// SEVERITY_NUMBER_FATAL2 = 22;
	// SEVERITY_NUMBER_FATAL3 = 23;
	// SEVERITY_NUMBER_FATAL4 = 24;
	SeverityNumber *SeverityNumber `json:"severityNumber,omitempty"`
	SeverityText   *string         `json:"severityText,omitempty"`
	SpanId         *[]byte         `json:"spanId,omitempty"`
	TimeUnixNano   string          `json:"timeUnixNano"`
	TraceId        *[]byte         `json:"traceId,omitempty"`
}

LogRecord defines model for LogRecord.

type NameValuePair

type NameValuePair struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

NameValuePair defines model for NameValuePair.

type NextCursors

type NextCursors struct {
	// After The cursor to another set of results. The value of this field is opaque to the
	// client and may be used as a parameter to the next request to get the another set of results.
	// Cursors do not implement any ordering.
	After *Cursor `json:"after,omitempty"`

	// Before The cursor to another set of results. The value of this field is opaque to the
	// client and may be used as a parameter to the next request to get the another set of results.
	// Cursors do not implement any ordering.
	Before *Cursor `json:"before,omitempty"`
}

NextCursors defines model for NextCursors.

type NumericAssertionOperator

type NumericAssertionOperator string

NumericAssertionOperator defines model for NumericAssertionOperator.

const (
	NumericAssertionOperatorGt    NumericAssertionOperator = "gt"
	NumericAssertionOperatorGte   NumericAssertionOperator = "gte"
	NumericAssertionOperatorIs    NumericAssertionOperator = "is"
	NumericAssertionOperatorIsNot NumericAssertionOperator = "is_not"
	NumericAssertionOperatorLt    NumericAssertionOperator = "lt"
	NumericAssertionOperatorLte   NumericAssertionOperator = "lte"
)

Defines values for NumericAssertionOperator.

type OrderingCriteria

type OrderingCriteria = []OrderingCriterion

OrderingCriteria Any supported attribute keys to order by.

type OrderingCriterion

type OrderingCriterion struct {
	Direction OrderingDirection `json:"direction"`

	// Key Any attribute key to order by.
	Key OrderingKey `json:"key"`
}

OrderingCriterion Any combination of a supported key to order by and a direction.

type OrderingDirection

type OrderingDirection string

OrderingDirection defines model for OrderingDirection.

const (
	Ascending  OrderingDirection = "ascending"
	Descending OrderingDirection = "descending"
)

Defines values for OrderingDirection.

type OrderingKey

type OrderingKey = string

OrderingKey Any attribute key to order by.

type PostApiAlertingCheckRulesJSONRequestBody

type PostApiAlertingCheckRulesJSONRequestBody = PrometheusAlertRule

PostApiAlertingCheckRulesJSONRequestBody defines body for PostApiAlertingCheckRules for application/json ContentType.

type PostApiAlertingCheckRulesParams

type PostApiAlertingCheckRulesParams struct {
	// Dataset The associated dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiAlertingCheckRulesParams defines parameters for PostApiAlertingCheckRules.

type PostApiAlertingCheckRulesResponse

type PostApiAlertingCheckRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParsePostApiAlertingCheckRulesResponse

func ParsePostApiAlertingCheckRulesResponse(rsp *http.Response) (*PostApiAlertingCheckRulesResponse, error)

ParsePostApiAlertingCheckRulesResponse parses an HTTP response from a PostApiAlertingCheckRulesWithResponse call

func (PostApiAlertingCheckRulesResponse) Status

Status returns HTTPResponse.Status

func (PostApiAlertingCheckRulesResponse) StatusCode

func (r PostApiAlertingCheckRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiDashboardsJSONRequestBody

type PostApiDashboardsJSONRequestBody = DashboardDefinition

PostApiDashboardsJSONRequestBody defines body for PostApiDashboards for application/json ContentType.

type PostApiDashboardsParams

type PostApiDashboardsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiDashboardsParams defines parameters for PostApiDashboards.

type PostApiDashboardsResponse

type PostApiDashboardsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiDashboardsResponse

func ParsePostApiDashboardsResponse(rsp *http.Response) (*PostApiDashboardsResponse, error)

ParsePostApiDashboardsResponse parses an HTTP response from a PostApiDashboardsWithResponse call

func (PostApiDashboardsResponse) Status

func (r PostApiDashboardsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiDashboardsResponse) StatusCode

func (r PostApiDashboardsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiImportCheckRuleJSONRequestBody

type PostApiImportCheckRuleJSONRequestBody = PrometheusAlertRule

PostApiImportCheckRuleJSONRequestBody defines body for PostApiImportCheckRule for application/json ContentType.

type PostApiImportCheckRuleParams

type PostApiImportCheckRuleParams struct {
	// Dataset The associated dataset.
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportCheckRuleParams defines parameters for PostApiImportCheckRule.

type PostApiImportCheckRuleResponse

type PostApiImportCheckRuleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportCheckRuleResponse

func ParsePostApiImportCheckRuleResponse(rsp *http.Response) (*PostApiImportCheckRuleResponse, error)

ParsePostApiImportCheckRuleResponse parses an HTTP response from a PostApiImportCheckRuleWithResponse call

func (PostApiImportCheckRuleResponse) Status

Status returns HTTPResponse.Status

func (PostApiImportCheckRuleResponse) StatusCode

func (r PostApiImportCheckRuleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiImportDashboardJSONRequestBody

type PostApiImportDashboardJSONRequestBody = DashboardDefinition

PostApiImportDashboardJSONRequestBody defines body for PostApiImportDashboard for application/json ContentType.

type PostApiImportDashboardParams

type PostApiImportDashboardParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportDashboardParams defines parameters for PostApiImportDashboard.

type PostApiImportDashboardResponse

type PostApiImportDashboardResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportDashboardResponse

func ParsePostApiImportDashboardResponse(rsp *http.Response) (*PostApiImportDashboardResponse, error)

ParsePostApiImportDashboardResponse parses an HTTP response from a PostApiImportDashboardWithResponse call

func (PostApiImportDashboardResponse) Status

Status returns HTTPResponse.Status

func (PostApiImportDashboardResponse) StatusCode

func (r PostApiImportDashboardResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiImportSyntheticCheckJSONRequestBody

type PostApiImportSyntheticCheckJSONRequestBody = SyntheticCheckDefinition

PostApiImportSyntheticCheckJSONRequestBody defines body for PostApiImportSyntheticCheck for application/json ContentType.

type PostApiImportSyntheticCheckParams

type PostApiImportSyntheticCheckParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportSyntheticCheckParams defines parameters for PostApiImportSyntheticCheck.

type PostApiImportSyntheticCheckResponse

type PostApiImportSyntheticCheckResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportSyntheticCheckResponse

func ParsePostApiImportSyntheticCheckResponse(rsp *http.Response) (*PostApiImportSyntheticCheckResponse, error)

ParsePostApiImportSyntheticCheckResponse parses an HTTP response from a PostApiImportSyntheticCheckWithResponse call

func (PostApiImportSyntheticCheckResponse) Status

Status returns HTTPResponse.Status

func (PostApiImportSyntheticCheckResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostApiImportViewJSONRequestBody

type PostApiImportViewJSONRequestBody = ViewDefinition

PostApiImportViewJSONRequestBody defines body for PostApiImportView for application/json ContentType.

type PostApiImportViewParams

type PostApiImportViewParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiImportViewParams defines parameters for PostApiImportView.

type PostApiImportViewResponse

type PostApiImportViewResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiImportViewResponse

func ParsePostApiImportViewResponse(rsp *http.Response) (*PostApiImportViewResponse, error)

ParsePostApiImportViewResponse parses an HTTP response from a PostApiImportViewWithResponse call

func (PostApiImportViewResponse) Status

func (r PostApiImportViewResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiImportViewResponse) StatusCode

func (r PostApiImportViewResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiLogsJSONRequestBody

type PostApiLogsJSONRequestBody = GetLogRecordsRequest

PostApiLogsJSONRequestBody defines body for PostApiLogs for application/json ContentType.

type PostApiLogsResponse

type PostApiLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetLogRecordsResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiLogsResponse

func ParsePostApiLogsResponse(rsp *http.Response) (*PostApiLogsResponse, error)

ParsePostApiLogsResponse parses an HTTP response from a PostApiLogsWithResponse call

func (PostApiLogsResponse) Status

func (r PostApiLogsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiLogsResponse) StatusCode

func (r PostApiLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSamplingRulesJSONRequestBody added in v1.1.0

type PostApiSamplingRulesJSONRequestBody = SamplingRuleCreateRequest

PostApiSamplingRulesJSONRequestBody defines body for PostApiSamplingRules for application/json ContentType.

type PostApiSamplingRulesParams added in v1.1.0

type PostApiSamplingRulesParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSamplingRulesParams defines parameters for PostApiSamplingRules.

type PostApiSamplingRulesResponse added in v1.1.0

type PostApiSamplingRulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SamplingRuleResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSamplingRulesResponse added in v1.1.0

func ParsePostApiSamplingRulesResponse(rsp *http.Response) (*PostApiSamplingRulesResponse, error)

ParsePostApiSamplingRulesResponse parses an HTTP response from a PostApiSamplingRulesWithResponse call

func (PostApiSamplingRulesResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (PostApiSamplingRulesResponse) StatusCode added in v1.1.0

func (r PostApiSamplingRulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSpansJSONRequestBody

type PostApiSpansJSONRequestBody = GetSpansRequest

PostApiSpansJSONRequestBody defines body for PostApiSpans for application/json ContentType.

type PostApiSpansResponse

type PostApiSpansResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GetSpansResponse
	JSONDefault  *ErrorResponse
}

func ParsePostApiSpansResponse

func ParsePostApiSpansResponse(rsp *http.Response) (*PostApiSpansResponse, error)

ParsePostApiSpansResponse parses an HTTP response from a PostApiSpansWithResponse call

func (PostApiSpansResponse) Status

func (r PostApiSpansResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiSpansResponse) StatusCode

func (r PostApiSpansResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSyntheticChecksJSONRequestBody

type PostApiSyntheticChecksJSONRequestBody = SyntheticCheckDefinition

PostApiSyntheticChecksJSONRequestBody defines body for PostApiSyntheticChecks for application/json ContentType.

type PostApiSyntheticChecksParams

type PostApiSyntheticChecksParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiSyntheticChecksParams defines parameters for PostApiSyntheticChecks.

type PostApiSyntheticChecksResponse

type PostApiSyntheticChecksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiSyntheticChecksResponse

func ParsePostApiSyntheticChecksResponse(rsp *http.Response) (*PostApiSyntheticChecksResponse, error)

ParsePostApiSyntheticChecksResponse parses an HTTP response from a PostApiSyntheticChecksWithResponse call

func (PostApiSyntheticChecksResponse) Status

Status returns HTTPResponse.Status

func (PostApiSyntheticChecksResponse) StatusCode

func (r PostApiSyntheticChecksResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiViewsJSONRequestBody

type PostApiViewsJSONRequestBody = ViewDefinition

PostApiViewsJSONRequestBody defines body for PostApiViews for application/json ContentType.

type PostApiViewsParams

type PostApiViewsParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PostApiViewsParams defines parameters for PostApiViews.

type PostApiViewsResponse

type PostApiViewsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParsePostApiViewsResponse

func ParsePostApiViewsResponse(rsp *http.Response) (*PostApiViewsResponse, error)

ParsePostApiViewsResponse parses an HTTP response from a PostApiViewsWithResponse call

func (PostApiViewsResponse) Status

func (r PostApiViewsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiViewsResponse) StatusCode

func (r PostApiViewsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PrometheusAlertRule

type PrometheusAlertRule struct {
	// Annotations Annotations are key-value pairs that can be used to add additional metadata to a check. They map
	// to Prometheus alerting rules' "annotations" field.
	Annotations *map[string]string `json:"annotations,omitempty"`

	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset *Dataset `json:"dataset,omitempty"`

	// Description Human-readable and templatable description for the check that allows you to customize the way the
	// rationale of the check is textually described in the Dash0 UI, in notifications, etc. This will
	// be optimized in the design for long form viewing.
	Description *string `json:"description,omitempty"`

	// Enabled A boolean flag to enable or disable the check rule. When a check rule is disabled, it will not be
	// evaluated, and no check evaluations will be created. This field is optional and defaults to true.
	Enabled *bool `json:"enabled,omitempty"`

	// Expression An editable PromQL expression that can leverage the complete Dash0 Query Language. It furthermore
	// supports a variable called $__threshold.
	//
	// - `$__threshold` can be used as a placeholder for both the degraded and failed thresholds. The
	//   thresholds are defined in the thresholds field. When `$__threshold` is used in the expression,
	//   the `thresholds` field is required and at least one of the thresholds must be defined.
	//
	//   Usage of `$__threshold` implies that the PromQL expression may have to be evaluated up to two
	//   times using the degraded threshold and critical threshold respectively.
	//
	// - Top-level AND statements are treated as enablement conditions that specify when the check should
	//   "be running", i.e., is active. The use-cases for enablement conditions are several, e.g., requiring
	//   a minimum amount of requests being served before triggering due to errors rates,
	//   maintenance windows or muted timeframes.
	Expression string    `json:"expression"`
	For        *Duration `json:"for,omitempty"`

	// Id User defined id for getting/updating/deleting the alert rule through the API.
	Id            *string   `json:"id,omitempty"`
	Interval      *Duration `json:"interval,omitempty"`
	KeepFiringFor *Duration `json:"keepFiringFor,omitempty"`

	// Labels Label are key-value pairs that can be used to add additional metadata to a check. They map
	// to Prometheus alerting rules' "labels" field.
	Labels *map[string]string `json:"labels,omitempty"`

	// Name Human-readable and templatable name for the check. In Prometheus alerting rules this is called "alert".
	Name string `json:"name"`

	// Summary Human-readable and templatable summary for the check that allows you to customize the way the check
	// is textually described in short form in the Dash0 UI, in notifications, etc
	Summary *string `json:"summary,omitempty"`

	// Thresholds Thresholds to use for the `$__threshold` variable in the expression field.
	Thresholds *CheckThresholds `json:"thresholds,omitempty"`
}

PrometheusAlertRule Check rules represent a periodically evaluated expression to determine the health of a resource. The result of the evaluation are zero or more CheckEvaluations.

type PrometheusAlertRuleApiListItem

type PrometheusAlertRuleApiListItem struct {
	// Dataset Optional dataset to query across. Defaults to whatever is configured to be the default dataset for the organization.
	Dataset Dataset `json:"dataset"`

	// Id The unique identifier of the check rule.
	//
	// For backward compatibility, this field is also filled with the origin, if it exists.
	// However in a future version, this field will only return the actual check rule ID.
	Id string `json:"id"`

	// Name Human-readable and templatable name for the check. In Prometheus alerting rules this is called "alert".
	Name *string `json:"name,omitempty"`

	// Origin User defined origin for getting/updating/deleting the alert rule through the API.
	Origin *string `json:"origin,omitempty"`
}

PrometheusAlertRuleApiListItem The ID, origin, dataset, and the name of a check rule.

type PutApiAlertingCheckRulesOriginOrIdJSONRequestBody

type PutApiAlertingCheckRulesOriginOrIdJSONRequestBody = PrometheusAlertRule

PutApiAlertingCheckRulesOriginOrIdJSONRequestBody defines body for PutApiAlertingCheckRulesOriginOrId for application/json ContentType.

type PutApiAlertingCheckRulesOriginOrIdParams

type PutApiAlertingCheckRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiAlertingCheckRulesOriginOrIdParams defines parameters for PutApiAlertingCheckRulesOriginOrId.

type PutApiAlertingCheckRulesOriginOrIdResponse

type PutApiAlertingCheckRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *PrometheusAlertRule
	JSONDefault  *ErrorResponse
}

func ParsePutApiAlertingCheckRulesOriginOrIdResponse

func ParsePutApiAlertingCheckRulesOriginOrIdResponse(rsp *http.Response) (*PutApiAlertingCheckRulesOriginOrIdResponse, error)

ParsePutApiAlertingCheckRulesOriginOrIdResponse parses an HTTP response from a PutApiAlertingCheckRulesOriginOrIdWithResponse call

func (PutApiAlertingCheckRulesOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiAlertingCheckRulesOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PutApiDashboardsOriginOrIdJSONRequestBody

type PutApiDashboardsOriginOrIdJSONRequestBody = DashboardDefinition

PutApiDashboardsOriginOrIdJSONRequestBody defines body for PutApiDashboardsOriginOrId for application/json ContentType.

type PutApiDashboardsOriginOrIdParams

type PutApiDashboardsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiDashboardsOriginOrIdParams defines parameters for PutApiDashboardsOriginOrId.

type PutApiDashboardsOriginOrIdResponse

type PutApiDashboardsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *DashboardDefinition
	JSONDefault  *ErrorResponse
}

func ParsePutApiDashboardsOriginOrIdResponse

func ParsePutApiDashboardsOriginOrIdResponse(rsp *http.Response) (*PutApiDashboardsOriginOrIdResponse, error)

ParsePutApiDashboardsOriginOrIdResponse parses an HTTP response from a PutApiDashboardsOriginOrIdWithResponse call

func (PutApiDashboardsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiDashboardsOriginOrIdResponse) StatusCode

func (r PutApiDashboardsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PutApiSamplingRulesOriginOrIdJSONRequestBody added in v1.1.0

type PutApiSamplingRulesOriginOrIdJSONRequestBody = SamplingRuleResponse

PutApiSamplingRulesOriginOrIdJSONRequestBody defines body for PutApiSamplingRulesOriginOrId for application/json ContentType.

type PutApiSamplingRulesOriginOrIdParams added in v1.1.0

type PutApiSamplingRulesOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiSamplingRulesOriginOrIdParams defines parameters for PutApiSamplingRulesOriginOrId.

type PutApiSamplingRulesOriginOrIdResponse added in v1.1.0

type PutApiSamplingRulesOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SamplingRuleResponse
	JSON403      *ErrorResponse
	JSONDefault  *ErrorResponse
}

func ParsePutApiSamplingRulesOriginOrIdResponse added in v1.1.0

func ParsePutApiSamplingRulesOriginOrIdResponse(rsp *http.Response) (*PutApiSamplingRulesOriginOrIdResponse, error)

ParsePutApiSamplingRulesOriginOrIdResponse parses an HTTP response from a PutApiSamplingRulesOriginOrIdWithResponse call

func (PutApiSamplingRulesOriginOrIdResponse) Status added in v1.1.0

Status returns HTTPResponse.Status

func (PutApiSamplingRulesOriginOrIdResponse) StatusCode added in v1.1.0

StatusCode returns HTTPResponse.StatusCode

type PutApiSyntheticChecksOriginOrIdJSONRequestBody

type PutApiSyntheticChecksOriginOrIdJSONRequestBody = SyntheticCheckDefinition

PutApiSyntheticChecksOriginOrIdJSONRequestBody defines body for PutApiSyntheticChecksOriginOrId for application/json ContentType.

type PutApiSyntheticChecksOriginOrIdParams

type PutApiSyntheticChecksOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiSyntheticChecksOriginOrIdParams defines parameters for PutApiSyntheticChecksOriginOrId.

type PutApiSyntheticChecksOriginOrIdResponse

type PutApiSyntheticChecksOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SyntheticCheckDefinition
	JSONDefault  *ErrorResponse
}

func ParsePutApiSyntheticChecksOriginOrIdResponse

func ParsePutApiSyntheticChecksOriginOrIdResponse(rsp *http.Response) (*PutApiSyntheticChecksOriginOrIdResponse, error)

ParsePutApiSyntheticChecksOriginOrIdResponse parses an HTTP response from a PutApiSyntheticChecksOriginOrIdWithResponse call

func (PutApiSyntheticChecksOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiSyntheticChecksOriginOrIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PutApiViewsOriginOrIdJSONRequestBody

type PutApiViewsOriginOrIdJSONRequestBody = ViewDefinition

PutApiViewsOriginOrIdJSONRequestBody defines body for PutApiViewsOriginOrId for application/json ContentType.

type PutApiViewsOriginOrIdParams

type PutApiViewsOriginOrIdParams struct {
	Dataset *Dataset `form:"dataset,omitempty" json:"dataset,omitempty"`
}

PutApiViewsOriginOrIdParams defines parameters for PutApiViewsOriginOrId.

type PutApiViewsOriginOrIdResponse

type PutApiViewsOriginOrIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ViewDefinition
	JSONDefault  *ErrorResponse
}

func ParsePutApiViewsOriginOrIdResponse

func ParsePutApiViewsOriginOrIdResponse(rsp *http.Response) (*PutApiViewsOriginOrIdResponse, error)

ParsePutApiViewsOriginOrIdResponse parses an HTTP response from a PutApiViewsOriginOrIdWithResponse call

func (PutApiViewsOriginOrIdResponse) Status

Status returns HTTPResponse.Status

func (PutApiViewsOriginOrIdResponse) StatusCode

func (r PutApiViewsOriginOrIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RelativeTime

type RelativeTime = string

RelativeTime A relative time reference based on the current time ("now").

**Format**: `now[+/-duration]`

**Examples**: - `now` - current time - `now-30m` - 30 minutes ago - `now-1h` - 1 hour ago - `now-1d` - 1 day ago

**Duration Units**: - `s` - seconds - `m` - minutes - `h` - hours - `d` - days - `w` - weeks - `M` - months

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Resource

type Resource struct {
	Attributes             []KeyValue                      `json:"attributes"`
	Clouds                 *ResourceClouds                 `json:"clouds,omitempty"`
	DeploymentEnvironments *ResourceDeploymentEnvironments `json:"deploymentEnvironments,omitempty"`
	DroppedAttributesCount *int64                          `json:"droppedAttributesCount,omitempty"`

	// FirstSeenUnixNano The property is only included when `includeOTLPSchemaExtensions` is `true`.
	FirstSeenUnixNano *string            `json:"firstSeenUnixNano,omitempty"`
	Languages         *ResourceLanguages `json:"languages,omitempty"`

	// LastSeenUnixNano The property is only included when `includeOTLPSchemaExtensions` is `true`.
	LastSeenUnixNano *string `json:"lastSeenUnixNano,omitempty"`

	// OperationTypes The property is only included when `includeOTLPSchemaExtensions` is `true`.
	OperationTypes *[]string               `json:"operationTypes,omitempty"`
	Orchestrations *ResourceOrchestrations `json:"orchestrations,omitempty"`
}

Resource defines model for Resource.

type ResourceCloud

type ResourceCloud = string

ResourceCloud Resource cloud identified based on the `cloud.provider` resource attribute. Some sample values: - alibaba_cloud - aws - azure - gcp - heroku - ibm_cloud - tencent_cloud

type ResourceClouds

type ResourceClouds = []ResourceCloud

ResourceClouds defines model for ResourceClouds.

type ResourceDeploymentEnvironment

type ResourceDeploymentEnvironment = string

ResourceDeploymentEnvironment The value of the `deployment.environment.name` (or `deployment.environment` pre v1.27 semconvs)

type ResourceDeploymentEnvironments

type ResourceDeploymentEnvironments = []ResourceDeploymentEnvironment

ResourceDeploymentEnvironments defines model for ResourceDeploymentEnvironments.

type ResourceLanguage

type ResourceLanguage = string

ResourceLanguage Resource language identified based on the `telemetry.sdk.language` resource attribute. Some sample values: - cpp - dotnet - erlang - go - java - nodejs - php - python - ruby - rust - swift - webjs

type ResourceLanguages

type ResourceLanguages = []ResourceLanguage

ResourceLanguages defines model for ResourceLanguages.

type ResourceLogs

type ResourceLogs struct {
	Resource  Resource    `json:"resource"`
	SchemaUrl *string     `json:"schemaUrl,omitempty"`
	ScopeLogs []ScopeLogs `json:"scopeLogs"`
}

ResourceLogs defines model for ResourceLogs.

type ResourceOrchestration

type ResourceOrchestration string

ResourceOrchestration Resource orchestration identified based on orchestration related resource attributes, e.g., existence of `k8s.*` resource attribute.

const (
	Kubernetes ResourceOrchestration = "kubernetes"
)

Defines values for ResourceOrchestration.

type ResourceOrchestrations

type ResourceOrchestrations = []ResourceOrchestration

ResourceOrchestrations defines model for ResourceOrchestrations.

type ResourceSpans

type ResourceSpans struct {
	Resource   Resource     `json:"resource"`
	SchemaUrl  *string      `json:"schemaUrl,omitempty"`
	ScopeSpans []ScopeSpans `json:"scopeSpans"`
}

ResourceSpans defines model for ResourceSpans.

type Sampling

type Sampling struct {
	Mode SamplingMode `json:"mode"`

	// TimeRange A range of time between two time references.
	TimeRange TimeReferenceRange `json:"timeRange"`
}

Sampling defines model for Sampling.

type SamplingCondition added in v1.1.0

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

SamplingCondition defines model for SamplingCondition.

func (SamplingCondition) AsSamplingConditionAnd added in v1.1.0

func (t SamplingCondition) AsSamplingConditionAnd() (SamplingConditionAnd, error)

AsSamplingConditionAnd returns the union data inside the SamplingCondition as a SamplingConditionAnd

func (SamplingCondition) AsSamplingConditionError added in v1.1.0

func (t SamplingCondition) AsSamplingConditionError() (SamplingConditionError, error)

AsSamplingConditionError returns the union data inside the SamplingCondition as a SamplingConditionError

func (SamplingCondition) AsSamplingConditionOttl added in v1.1.0

func (t SamplingCondition) AsSamplingConditionOttl() (SamplingConditionOttl, error)

AsSamplingConditionOttl returns the union data inside the SamplingCondition as a SamplingConditionOttl

func (SamplingCondition) AsSamplingConditionProbabilistic added in v1.1.0

func (t SamplingCondition) AsSamplingConditionProbabilistic() (SamplingConditionProbabilistic, error)

AsSamplingConditionProbabilistic returns the union data inside the SamplingCondition as a SamplingConditionProbabilistic

func (*SamplingCondition) FromSamplingConditionAnd added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionAnd(v SamplingConditionAnd) error

FromSamplingConditionAnd overwrites any union data inside the SamplingCondition as the provided SamplingConditionAnd

func (*SamplingCondition) FromSamplingConditionError added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionError(v SamplingConditionError) error

FromSamplingConditionError overwrites any union data inside the SamplingCondition as the provided SamplingConditionError

func (*SamplingCondition) FromSamplingConditionOttl added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionOttl(v SamplingConditionOttl) error

FromSamplingConditionOttl overwrites any union data inside the SamplingCondition as the provided SamplingConditionOttl

func (*SamplingCondition) FromSamplingConditionProbabilistic added in v1.1.0

func (t *SamplingCondition) FromSamplingConditionProbabilistic(v SamplingConditionProbabilistic) error

FromSamplingConditionProbabilistic overwrites any union data inside the SamplingCondition as the provided SamplingConditionProbabilistic

func (SamplingCondition) MarshalJSON added in v1.1.0

func (t SamplingCondition) MarshalJSON() ([]byte, error)

func (*SamplingCondition) MergeSamplingConditionAnd added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionAnd(v SamplingConditionAnd) error

MergeSamplingConditionAnd performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionAnd

func (*SamplingCondition) MergeSamplingConditionError added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionError(v SamplingConditionError) error

MergeSamplingConditionError performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionError

func (*SamplingCondition) MergeSamplingConditionOttl added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionOttl(v SamplingConditionOttl) error

MergeSamplingConditionOttl performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionOttl

func (*SamplingCondition) MergeSamplingConditionProbabilistic added in v1.1.0

func (t *SamplingCondition) MergeSamplingConditionProbabilistic(v SamplingConditionProbabilistic) error

MergeSamplingConditionProbabilistic performs a merge with any union data inside the SamplingCondition, using the provided SamplingConditionProbabilistic

func (*SamplingCondition) UnmarshalJSON added in v1.1.0

func (t *SamplingCondition) UnmarshalJSON(b []byte) error

type SamplingConditionAnd added in v1.1.0

type SamplingConditionAnd struct {
	Kind SamplingConditionAndKind `json:"kind"`
	Spec SamplingConditionAndSpec `json:"spec"`
}

SamplingConditionAnd defines model for SamplingConditionAnd.

type SamplingConditionAndKind added in v1.1.0

type SamplingConditionAndKind string

SamplingConditionAndKind defines model for SamplingConditionAnd.Kind.

const (
	And SamplingConditionAndKind = "and"
)

Defines values for SamplingConditionAndKind.

type SamplingConditionAndSpec added in v1.1.0

type SamplingConditionAndSpec struct {
	Conditions []SamplingCondition `json:"conditions"`
}

SamplingConditionAndSpec defines model for SamplingConditionAndSpec.

type SamplingConditionError added in v1.1.0

type SamplingConditionError struct {
	Kind SamplingConditionErrorKind `json:"kind"`
	Spec SamplingConditionErrorSpec `json:"spec"`
}

SamplingConditionError Matches spans that have the have `otel.span.status.code=ERROR`

type SamplingConditionErrorKind added in v1.1.0

type SamplingConditionErrorKind string

SamplingConditionErrorKind defines model for SamplingConditionError.Kind.

const (
	SamplingConditionErrorKindError SamplingConditionErrorKind = "error"
)

Defines values for SamplingConditionErrorKind.

type SamplingConditionErrorSpec added in v1.1.0

type SamplingConditionErrorSpec = interface{}

SamplingConditionErrorSpec defines model for SamplingConditionErrorSpec.

type SamplingConditionOttl added in v1.1.0

type SamplingConditionOttl struct {
	Kind SamplingConditionOttlKind `json:"kind"`
	Spec SamplingConditionOttlSpec `json:"spec"`
}

SamplingConditionOttl defines model for SamplingConditionOttl.

type SamplingConditionOttlKind added in v1.1.0

type SamplingConditionOttlKind string

SamplingConditionOttlKind defines model for SamplingConditionOttl.Kind.

const (
	Ottl SamplingConditionOttlKind = "ottl"
)

Defines values for SamplingConditionOttlKind.

type SamplingConditionOttlSpec added in v1.1.0

type SamplingConditionOttlSpec struct {
	Ottl string `json:"ottl"`
}

SamplingConditionOttlSpec defines model for SamplingConditionOttlSpec.

type SamplingConditionProbabilistic added in v1.1.0

type SamplingConditionProbabilistic struct {
	Kind SamplingConditionProbabilisticKind `json:"kind"`
	Spec SamplingConditionProbabilisticSpec `json:"spec"`
}

SamplingConditionProbabilistic defines model for SamplingConditionProbabilistic.

type SamplingConditionProbabilisticKind added in v1.1.0

type SamplingConditionProbabilisticKind string

SamplingConditionProbabilisticKind defines model for SamplingConditionProbabilistic.Kind.

const (
	Probabilistic SamplingConditionProbabilisticKind = "probabilistic"
)

Defines values for SamplingConditionProbabilisticKind.

type SamplingConditionProbabilisticSpec added in v1.1.0

type SamplingConditionProbabilisticSpec struct {
	// Rate A value between 0 and 1 reflecting the percentage of traces that should be sampled probabilistically.
	// This sampling decision is made deterministically by inspecting the trace ID.
	Rate float32 `json:"rate"`
}

SamplingConditionProbabilisticSpec defines model for SamplingConditionProbabilisticSpec.

type SamplingDefinition added in v1.1.0

type SamplingDefinition struct {
	Kind     SamplingDefinitionKind `json:"kind"`
	Metadata SamplingMetadata       `json:"metadata"`
	Spec     SamplingSpec           `json:"spec"`
}

SamplingDefinition defines model for SamplingDefinition.

type SamplingDefinitionKind added in v1.1.0

type SamplingDefinitionKind string

SamplingDefinitionKind defines model for SamplingDefinition.Kind.

const (
	Dash0Sampling SamplingDefinitionKind = "Dash0Sampling"
)

Defines values for SamplingDefinitionKind.

type SamplingDisplay added in v1.1.0

type SamplingDisplay struct {
	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

SamplingDisplay defines model for SamplingDisplay.

type SamplingLabels added in v1.1.0

type SamplingLabels struct {
	Custom          *map[string]string `json:"custom,omitempty"`
	Dash0Comdataset *string            `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string            `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string            `json:"dash0.com/origin,omitempty"`
	Dash0Comversion *string            `json:"dash0.com/version,omitempty"`
}

SamplingLabels defines model for SamplingLabels.

type SamplingMetadata added in v1.1.0

type SamplingMetadata struct {
	Labels *SamplingLabels `json:"labels,omitempty"`
	Name   string          `json:"name"`
}

SamplingMetadata defines model for SamplingMetadata.

type SamplingMode

type SamplingMode string

SamplingMode defines model for SamplingMode.

const (
	SamplingModeAdaptive SamplingMode = "adaptive"
	SamplingModeDisabled SamplingMode = "disabled"
)

Defines values for SamplingMode.

type SamplingRateLimit added in v1.1.0

type SamplingRateLimit struct {
	// Rate The maximum number of traces per minute that should be allowed for this sampling rule. Dash0 will make every
	// effort not to exceed this rate. However, there is also no guarantee that Dash0 will match exactly this rate.
	// Dash0 is attempting to hit a rate that is lower than or equal to the configured rate.
	//
	// Dash0 cannot guarantee that very low rate limits (<=16) are upheld.
	Rate int `json:"rate"`
}

SamplingRateLimit Rate limit is helpful to avoid ingesting extremely large amounts of spans when the sampling conditions are triggering much more frequently than expected. For example, when the tail sampling rule is configured to match every error, then a system-wide outage can result in a huge amount of spans being ingested.

Note: Probabilistic-only sampling rules do not support rate limiting.

type SamplingRuleCreateRequest added in v1.1.0

type SamplingRuleCreateRequest = SamplingDefinition

SamplingRuleCreateRequest defines model for SamplingRuleCreateRequest.

type SamplingRuleResponse added in v1.1.0

type SamplingRuleResponse = SamplingDefinition

SamplingRuleResponse defines model for SamplingRuleResponse.

type SamplingSpec added in v1.1.0

type SamplingSpec struct {
	Conditions SamplingCondition `json:"conditions"`
	Display    *SamplingDisplay  `json:"display,omitempty"`
	Enabled    bool              `json:"enabled"`

	// RateLimit Rate limit is helpful to avoid ingesting extremely large amounts of spans when the sampling conditions are
	// triggering much more frequently than expected. For example, when the tail sampling rule is configured to match
	// every error, then a system-wide outage can result in a huge amount of spans being ingested.
	//
	// Note: Probabilistic-only sampling rules do not support rate limiting.
	RateLimit *SamplingRateLimit `json:"rateLimit,omitempty"`
}

SamplingSpec defines model for SamplingSpec.

type ScopeLogs

type ScopeLogs struct {
	LogRecords []LogRecord `json:"logRecords"`
	SchemaUrl  *string     `json:"schemaUrl,omitempty"`

	// Scope InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.
	Scope *InstrumentationScope `json:"scope,omitempty"`
}

ScopeLogs defines model for ScopeLogs.

type ScopeSpans

type ScopeSpans struct {
	SchemaUrl *string `json:"schemaUrl,omitempty"`

	// Scope InstrumentationScope is a message representing the instrumentation scope information such as the fully qualified name and version.
	Scope *InstrumentationScope `json:"scope,omitempty"`
	Spans []Span                `json:"spans"`
}

ScopeSpans defines model for ScopeSpans.

type SeverityNumber

type SeverityNumber = int32

SeverityNumber SEVERITY_NUMBER_UNSPECIFIED = 0; SEVERITY_NUMBER_TRACE = 1; SEVERITY_NUMBER_TRACE2 = 2; SEVERITY_NUMBER_TRACE3 = 3; SEVERITY_NUMBER_TRACE4 = 4; SEVERITY_NUMBER_DEBUG = 5; SEVERITY_NUMBER_DEBUG2 = 6; SEVERITY_NUMBER_DEBUG3 = 7; SEVERITY_NUMBER_DEBUG4 = 8; SEVERITY_NUMBER_INFO = 9; SEVERITY_NUMBER_INFO2 = 10; SEVERITY_NUMBER_INFO3 = 11; SEVERITY_NUMBER_INFO4 = 12; SEVERITY_NUMBER_WARN = 13; SEVERITY_NUMBER_WARN2 = 14; SEVERITY_NUMBER_WARN3 = 15; SEVERITY_NUMBER_WARN4 = 16; SEVERITY_NUMBER_ERROR = 17; SEVERITY_NUMBER_ERROR2 = 18; SEVERITY_NUMBER_ERROR3 = 19; SEVERITY_NUMBER_ERROR4 = 20; SEVERITY_NUMBER_FATAL = 21; SEVERITY_NUMBER_FATAL2 = 22; SEVERITY_NUMBER_FATAL3 = 23; SEVERITY_NUMBER_FATAL4 = 24;

type Span

type Span struct {
	Attributes []KeyValue `json:"attributes"`

	// Dash0ForwardLinks Forward links pointing to spans in other traces.
	// The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0ForwardLinks *[]SpanLink `json:"dash0ForwardLinks,omitempty"`

	// Dash0Name The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0Name *string `json:"dash0Name,omitempty"`

	// Dash0TraceOriginParentSpanId The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0TraceOriginParentSpanId *[]byte `json:"dash0TraceOriginParentSpanId,omitempty"`

	// Dash0TraceOriginType The property is only included when `includeOTLPSchemaExtensions` is `true`.
	Dash0TraceOriginType   *string     `json:"dash0TraceOriginType,omitempty"`
	DroppedAttributesCount *int64      `json:"droppedAttributesCount,omitempty"`
	DroppedEventsCount     *int64      `json:"droppedEventsCount,omitempty"`
	DroppedLinksCount      *int64      `json:"droppedLinksCount,omitempty"`
	EndTimeUnixNano        string      `json:"endTimeUnixNano"`
	Events                 []SpanEvent `json:"events"`
	Flags                  *int64      `json:"flags,omitempty"`

	// HasChildren The property is only included when `includeOTLPSchemaExtensions` is `true`.
	HasChildren *bool `json:"hasChildren,omitempty"`

	// Kind // Unspecified. Do NOT use as default.
	// // Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.
	// SPAN_KIND_UNSPECIFIED = 0;
	//
	// // Indicates that the span represents an internal operation within an application,
	// // as opposed to an operation happening at the boundaries. Default value.
	// SPAN_KIND_INTERNAL = 1;
	//
	// // Indicates that the span covers server-side handling of an RPC or other
	// // remote network request.
	// SPAN_KIND_SERVER = 2;
	//
	// // Indicates that the span describes a request to some remote service.
	// SPAN_KIND_CLIENT = 3;
	//
	// // Indicates that the span describes a producer sending a message to a broker.
	// // Unlike CLIENT and SERVER, there is often no direct critical path latency relationship
	// // between producer and consumer spans. A PRODUCER span ends when the message was accepted
	// // by the broker while the logical processing of the message might span a much longer time.
	// SPAN_KIND_PRODUCER = 4;
	//
	// // Indicates that the span describes consumer receiving a message from a broker.
	// // Like the PRODUCER kind, there is often no direct critical path latency relationship
	// // between producer and consumer spans.
	// SPAN_KIND_CONSUMER = 5;
	Kind              SpanKind   `json:"kind"`
	Links             []SpanLink `json:"links"`
	Name              string     `json:"name"`
	ParentSpanId      *[]byte    `json:"parentSpanId,omitempty"`
	SpanId            []byte     `json:"spanId"`
	StartTimeUnixNano string     `json:"startTimeUnixNano"`
	Status            SpanStatus `json:"status"`
	TraceId           []byte     `json:"traceId"`
	TraceState        *string    `json:"traceState,omitempty"`
}

Span defines model for Span.

type SpanEvent

type SpanEvent struct {
	Attributes             []KeyValue `json:"attributes"`
	DroppedAttributesCount *int64     `json:"droppedAttributesCount,omitempty"`
	Name                   string     `json:"name"`
	TimeUnixNano           string     `json:"timeUnixNano"`
}

SpanEvent defines model for SpanEvent.

type SpanKind

type SpanKind = int32

SpanKind // Unspecified. Do NOT use as default. // Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED. SPAN_KIND_UNSPECIFIED = 0;

// Indicates that the span represents an internal operation within an application, // as opposed to an operation happening at the boundaries. Default value. SPAN_KIND_INTERNAL = 1;

// Indicates that the span covers server-side handling of an RPC or other // remote network request. SPAN_KIND_SERVER = 2;

// Indicates that the span describes a request to some remote service. SPAN_KIND_CLIENT = 3;

// Indicates that the span describes a producer sending a message to a broker. // Unlike CLIENT and SERVER, there is often no direct critical path latency relationship // between producer and consumer spans. A PRODUCER span ends when the message was accepted // by the broker while the logical processing of the message might span a much longer time. SPAN_KIND_PRODUCER = 4;

// Indicates that the span describes consumer receiving a message from a broker. // Like the PRODUCER kind, there is often no direct critical path latency relationship // between producer and consumer spans. SPAN_KIND_CONSUMER = 5;

type SpanLink struct {
	Attributes             []KeyValue `json:"attributes"`
	DroppedAttributesCount *int64     `json:"droppedAttributesCount,omitempty"`
	Flags                  *int64     `json:"flags,omitempty"`
	SpanId                 []byte     `json:"spanId"`
	TraceId                []byte     `json:"traceId"`
	TraceState             *string    `json:"traceState,omitempty"`
}

SpanLink defines model for SpanLink.

type SpanStatus

type SpanStatus struct {
	// Code // The default status.
	// STATUS_CODE_UNSET               = 0;
	// // The Span has been validated by an Application developer or Operator to
	// // have completed successfully.
	// STATUS_CODE_OK                  = 1;
	// // The Span contains an error.
	// STATUS_CODE_ERROR               = 2;
	Code SpanStatusCode `json:"code"`

	// Message A developer-facing human readable error message.
	Message *string `json:"message,omitempty"`
}

SpanStatus defines model for SpanStatus.

type SpanStatusCode

type SpanStatusCode = int32

SpanStatusCode // The default status. STATUS_CODE_UNSET = 0; // The Span has been validated by an Application developer or Operator to // have completed successfully. STATUS_CODE_OK = 1; // The Span contains an error. STATUS_CODE_ERROR = 2;

type SslCertificateAssertion

type SslCertificateAssertion struct {
	Kind SslCertificateAssertionKind `json:"kind"`
	Spec SslCertificateAssertionSpec `json:"spec"`
}

SslCertificateAssertion defines model for SslCertificateAssertion.

type SslCertificateAssertionKind

type SslCertificateAssertionKind string

SslCertificateAssertionKind defines model for SslCertificateAssertion.Kind.

const (
	SslCertificate SslCertificateAssertionKind = "ssl_certificate"
)

Defines values for SslCertificateAssertionKind.

type SslCertificateAssertionSpec

type SslCertificateAssertionSpec struct {
	Value Duration `json:"value"`
}

SslCertificateAssertionSpec defines model for SslCertificateAssertionSpec.

type StringAssertionOperator

type StringAssertionOperator string

StringAssertionOperator defines model for StringAssertionOperator.

const (
	Contains         StringAssertionOperator = "contains"
	DoesNotContain   StringAssertionOperator = "does_not_contain"
	DoesNotEndWith   StringAssertionOperator = "does_not_end_with"
	DoesNotMatch     StringAssertionOperator = "does_not_match"
	DoesNotStartWith StringAssertionOperator = "does_not_start_with"
	EndsWith         StringAssertionOperator = "ends_with"
	Is               StringAssertionOperator = "is"
	IsNot            StringAssertionOperator = "is_not"
	IsNotOneOf       StringAssertionOperator = "is_not_one_of"
	IsNotSet         StringAssertionOperator = "is_not_set"
	IsOneOf          StringAssertionOperator = "is_one_of"
	IsSet            StringAssertionOperator = "is_set"
	Matches          StringAssertionOperator = "matches"
	StartsWith       StringAssertionOperator = "starts_with"
)

Defines values for StringAssertionOperator.

type SyntheticCheckAction

type SyntheticCheckAction string

SyntheticCheckAction defines model for SyntheticCheckAction.

const (
	SyntheticCheckDelete SyntheticCheckAction = "synthetic_check:delete"
	SyntheticCheckRead   SyntheticCheckAction = "synthetic_check:read"
	SyntheticCheckWrite  SyntheticCheckAction = "synthetic_check:write"
)

Defines values for SyntheticCheckAction.

type SyntheticCheckAnnotations

type SyntheticCheckAnnotations struct {
	Dash0ComdeletedAt  *time.Time `json:"dash0.com/deleted-at,omitempty"`
	Dash0ComfolderPath *string    `json:"dash0.com/folder-path,omitempty"`
	Dash0Comsharing    *string    `json:"dash0.com/sharing,omitempty"`
}

SyntheticCheckAnnotations defines model for SyntheticCheckAnnotations.

type SyntheticCheckDefinition

type SyntheticCheckDefinition struct {
	Kind     SyntheticCheckDefinitionKind `json:"kind"`
	Metadata SyntheticCheckMetadata       `json:"metadata"`
	Spec     SyntheticCheckSpec           `json:"spec"`
}

SyntheticCheckDefinition defines model for SyntheticCheckDefinition.

type SyntheticCheckDefinitionKind

type SyntheticCheckDefinitionKind string

SyntheticCheckDefinitionKind defines model for SyntheticCheckDefinition.Kind.

const (
	Dash0SyntheticCheck SyntheticCheckDefinitionKind = "Dash0SyntheticCheck"
)

Defines values for SyntheticCheckDefinitionKind.

type SyntheticCheckDisplay

type SyntheticCheckDisplay struct {
	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

SyntheticCheckDisplay defines model for SyntheticCheckDisplay.

type SyntheticCheckLabels

type SyntheticCheckLabels struct {
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	Custom          *map[string]string `json:"custom,omitempty"`
	Dash0Comdataset *string            `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string            `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string            `json:"dash0.com/origin,omitempty"`
	Dash0Comversion *string            `json:"dash0.com/version,omitempty"`
}

SyntheticCheckLabels defines model for SyntheticCheckLabels.

type SyntheticCheckMetadata

type SyntheticCheckMetadata struct {
	Annotations *SyntheticCheckAnnotations `json:"annotations,omitempty"`
	Description *string                    `json:"description,omitempty"`
	Labels      *SyntheticCheckLabels      `json:"labels,omitempty"`
	Name        string                     `json:"name"`
}

SyntheticCheckMetadata defines model for SyntheticCheckMetadata.

type SyntheticCheckNotifications

type SyntheticCheckNotifications struct {
	// Channels The channel IDs that notifications should be sent to in case the check is critical or degraded after
	// executing all the retries.
	Channels []openapi_types.UUID `json:"channels"`

	// OnlyCriticalChannels The channel IDs that should only trigger in case synthetic check status reaches critical state.
	OnlyCriticalChannels *[]openapi_types.UUID `json:"onlyCriticalChannels,omitempty"`
}

SyntheticCheckNotifications defines model for SyntheticCheckNotifications.

type SyntheticCheckPermission

type SyntheticCheckPermission struct {
	Actions []SyntheticCheckAction `json:"actions"`
	Role    *string                `json:"role,omitempty"`
	TeamId  *string                `json:"teamId,omitempty"`
	UserId  *string                `json:"userId,omitempty"`
}

SyntheticCheckPermission defines model for SyntheticCheckPermission.

type SyntheticCheckPlugin

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

SyntheticCheckPlugin defines model for SyntheticCheckPlugin.

func (SyntheticCheckPlugin) AsSyntheticHttpCheckPlugin

func (t SyntheticCheckPlugin) AsSyntheticHttpCheckPlugin() (SyntheticHttpCheckPlugin, error)

AsSyntheticHttpCheckPlugin returns the union data inside the SyntheticCheckPlugin as a SyntheticHttpCheckPlugin

func (*SyntheticCheckPlugin) FromSyntheticHttpCheckPlugin

func (t *SyntheticCheckPlugin) FromSyntheticHttpCheckPlugin(v SyntheticHttpCheckPlugin) error

FromSyntheticHttpCheckPlugin overwrites any union data inside the SyntheticCheckPlugin as the provided SyntheticHttpCheckPlugin

func (SyntheticCheckPlugin) MarshalJSON

func (t SyntheticCheckPlugin) MarshalJSON() ([]byte, error)

func (*SyntheticCheckPlugin) MergeSyntheticHttpCheckPlugin

func (t *SyntheticCheckPlugin) MergeSyntheticHttpCheckPlugin(v SyntheticHttpCheckPlugin) error

MergeSyntheticHttpCheckPlugin performs a merge with any union data inside the SyntheticCheckPlugin, using the provided SyntheticHttpCheckPlugin

func (*SyntheticCheckPlugin) UnmarshalJSON

func (t *SyntheticCheckPlugin) UnmarshalJSON(b []byte) error

type SyntheticCheckRetries

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

SyntheticCheckRetries defines model for SyntheticCheckRetries.

func (SyntheticCheckRetries) AsSyntheticCheckRetriesExponential

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesExponential() (SyntheticCheckRetriesExponential, error)

AsSyntheticCheckRetriesExponential returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesExponential

func (SyntheticCheckRetries) AsSyntheticCheckRetriesFixed

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesFixed() (SyntheticCheckRetriesFixed, error)

AsSyntheticCheckRetriesFixed returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesFixed

func (SyntheticCheckRetries) AsSyntheticCheckRetriesLinear

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesLinear() (SyntheticCheckRetriesLinear, error)

AsSyntheticCheckRetriesLinear returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesLinear

func (SyntheticCheckRetries) AsSyntheticCheckRetriesOff

func (t SyntheticCheckRetries) AsSyntheticCheckRetriesOff() (SyntheticCheckRetriesOff, error)

AsSyntheticCheckRetriesOff returns the union data inside the SyntheticCheckRetries as a SyntheticCheckRetriesOff

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesExponential

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesExponential(v SyntheticCheckRetriesExponential) error

FromSyntheticCheckRetriesExponential overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesExponential

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesFixed

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesFixed(v SyntheticCheckRetriesFixed) error

FromSyntheticCheckRetriesFixed overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesFixed

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesLinear

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesLinear(v SyntheticCheckRetriesLinear) error

FromSyntheticCheckRetriesLinear overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesLinear

func (*SyntheticCheckRetries) FromSyntheticCheckRetriesOff

func (t *SyntheticCheckRetries) FromSyntheticCheckRetriesOff(v SyntheticCheckRetriesOff) error

FromSyntheticCheckRetriesOff overwrites any union data inside the SyntheticCheckRetries as the provided SyntheticCheckRetriesOff

func (SyntheticCheckRetries) MarshalJSON

func (t SyntheticCheckRetries) MarshalJSON() ([]byte, error)

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesExponential

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesExponential(v SyntheticCheckRetriesExponential) error

MergeSyntheticCheckRetriesExponential performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesExponential

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesFixed

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesFixed(v SyntheticCheckRetriesFixed) error

MergeSyntheticCheckRetriesFixed performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesFixed

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesLinear

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesLinear(v SyntheticCheckRetriesLinear) error

MergeSyntheticCheckRetriesLinear performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesLinear

func (*SyntheticCheckRetries) MergeSyntheticCheckRetriesOff

func (t *SyntheticCheckRetries) MergeSyntheticCheckRetriesOff(v SyntheticCheckRetriesOff) error

MergeSyntheticCheckRetriesOff performs a merge with any union data inside the SyntheticCheckRetries, using the provided SyntheticCheckRetriesOff

func (*SyntheticCheckRetries) UnmarshalJSON

func (t *SyntheticCheckRetries) UnmarshalJSON(b []byte) error

type SyntheticCheckRetriesExponential

type SyntheticCheckRetriesExponential struct {
	Kind SyntheticCheckRetriesExponentialKind `json:"kind"`
	Spec SyntheticCheckRetriesExponentialSpec `json:"spec"`
}

SyntheticCheckRetriesExponential defines model for SyntheticCheckRetriesExponential.

type SyntheticCheckRetriesExponentialKind

type SyntheticCheckRetriesExponentialKind string

SyntheticCheckRetriesExponentialKind defines model for SyntheticCheckRetriesExponential.Kind.

const (
	Exponential SyntheticCheckRetriesExponentialKind = "exponential"
)

Defines values for SyntheticCheckRetriesExponentialKind.

type SyntheticCheckRetriesExponentialSpec

type SyntheticCheckRetriesExponentialSpec struct {
	Attempts     int      `json:"attempts"`
	Delay        Duration `json:"delay"`
	MaximumDelay Duration `json:"maximumDelay"`
}

SyntheticCheckRetriesExponentialSpec defines model for SyntheticCheckRetriesExponentialSpec.

type SyntheticCheckRetriesFixed

type SyntheticCheckRetriesFixed struct {
	Kind SyntheticCheckRetriesFixedKind `json:"kind"`
	Spec SyntheticCheckRetriesFixedSpec `json:"spec"`
}

SyntheticCheckRetriesFixed defines model for SyntheticCheckRetriesFixed.

type SyntheticCheckRetriesFixedKind

type SyntheticCheckRetriesFixedKind string

SyntheticCheckRetriesFixedKind defines model for SyntheticCheckRetriesFixed.Kind.

const (
	Fixed SyntheticCheckRetriesFixedKind = "fixed"
)

Defines values for SyntheticCheckRetriesFixedKind.

type SyntheticCheckRetriesFixedSpec

type SyntheticCheckRetriesFixedSpec struct {
	Attempts int      `json:"attempts"`
	Delay    Duration `json:"delay"`
}

SyntheticCheckRetriesFixedSpec defines model for SyntheticCheckRetriesFixedSpec.

type SyntheticCheckRetriesLinear

type SyntheticCheckRetriesLinear struct {
	Kind SyntheticCheckRetriesLinearKind `json:"kind"`
	Spec SyntheticCheckRetriesLinearSpec `json:"spec"`
}

SyntheticCheckRetriesLinear defines model for SyntheticCheckRetriesLinear.

type SyntheticCheckRetriesLinearKind

type SyntheticCheckRetriesLinearKind string

SyntheticCheckRetriesLinearKind defines model for SyntheticCheckRetriesLinear.Kind.

const (
	SyntheticCheckRetriesLinearKindLinear SyntheticCheckRetriesLinearKind = "linear"
)

Defines values for SyntheticCheckRetriesLinearKind.

type SyntheticCheckRetriesLinearSpec

type SyntheticCheckRetriesLinearSpec struct {
	Attempts     int      `json:"attempts"`
	Delay        Duration `json:"delay"`
	MaximumDelay Duration `json:"maximumDelay"`
}

SyntheticCheckRetriesLinearSpec defines model for SyntheticCheckRetriesLinearSpec.

type SyntheticCheckRetriesOff

type SyntheticCheckRetriesOff struct {
	Kind SyntheticCheckRetriesOffKind `json:"kind"`
	Spec SyntheticCheckRetriesOffSpec `json:"spec"`
}

SyntheticCheckRetriesOff defines model for SyntheticCheckRetriesOff.

type SyntheticCheckRetriesOffKind

type SyntheticCheckRetriesOffKind string

SyntheticCheckRetriesOffKind defines model for SyntheticCheckRetriesOff.Kind.

const (
	Off SyntheticCheckRetriesOffKind = "off"
)

Defines values for SyntheticCheckRetriesOffKind.

type SyntheticCheckRetriesOffSpec

type SyntheticCheckRetriesOffSpec = interface{}

SyntheticCheckRetriesOffSpec defines model for SyntheticCheckRetriesOffSpec.

type SyntheticCheckSchedule

type SyntheticCheckSchedule struct {
	Interval  Duration `json:"interval"`
	Locations []string `json:"locations"`

	// Strategy Whether to run checks against all specified locations for every run, or just a single location per run.
	Strategy SyntheticCheckSchedulingStrategy `json:"strategy"`
}

SyntheticCheckSchedule defines model for SyntheticCheckSchedule.

type SyntheticCheckSchedulingStrategy

type SyntheticCheckSchedulingStrategy string

SyntheticCheckSchedulingStrategy Whether to run checks against all specified locations for every run, or just a single location per run.

const (
	AllLocations   SyntheticCheckSchedulingStrategy = "all_locations"
	RandomLocation SyntheticCheckSchedulingStrategy = "random_location"
)

Defines values for SyntheticCheckSchedulingStrategy.

type SyntheticCheckSpec

type SyntheticCheckSpec struct {
	Display       *SyntheticCheckDisplay      `json:"display,omitempty"`
	Enabled       bool                        `json:"enabled"`
	Labels        *map[string]string          `json:"labels,omitempty"`
	Notifications SyntheticCheckNotifications `json:"notifications"`
	Permissions   *[]SyntheticCheckPermission `json:"permissions,omitempty"`
	Plugin        SyntheticCheckPlugin        `json:"plugin"`
	Retries       SyntheticCheckRetries       `json:"retries"`
	Schedule      SyntheticCheckSchedule      `json:"schedule"`
}

SyntheticCheckSpec defines model for SyntheticCheckSpec.

type SyntheticChecksApiListItem

type SyntheticChecksApiListItem struct {
	Dataset string  `json:"dataset"`
	Id      string  `json:"id"`
	Name    *string `json:"name,omitempty"`
	Origin  *string `json:"origin,omitempty"`
}

SyntheticChecksApiListItem defines model for SyntheticChecksApiListItem.

type SyntheticHttpCheckAssertions

type SyntheticHttpCheckAssertions struct {
	CriticalAssertions HttpCheckAssertions `json:"criticalAssertions"`
	DegradedAssertions HttpCheckAssertions `json:"degradedAssertions"`
}

SyntheticHttpCheckAssertions defines model for SyntheticHttpCheckAssertions.

type SyntheticHttpCheckPlugin

type SyntheticHttpCheckPlugin struct {
	Kind SyntheticHttpCheckPluginKind `json:"kind"`
	Spec SyntheticHttpCheckPluginSpec `json:"spec"`
}

SyntheticHttpCheckPlugin defines model for SyntheticHttpCheckPlugin.

type SyntheticHttpCheckPluginKind

type SyntheticHttpCheckPluginKind string

SyntheticHttpCheckPluginKind defines model for SyntheticHttpCheckPlugin.Kind.

const (
	Http SyntheticHttpCheckPluginKind = "http"
)

Defines values for SyntheticHttpCheckPluginKind.

type SyntheticHttpCheckPluginSpec

type SyntheticHttpCheckPluginSpec struct {
	Assertions SyntheticHttpCheckAssertions `json:"assertions"`
	Request    HttpRequestSpec              `json:"request"`
}

SyntheticHttpCheckPluginSpec defines model for SyntheticHttpCheckPluginSpec.

type SyntheticHttpErrorType

type SyntheticHttpErrorType string

SyntheticHttpErrorType defines model for SyntheticHttpErrorType.

const (
	SyntheticHttpErrorTypeDns     SyntheticHttpErrorType = "dns"
	SyntheticHttpErrorTypeTcp     SyntheticHttpErrorType = "tcp"
	SyntheticHttpErrorTypeTimeout SyntheticHttpErrorType = "timeout"
	SyntheticHttpErrorTypeTls     SyntheticHttpErrorType = "tls"
	SyntheticHttpErrorTypeUnknown SyntheticHttpErrorType = "unknown"
)

Defines values for SyntheticHttpErrorType.

type TimeRange

type TimeRange struct {
	// From A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	From FixedTime `json:"from"`

	// To A fixed point in time represented as an RFC 3339 date-time string.
	//
	// **Format**: `YYYY-MM-DDTHH:MM:SSZ` (UTC) or `YYYY-MM-DDTHH:MM:SS±HH:MM` (with timezone offset)
	//
	// **Examples**:
	// - `2024-01-15T14:30:00Z`
	// - `2024-01-15T14:30:00+08:00`
	To FixedTime `json:"to"`
}

TimeRange defines model for TimeRange.

type TimeReference

type TimeReference = any

TimeReference defines model for TimeReference.

type TimeReferenceRange

type TimeReferenceRange struct {
	From TimeReference `json:"from"`
	To   TimeReference `json:"to"`
}

TimeReferenceRange A range of time between two time references.

type TimingAssertion

type TimingAssertion struct {
	Kind TimingAssertionKind `json:"kind"`
	Spec TimingAssertionSpec `json:"spec"`
}

TimingAssertion defines model for TimingAssertion.

type TimingAssertionKind

type TimingAssertionKind string

TimingAssertionKind defines model for TimingAssertion.Kind.

const (
	Timing TimingAssertionKind = "timing"
)

Defines values for TimingAssertionKind.

type TimingAssertionSpec

type TimingAssertionSpec struct {
	Operator NumericAssertionOperator `json:"operator"`
	Type     TimingType               `json:"type"`
	Value    Duration                 `json:"value"`
}

TimingAssertionSpec defines model for TimingAssertionSpec.

type TimingType

type TimingType string

TimingType defines model for TimingType.

const (
	TimingTypeConnection TimingType = "connection"
	TimingTypeDns        TimingType = "dns"
	TimingTypeRequest    TimingType = "request"
	TimingTypeResponse   TimingType = "response"
	TimingTypeSsl        TimingType = "ssl"
	TimingTypeTotal      TimingType = "total"
)

Defines values for TimingType.

type TlsSettings

type TlsSettings struct {
	AllowInsecure bool `json:"allowInsecure"`
}

TlsSettings defines model for TlsSettings.

type TracingSettings

type TracingSettings struct {
	AddTracingHeaders bool `json:"addTracingHeaders"`
}

TracingSettings defines model for TracingSettings.

type ViewAction

type ViewAction string

ViewAction defines model for ViewAction.

const (
	ViewsDelete ViewAction = "views:delete"
	ViewsRead   ViewAction = "views:read"
	ViewsWrite  ViewAction = "views:write"
)

Defines values for ViewAction.

type ViewAnnotations

type ViewAnnotations struct {
	Dash0ComdeletedAt  *time.Time `json:"dash0.com/deleted-at,omitempty"`
	Dash0ComfolderPath *string    `json:"dash0.com/folder-path,omitempty"`
	Dash0Comsharing    *string    `json:"dash0.com/sharing,omitempty"`
}

ViewAnnotations defines model for ViewAnnotations.

type ViewApiListItem

type ViewApiListItem struct {
	Dataset string  `json:"dataset"`
	Id      string  `json:"id"`
	Name    *string `json:"name,omitempty"`
	Origin  *string `json:"origin,omitempty"`
}

ViewApiListItem defines model for ViewApiListItem.

type ViewDefinition

type ViewDefinition struct {
	Kind     ViewDefinitionKind `json:"kind"`
	Metadata ViewMetadata       `json:"metadata"`
	Spec     ViewSpec           `json:"spec"`
}

ViewDefinition defines model for ViewDefinition.

type ViewDefinitionKind

type ViewDefinitionKind string

ViewDefinitionKind defines model for ViewDefinition.Kind.

const (
	Dash0View ViewDefinitionKind = "Dash0View"
)

Defines values for ViewDefinitionKind.

type ViewDisplay

type ViewDisplay struct {
	// Description Long-form explanation what the view is doing. Shown within the list of views to help
	// team members understand the purpose of the view.
	Description *string `json:"description,omitempty"`

	// Name Short-form name for the view to be shown prominently within the view list and atop
	// the screen when the view is selected.
	Name string `json:"name"`
}

ViewDisplay defines model for ViewDisplay.

type ViewLabels

type ViewLabels struct {
	Dash0Comdataset *string                   `json:"dash0.com/dataset,omitempty"`
	Dash0Comid      *string                   `json:"dash0.com/id,omitempty"`
	Dash0Comorigin  *string                   `json:"dash0.com/origin,omitempty"`
	Dash0Comsource  *ViewLabelsDash0Comsource `json:"dash0.com/source,omitempty"`
	Dash0Comversion *string                   `json:"dash0.com/version,omitempty"`
}

ViewLabels defines model for ViewLabels.

type ViewLabelsDash0Comsource

type ViewLabelsDash0Comsource string

ViewLabelsDash0Comsource defines model for ViewLabels.Dash0Comsource.

const (
	Builtin     ViewLabelsDash0Comsource = "builtin"
	External    ViewLabelsDash0Comsource = "external"
	Userdefined ViewLabelsDash0Comsource = "userdefined"
)

Defines values for ViewLabelsDash0Comsource.

type ViewMetadata

type ViewMetadata struct {
	Annotations *ViewAnnotations `json:"annotations,omitempty"`
	Labels      *ViewLabels      `json:"labels,omitempty"`
	Name        string           `json:"name"`
}

ViewMetadata defines model for ViewMetadata.

type ViewPermission

type ViewPermission struct {
	// Actions Outlines possible actions that matching views can take with this view.
	Actions []ViewAction `json:"actions"`

	// Role Use role identifiers such as `admin` and `basic_member` to reference user groups.
	Role   *string `json:"role,omitempty"`
	TeamId *string `json:"teamId,omitempty"`
	UserId *string `json:"userId,omitempty"`
}

ViewPermission defines model for ViewPermission.

type ViewSpec

type ViewSpec struct {
	Display ViewDisplay     `json:"display"`
	Filter  *FilterCriteria `json:"filter,omitempty"`

	// GroupBy A set of attribute keys to group the view by. This property may be missing to indicate that
	// no configuration was historically made for this view, i.e., the view was saved before the
	// grouping capability was added. In that case, you can assume a default grouping should be used.
	GroupBy        *[]string         `json:"groupBy,omitempty"`
	ImplicitFilter *FilterCriteria   `json:"implicitFilter,omitempty"`
	Permissions    *[]ViewPermission `json:"permissions,omitempty"`
	Table          *ViewTable        `json:"table,omitempty"`

	// Type The view type describes where this view configuration is intended to be applied in the UI.
	Type ViewType `json:"type"`

	// Visualizations A visualization configuration for the view. We only support a single visualization for now per view.
	Visualizations *[]ViewVisualization `json:"visualizations,omitempty"`
}

ViewSpec defines model for ViewSpec.

type ViewTable

type ViewTable struct {
	Columns []ViewTableColumn `json:"columns"`

	// Sort Any supported attribute keys to order by.
	Sort OrderingCriteria `json:"sort"`
}

ViewTable defines model for ViewTable.

type ViewTableColumn

type ViewTableColumn struct {
	// ColSize A CSS grid layout sizing instruction. Supports hard-coded sizing such as `7rem`, but also `min-content`
	// and similar variants.
	ColSize *string `json:"colSize,omitempty"`

	// Key The key of the attribute to be displayed in this column. This can also be a built-in column name.
	Key   string  `json:"key"`
	Label *string `json:"label,omitempty"`
}

ViewTableColumn defines model for ViewTableColumn.

type ViewType

type ViewType string

ViewType The view type describes where this view configuration is intended to be applied in the UI.

const (
	FailedChecks ViewType = "failed_checks"
	Logs         ViewType = "logs"
	Metrics      ViewType = "metrics"
	Resources    ViewType = "resources"
	Services     ViewType = "services"
	Spans        ViewType = "spans"
	WebEvents    ViewType = "web_events"
)

Defines values for ViewType.

type ViewVisualization

type ViewVisualization struct {
	Metric *ViewVisualizationMetric `json:"metric,omitempty"`

	// Renderer The renderer type for the visualization. The pattern matching is inspired by glob, where `*` can be used as a wildcard.
	// The matching prioritizes precise matches before wildcard matches.
	// If there are multiple renderers, select buttons will be added to allow toggling between the renderers.
	Renderer *ViewVisualizationRenderer `json:"renderer,omitempty"`

	// Renderers A set of visualizations (charts) to render as part of this view. We currently only expect
	// to render a single
	Renderers  []ViewVisualizationRenderer `json:"renderers"`
	YAxisScale *AxisScale                  `json:"yAxisScale,omitempty"`
}

ViewVisualization defines model for ViewVisualization.

type ViewVisualizationMetric

type ViewVisualizationMetric string

ViewVisualizationMetric defines model for ViewVisualizationMetric.

const (
	LogsRate              ViewVisualizationMetric = "logs_rate"
	LogsTotal             ViewVisualizationMetric = "logs_total"
	SpansDurationAvg      ViewVisualizationMetric = "spans_duration_avg"
	SpansDurationP50      ViewVisualizationMetric = "spans_duration_p50"
	SpansDurationP75      ViewVisualizationMetric = "spans_duration_p75"
	SpansDurationP90      ViewVisualizationMetric = "spans_duration_p90"
	SpansDurationP95      ViewVisualizationMetric = "spans_duration_p95"
	SpansDurationP99      ViewVisualizationMetric = "spans_duration_p99"
	SpansErrorsPercentage ViewVisualizationMetric = "spans_errors_percentage"
	SpansErrorsRate       ViewVisualizationMetric = "spans_errors_rate"
	SpansErrorsTotal      ViewVisualizationMetric = "spans_errors_total"
	SpansRate             ViewVisualizationMetric = "spans_rate"
	SpansTotal            ViewVisualizationMetric = "spans_total"
)

Defines values for ViewVisualizationMetric.

type ViewVisualizationRenderer

type ViewVisualizationRenderer string

ViewVisualizationRenderer The renderer type for the visualization. The pattern matching is inspired by glob, where `*` can be used as a wildcard. The matching prioritizes precise matches before wildcard matches. If there are multiple renderers, select buttons will be added to allow toggling between the renderers.

const (
	LoggingstackedBar                    ViewVisualizationRenderer = "logging/*/stacked_bar"
	Resourcesfaasred                     ViewVisualizationRenderer = "resources/faas/red"
	Resourcesk8sCronJobsexecutions       ViewVisualizationRenderer = "resources/k8s-cron-jobs/executions"
	Resourcesk8sCronJobsred              ViewVisualizationRenderer = "resources/k8s-cron-jobs/red"
	Resourcesk8sDaemonSetsred            ViewVisualizationRenderer = "resources/k8s-daemon-sets/red"
	Resourcesk8sDaemonSetsscheduledNodes ViewVisualizationRenderer = "resources/k8s-daemon-sets/scheduled-nodes"
	Resourcesk8sDeploymentsred           ViewVisualizationRenderer = "resources/k8s-deployments/red"
	Resourcesk8sDeploymentsreplicas      ViewVisualizationRenderer = "resources/k8s-deployments/replicas"
	Resourcesk8sJobsexecutions           ViewVisualizationRenderer = "resources/k8s-jobs/executions"
	Resourcesk8sJobsred                  ViewVisualizationRenderer = "resources/k8s-jobs/red"
	Resourcesk8sNamespacesred            ViewVisualizationRenderer = "resources/k8s-namespaces/red"
	Resourcesk8sNodescpuMemoryDisk       ViewVisualizationRenderer = "resources/k8s-nodes/cpu-memory-disk"
	Resourcesk8sNodesstatus              ViewVisualizationRenderer = "resources/k8s-nodes/status"
	Resourcesk8sPodscpuMemory            ViewVisualizationRenderer = "resources/k8s-pods/cpu-memory"
	Resourcesk8sPodsred                  ViewVisualizationRenderer = "resources/k8s-pods/red"
	Resourcesk8sPodsstatus               ViewVisualizationRenderer = "resources/k8s-pods/status"
	Resourcesk8sReplicaSetsred           ViewVisualizationRenderer = "resources/k8s-replica-sets/red"
	Resourcesk8sReplicaSetsreplicas      ViewVisualizationRenderer = "resources/k8s-replica-sets/replicas"
	Resourcesk8sStatefulSetsred          ViewVisualizationRenderer = "resources/k8s-stateful-sets/red"
	Resourcesk8sStatefulSetsreplicas     ViewVisualizationRenderer = "resources/k8s-stateful-sets/replicas"
	Resourcesnamesred                    ViewVisualizationRenderer = "resources/names/red"
	Resourcesoperationsred               ViewVisualizationRenderer = "resources/operations/red"
	Resourcesoverviewoverview            ViewVisualizationRenderer = "resources/overview/overview"
	Resourcesservicesred                 ViewVisualizationRenderer = "resources/services/red"
	ResourcestableTree                   ViewVisualizationRenderer = "resources/*/table-tree"
	TracesExploreroutliers               ViewVisualizationRenderer = "traces-explorer/*/outliers"
	TracesExplorerred                    ViewVisualizationRenderer = "traces-explorer/*/red"
)

Defines values for ViewVisualizationRenderer.

Directories

Path Synopsis
Package dash0test provides testing utilities for the Dash0 API client.
Package dash0test provides testing utilities for the Dash0 API client.

Jump to

Keyboard shortcuts

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