dash0

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Mar 6, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ChannelNameClear    = "clear"
	ChannelNameDegraded = "degraded"
	ChannelNameCritical = "critical"
)

Output channel names for ListIssues component

View Source 
const ChannelNameHealthy = "healthy"
View Source 
const (
	// MaxResponseSize limits the size of Prometheus API responses to prevent excessive memory usage
	// 1MB should be sufficient for most Prometheus queries while preventing abuse
	MaxResponseSize = 1 * 1024 * 1024 // 1MB
)

Variables

This section is empty.

Functions

func AssertionFieldSchema added in v0.9.0 

func AssertionFieldSchema() []configuration.Field

AssertionFieldSchema returns the configuration fields for a single assertion (used by create and update components).

Types

type AlertNotificationCheckRule added in v0.11.0 

type AlertNotificationCheckRule struct {
	ID            string         `json:"id"`
	Name          string         `json:"name"`
	For           string         `json:"for"`
	KeepFiringFor string         `json:"keepFiringFor"`
	Interval      string         `json:"interval"`
	Description   string         `json:"description"`
	URL           string         `json:"url"`
	Expression    string         `json:"expression"`
	Annotations   map[string]any `json:"annotations"`
	Labels        map[string]any `json:"labels"`
	Thresholds    map[string]any `json:"thresholds"`
}

type AlertNotificationData added in v0.11.0 

type AlertNotificationData struct {
	Issue *AlertNotificationIssue `json:"issue"`
}

type AlertNotificationEvent added in v0.11.0 

type AlertNotificationEvent struct {
	Type string                `json:"type"`
	Data AlertNotificationData `json:"data"`
}

type AlertNotificationIssue added in v0.11.0 

type AlertNotificationIssue struct {
	ID              string                        `json:"id"`
	IssueIdentifier string                        `json:"issueIdentifier"`
	Start           string                        `json:"start"`
	End             string                        `json:"end"`
	Status          string                        `json:"status"`
	Summary         string                        `json:"summary"`
	URL             string                        `json:"url"`
	Dataset         string                        `json:"dataset"`
	Description     string                        `json:"description"`
	CheckRules      []AlertNotificationCheckRule  `json:"checkrules"`
	Labels          []AlertNotificationIssueLabel `json:"labels"`
}

type AlertNotificationIssueLabel added in v0.11.0 

type AlertNotificationIssueLabel struct {
	Key   string                           `json:"key"`
	Value AlertNotificationIssueLabelValue `json:"value"`
}

type AlertNotificationIssueLabelValue added in v0.11.0 

type AlertNotificationIssueLabelValue struct {
	StringValue string `json:"stringValue"`
}

type AssertionSpec added in v0.9.0 

type AssertionSpec struct {
	Kind     string `mapstructure:"kind"`
	Severity string `mapstructure:"severity"`

	// Shared fields reused across assertion kinds
	Operator   string `mapstructure:"operator"`   // status_code, timing, ssl, response_header, json_body, text_body
	Value      string `mapstructure:"value"`      // status_code, timing, error_type, ssl, response_header, json_body, text_body
	Type       string `mapstructure:"type"`       // timing (phase: response, request, ssl, connection, dns, total)
	Name       string `mapstructure:"name"`       // response_header (header name)
	Expression string `mapstructure:"expression"` // json_body (JSONPath expression)
}

type CheckRule 

type CheckRule struct {
	ID   string `json:"id"`
	Name string `json:"name,omitempty"`
}

type Client 

type Client struct {
	Token   string
	BaseURL string
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(http core.HTTPContext, ctx core.IntegrationContext) (*Client, error)

func (*Client) CreateSyntheticCheck added in v0.9.0 

func (c *Client) CreateSyntheticCheck(request SyntheticCheckRequest, dataset string) (map[string]any, error)

func (*Client) DeleteSyntheticCheck added in v0.9.0 

func (c *Client) DeleteSyntheticCheck(checkID string, dataset string) (map[string]any, error)

DeleteSyntheticCheck deletes a synthetic check by ID (DELETE).

func (*Client) ExecutePrometheusInstantQuery 

func (c *Client) ExecutePrometheusInstantQuery(promQLQuery, dataset string) (map[string]any, error)

func (*Client) ExecutePrometheusRangeQuery 

func (c *Client) ExecutePrometheusRangeQuery(promQLQuery, dataset, start, end, step string) (map[string]any, error)

func (*Client) GetSyntheticCheck added in v0.11.0 

func (c *Client) GetSyntheticCheck(checkID string, dataset string) (*SyntheticCheckResponse, error)

GetSyntheticCheck retrieves a single synthetic check by ID (GET).

func (*Client) ListCheckRules 

func (c *Client) ListCheckRules() ([]CheckRule, error)

func (*Client) ListSyntheticChecks added in v0.9.0 

func (c *Client) ListSyntheticChecks(dataset string) ([]map[string]any, error)

func (*Client) UpdateSyntheticCheck added in v0.9.0 

func (c *Client) UpdateSyntheticCheck(checkID string, request SyntheticCheckRequest, dataset string) (map[string]any, error)

UpdateSyntheticCheck updates an existing synthetic check by ID (PUT). The check ID is typically from metadata.labels["dash0.com/id"] in a create response.

type Configuration 

type Configuration struct {
	APIToken string `json:"apiToken"`
	BaseURL  string `json:"baseURL"`
}

type CreateHTTPSyntheticCheck added in v0.9.0 

type CreateHTTPSyntheticCheck struct{}

func (*CreateHTTPSyntheticCheck) Actions added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Actions() []core.Action

func (*CreateHTTPSyntheticCheck) Cancel added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Cancel(ctx core.ExecutionContext) error

func (*CreateHTTPSyntheticCheck) Cleanup added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Cleanup(ctx core.SetupContext) error

func (*CreateHTTPSyntheticCheck) Color added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Color() string

func (*CreateHTTPSyntheticCheck) Configuration added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Configuration() []configuration.Field

func (*CreateHTTPSyntheticCheck) Description added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Description() string

func (*CreateHTTPSyntheticCheck) Documentation added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Documentation() string

func (*CreateHTTPSyntheticCheck) ExampleOutput added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) ExampleOutput() map[string]any

func (*CreateHTTPSyntheticCheck) Execute added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Execute(ctx core.ExecutionContext) error

func (*CreateHTTPSyntheticCheck) HandleAction added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) HandleAction(ctx core.ActionContext) error

func (*CreateHTTPSyntheticCheck) HandleWebhook added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*CreateHTTPSyntheticCheck) Icon added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Icon() string

func (*CreateHTTPSyntheticCheck) Label added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Label() string

func (*CreateHTTPSyntheticCheck) Name added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Name() string

func (*CreateHTTPSyntheticCheck) OutputChannels added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) OutputChannels(configuration any) []core.OutputChannel

func (*CreateHTTPSyntheticCheck) ProcessQueueItem added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*CreateHTTPSyntheticCheck) Setup added in v0.9.0 

func (c *CreateHTTPSyntheticCheck) Setup(ctx core.SetupContext) error

type CreateHTTPSyntheticCheckSpec added in v0.9.0 

type CreateHTTPSyntheticCheckSpec struct {
	Name       string           `mapstructure:"name"`
	Dataset    string           `mapstructure:"dataset"`
	Request    RequestSpec      `mapstructure:"request"`
	Schedule   ScheduleSpec     `mapstructure:"schedule"`
	Assertions *[]AssertionSpec `mapstructure:"assertions"`
	Retries    *RetrySpec       `mapstructure:"retries"`
}

type Dash0 

type Dash0 struct{}

func (*Dash0) Actions added in v0.6.0 

func (d *Dash0) Actions() []core.Action

func (*Dash0) Cleanup added in v0.6.0 

func (d *Dash0) Cleanup(ctx core.IntegrationCleanupContext) error

func (*Dash0) Components 

func (d *Dash0) Components() []core.Component

func (*Dash0) Configuration 

func (d *Dash0) Configuration() []configuration.Field

func (*Dash0) Description 

func (d *Dash0) Description() string

func (*Dash0) HandleAction added in v0.6.0 

func (d *Dash0) HandleAction(ctx core.IntegrationActionContext) error

func (*Dash0) HandleRequest 

func (d *Dash0) HandleRequest(ctx core.HTTPRequestContext)

func (*Dash0) Icon 

func (d *Dash0) Icon() string

func (*Dash0) Instructions 

func (d *Dash0) Instructions() string

func (*Dash0) Label 

func (d *Dash0) Label() string

func (*Dash0) ListResources 

func (d *Dash0) ListResources(resourceType string, ctx core.ListResourcesContext) ([]core.IntegrationResource, error)

func (*Dash0) Name 

func (d *Dash0) Name() string

func (*Dash0) Sync 

func (d *Dash0) Sync(ctx core.SyncContext) error

func (*Dash0) Triggers 

func (d *Dash0) Triggers() []core.Trigger

type DeleteHTTPSyntheticCheck added in v0.9.0 

type DeleteHTTPSyntheticCheck struct{}

func (*DeleteHTTPSyntheticCheck) Actions added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Actions() []core.Action

func (*DeleteHTTPSyntheticCheck) Cancel added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Cancel(ctx core.ExecutionContext) error

func (*DeleteHTTPSyntheticCheck) Cleanup added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Cleanup(ctx core.SetupContext) error

func (*DeleteHTTPSyntheticCheck) Color added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Color() string

func (*DeleteHTTPSyntheticCheck) Configuration added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Configuration() []configuration.Field

func (*DeleteHTTPSyntheticCheck) Description added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Description() string

func (*DeleteHTTPSyntheticCheck) Documentation added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Documentation() string

func (*DeleteHTTPSyntheticCheck) ExampleOutput added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) ExampleOutput() map[string]any

func (*DeleteHTTPSyntheticCheck) Execute added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Execute(ctx core.ExecutionContext) error

func (*DeleteHTTPSyntheticCheck) HandleAction added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) HandleAction(ctx core.ActionContext) error

func (*DeleteHTTPSyntheticCheck) HandleWebhook added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*DeleteHTTPSyntheticCheck) Icon added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Icon() string

func (*DeleteHTTPSyntheticCheck) Label added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Label() string

func (*DeleteHTTPSyntheticCheck) Name added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Name() string

func (*DeleteHTTPSyntheticCheck) OutputChannels added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) OutputChannels(configuration any) []core.OutputChannel

func (*DeleteHTTPSyntheticCheck) ProcessQueueItem added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*DeleteHTTPSyntheticCheck) Setup added in v0.9.0 

func (c *DeleteHTTPSyntheticCheck) Setup(ctx core.SetupContext) error

type DeleteHTTPSyntheticCheckSpec added in v0.9.0 

type DeleteHTTPSyntheticCheckSpec struct {
	CheckID string `mapstructure:"checkId"`
	Dataset string `mapstructure:"dataset"`
}

type GetHTTPSyntheticCheck added in v0.11.0 

type GetHTTPSyntheticCheck struct{}

func (*GetHTTPSyntheticCheck) Actions added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Actions() []core.Action

func (*GetHTTPSyntheticCheck) Cancel added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Cancel(ctx core.ExecutionContext) error

func (*GetHTTPSyntheticCheck) Cleanup added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Cleanup(ctx core.SetupContext) error

func (*GetHTTPSyntheticCheck) Color added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Color() string

func (*GetHTTPSyntheticCheck) Configuration added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Configuration() []configuration.Field

func (*GetHTTPSyntheticCheck) Description added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Description() string

func (*GetHTTPSyntheticCheck) Documentation added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Documentation() string

func (*GetHTTPSyntheticCheck) ExampleOutput added in v0.11.0 

func (c *GetHTTPSyntheticCheck) ExampleOutput() map[string]any

func (*GetHTTPSyntheticCheck) Execute added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Execute(ctx core.ExecutionContext) error

func (*GetHTTPSyntheticCheck) HandleAction added in v0.11.0 

func (c *GetHTTPSyntheticCheck) HandleAction(ctx core.ActionContext) error

func (*GetHTTPSyntheticCheck) HandleWebhook added in v0.11.0 

func (c *GetHTTPSyntheticCheck) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*GetHTTPSyntheticCheck) Icon added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Icon() string

func (*GetHTTPSyntheticCheck) Label added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Label() string

func (*GetHTTPSyntheticCheck) Name added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Name() string

func (*GetHTTPSyntheticCheck) OutputChannels added in v0.11.0 

func (c *GetHTTPSyntheticCheck) OutputChannels(configuration any) []core.OutputChannel

func (*GetHTTPSyntheticCheck) ProcessQueueItem added in v0.11.0 

func (c *GetHTTPSyntheticCheck) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*GetHTTPSyntheticCheck) Setup added in v0.11.0 

func (c *GetHTTPSyntheticCheck) Setup(ctx core.SetupContext) error

type GetHTTPSyntheticCheckNodeMetadata added in v0.11.0 

type GetHTTPSyntheticCheckNodeMetadata struct {
	CheckName string `json:"checkName" mapstructure:"checkName"`
}

type GetHTTPSyntheticCheckSpec added in v0.11.0 

type GetHTTPSyntheticCheckSpec struct {
	CheckID string `mapstructure:"checkId"`
	Dataset string `mapstructure:"dataset"`
}
type Header struct {
	Name  string `mapstructure:"name"`
	Value string `mapstructure:"value"`
}

type ListIssues 

type ListIssues struct{}

func (*ListIssues) Actions 

func (l *ListIssues) Actions() []core.Action

func (*ListIssues) Cancel 

func (l *ListIssues) Cancel(ctx core.ExecutionContext) error

func (*ListIssues) Cleanup added in v0.7.0 

func (l *ListIssues) Cleanup(ctx core.SetupContext) error

func (*ListIssues) Color 

func (l *ListIssues) Color() string

func (*ListIssues) Configuration 

func (l *ListIssues) Configuration() []configuration.Field

func (*ListIssues) Description 

func (l *ListIssues) Description() string

func (*ListIssues) Documentation 

func (l *ListIssues) Documentation() string

func (*ListIssues) ExampleOutput 

func (c *ListIssues) ExampleOutput() map[string]any

func (*ListIssues) Execute 

func (l *ListIssues) Execute(ctx core.ExecutionContext) error

func (*ListIssues) HandleAction 

func (l *ListIssues) HandleAction(ctx core.ActionContext) error

func (*ListIssues) HandleWebhook 

func (l *ListIssues) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*ListIssues) Icon 

func (l *ListIssues) Icon() string

func (*ListIssues) Label 

func (l *ListIssues) Label() string

func (*ListIssues) Name 

func (l *ListIssues) Name() string

func (*ListIssues) OutputChannels 

func (l *ListIssues) OutputChannels(configuration any) []core.OutputChannel

func (*ListIssues) ProcessQueueItem 

func (l *ListIssues) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*ListIssues) Setup 

func (l *ListIssues) Setup(ctx core.SetupContext) error

type ListIssuesNodeMetadata 

type ListIssuesNodeMetadata struct {
	CheckRules []CheckRule `json:"checkRules" mapstructure:"checkRules"`
}

type ListIssuesSpec 

type ListIssuesSpec struct {
	CheckRules []string `json:"checkRules,omitempty"`
}

type Metadata 

type Metadata struct {
	WebhookURL string `json:"webhookUrl" mapstructure:"webhookUrl"`
}

type OnAlertNotification added in v0.11.0 

type OnAlertNotification struct{}

func (*OnAlertNotification) Actions added in v0.11.0 

func (t *OnAlertNotification) Actions() []core.Action

func (*OnAlertNotification) Cleanup added in v0.11.0 

func (t *OnAlertNotification) Cleanup(ctx core.TriggerContext) error

func (*OnAlertNotification) Color added in v0.11.0 

func (t *OnAlertNotification) Color() string

func (*OnAlertNotification) Configuration added in v0.11.0 

func (t *OnAlertNotification) Configuration() []configuration.Field

func (*OnAlertNotification) Description added in v0.11.0 

func (t *OnAlertNotification) Description() string

func (*OnAlertNotification) Documentation added in v0.11.0 

func (t *OnAlertNotification) Documentation() string

func (*OnAlertNotification) ExampleData added in v0.11.0 

func (t *OnAlertNotification) ExampleData() map[string]any

func (*OnAlertNotification) HandleAction added in v0.11.0 

func (t *OnAlertNotification) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnAlertNotification) HandleWebhook added in v0.11.0 

func (t *OnAlertNotification) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnAlertNotification) Icon added in v0.11.0 

func (t *OnAlertNotification) Icon() string

func (*OnAlertNotification) Label added in v0.11.0 

func (t *OnAlertNotification) Label() string

func (*OnAlertNotification) Name added in v0.11.0 

func (t *OnAlertNotification) Name() string

func (*OnAlertNotification) OnIntegrationMessage added in v0.11.0 

func (t *OnAlertNotification) OnIntegrationMessage(ctx core.IntegrationMessageContext) error

func (*OnAlertNotification) Setup added in v0.11.0 

func (t *OnAlertNotification) Setup(ctx core.TriggerContext) error

type OnAlertNotificationConfiguration added in v0.11.0 

type OnAlertNotificationConfiguration struct {
	Statuses []string `json:"statuses" mapstructure:"statuses"`
}

type OnAlertNotificationMetadata added in v0.11.0 

type OnAlertNotificationMetadata struct {
	SubscriptionID string `json:"subscriptionId,omitempty" mapstructure:"subscriptionId"`
}

type OnSyntheticCheckNotification added in v0.11.0 

type OnSyntheticCheckNotification struct{}

func (*OnSyntheticCheckNotification) Actions added in v0.11.0 

func (t *OnSyntheticCheckNotification) Actions() []core.Action

func (*OnSyntheticCheckNotification) Cleanup added in v0.11.0 

func (t *OnSyntheticCheckNotification) Cleanup(ctx core.TriggerContext) error

func (*OnSyntheticCheckNotification) Color added in v0.11.0 

func (t *OnSyntheticCheckNotification) Color() string

func (*OnSyntheticCheckNotification) Configuration added in v0.11.0 

func (t *OnSyntheticCheckNotification) Configuration() []configuration.Field

func (*OnSyntheticCheckNotification) Description added in v0.11.0 

func (t *OnSyntheticCheckNotification) Description() string

func (*OnSyntheticCheckNotification) Documentation added in v0.11.0 

func (t *OnSyntheticCheckNotification) Documentation() string

func (*OnSyntheticCheckNotification) ExampleData added in v0.11.0 

func (t *OnSyntheticCheckNotification) ExampleData() map[string]any

func (*OnSyntheticCheckNotification) HandleAction added in v0.11.0 

func (t *OnSyntheticCheckNotification) HandleAction(ctx core.TriggerActionContext) (map[string]any, error)

func (*OnSyntheticCheckNotification) HandleWebhook added in v0.11.0 

func (t *OnSyntheticCheckNotification) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*OnSyntheticCheckNotification) Icon added in v0.11.0 

func (t *OnSyntheticCheckNotification) Icon() string

func (*OnSyntheticCheckNotification) Label added in v0.11.0 

func (t *OnSyntheticCheckNotification) Label() string

func (*OnSyntheticCheckNotification) Name added in v0.11.0 

func (t *OnSyntheticCheckNotification) Name() string

func (*OnSyntheticCheckNotification) OnIntegrationMessage added in v0.11.0 

func (t *OnSyntheticCheckNotification) OnIntegrationMessage(ctx core.IntegrationMessageContext) error

func (*OnSyntheticCheckNotification) Setup added in v0.11.0 

func (t *OnSyntheticCheckNotification) Setup(ctx core.TriggerContext) error

type OnSyntheticCheckNotificationConfiguration added in v0.11.0 

type OnSyntheticCheckNotificationConfiguration struct {
	Statuses []string `json:"statuses" mapstructure:"statuses"`
}

type OnSyntheticCheckNotificationMetadata added in v0.11.0 

type OnSyntheticCheckNotificationMetadata struct {
	SubscriptionID string `json:"subscriptionId,omitempty" mapstructure:"subscriptionId"`
}

type PrometheusQueryResult 

type PrometheusQueryResult struct {
	Metric map[string]string `json:"metric"`
	Value  []interface{}     `json:"value,omitempty"`  // For instant queries: [timestamp, value]
	Values [][]interface{}   `json:"values,omitempty"` // For range queries: [[timestamp, value], ...]
}

type PrometheusResponse 

type PrometheusResponse struct {
	Status string                 `json:"status"`
	Data   PrometheusResponseData `json:"data"`
}

type PrometheusResponseData 

type PrometheusResponseData struct {
	ResultType string                  `json:"resultType"`
	Result     []PrometheusQueryResult `json:"result"`
}

type QueryPrometheus 

type QueryPrometheus struct{}

func (*QueryPrometheus) Actions 

func (q *QueryPrometheus) Actions() []core.Action

func (*QueryPrometheus) Cancel 

func (q *QueryPrometheus) Cancel(ctx core.ExecutionContext) error

func (*QueryPrometheus) Cleanup added in v0.7.0 

func (q *QueryPrometheus) Cleanup(ctx core.SetupContext) error

func (*QueryPrometheus) Color 

func (q *QueryPrometheus) Color() string

func (*QueryPrometheus) Configuration 

func (q *QueryPrometheus) Configuration() []configuration.Field

func (*QueryPrometheus) Description 

func (q *QueryPrometheus) Description() string

func (*QueryPrometheus) Documentation 

func (q *QueryPrometheus) Documentation() string

func (*QueryPrometheus) ExampleOutput 

func (c *QueryPrometheus) ExampleOutput() map[string]any

func (*QueryPrometheus) Execute 

func (q *QueryPrometheus) Execute(ctx core.ExecutionContext) error

func (*QueryPrometheus) HandleAction 

func (q *QueryPrometheus) HandleAction(ctx core.ActionContext) error

func (*QueryPrometheus) HandleWebhook 

func (q *QueryPrometheus) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*QueryPrometheus) Icon 

func (q *QueryPrometheus) Icon() string

func (*QueryPrometheus) Label 

func (q *QueryPrometheus) Label() string

func (*QueryPrometheus) Name 

func (q *QueryPrometheus) Name() string

func (*QueryPrometheus) OutputChannels 

func (q *QueryPrometheus) OutputChannels(configuration any) []core.OutputChannel

func (*QueryPrometheus) ProcessQueueItem 

func (q *QueryPrometheus) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*QueryPrometheus) Setup 

func (q *QueryPrometheus) Setup(ctx core.SetupContext) error

type QueryPrometheusSpec 

type QueryPrometheusSpec struct {
	Query   string  `json:"query"`
	Dataset string  `json:"dataset"`
	Type    string  `json:"type"`            // "instant" or "range"
	Start   *string `json:"start,omitempty"` // For range queries, e.g., "now-5m"
	End     *string `json:"end,omitempty"`   // For range queries, e.g., "now"
	Step    *string `json:"step,omitempty"`  // For range queries, e.g., "15s"
}

type RequestSpec added in v0.9.0 

type RequestSpec struct {
	URL           string    `mapstructure:"url"`
	Method        string    `mapstructure:"method"`
	Redirects     string    `mapstructure:"redirects"`
	AllowInsecure string    `mapstructure:"allowInsecure"`
	Headers       *[]Header `mapstructure:"headers"`
	Body          *string   `mapstructure:"body"`
}

type RetrySpec added in v0.9.0 

type RetrySpec struct {
	Attempts int    `mapstructure:"attempts"`
	Delay    string `mapstructure:"delay"`
}

type ScheduleSpec added in v0.9.0 

type ScheduleSpec struct {
	Strategy  string   `mapstructure:"strategy"`
	Locations []string `mapstructure:"locations"`
	Interval  string   `mapstructure:"interval"`
}

type SubscriptionConfiguration added in v0.9.0 

type SubscriptionConfiguration struct{}

type SyntheticCheckAssertion added in v0.9.0 

type SyntheticCheckAssertion struct {
	Kind string         `json:"kind"`
	Spec map[string]any `json:"spec"`
}

SyntheticCheckAssertion represents a single assertion in a synthetic check.

type SyntheticCheckAssertions added in v0.9.0 

type SyntheticCheckAssertions struct {
	CriticalAssertions []SyntheticCheckAssertion `json:"criticalAssertions"`
	DegradedAssertions []SyntheticCheckAssertion `json:"degradedAssertions"`
}

SyntheticCheckAssertions groups critical and degraded assertions.

func BuildSyntheticCheckAssertions added in v0.9.0 

func BuildSyntheticCheckAssertions(assertions *[]AssertionSpec) SyntheticCheckAssertions

BuildSyntheticCheckAssertions builds the API assertions payload from spec (shared by create and update components).

type SyntheticCheckDisplay added in v0.9.0 

type SyntheticCheckDisplay struct {
	Name string `json:"name"`
}

SyntheticCheckDisplay contains the display name for a synthetic check.

type SyntheticCheckHTTPRequest added in v0.9.0 

type SyntheticCheckHTTPRequest struct {
	Method          string                 `json:"method"`
	URL             string                 `json:"url"`
	Headers         []SyntheticCheckHeader `json:"headers"`
	QueryParameters []any                  `json:"queryParameters"`
	Body            *string                `json:"body,omitempty"`
	Redirects       string                 `json:"redirects"`
	TLS             SyntheticCheckTLS      `json:"tls"`
	Tracing         SyntheticCheckTracing  `json:"tracing"`
}

SyntheticCheckHTTPRequest defines the HTTP request configuration.

type SyntheticCheckHeader added in v0.9.0 

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

SyntheticCheckHeader represents an HTTP header key-value pair.

type SyntheticCheckMetadata added in v0.9.0 

type SyntheticCheckMetadata struct {
	Name   string         `json:"name"`
	Labels map[string]any `json:"labels"`
}

SyntheticCheckMetadata contains the check name and labels.

type SyntheticCheckMetrics added in v0.11.0 

type SyntheticCheckMetrics struct {
	HealthyRuns24h  int     `json:"healthyRuns24h"`
	CriticalRuns24h int     `json:"criticalRuns24h"`
	TotalRuns24h    int     `json:"totalRuns24h"`
	AvgDuration24h  float64 `json:"avgDuration24hMs"` // Milliseconds
	HealthyRuns7d   int     `json:"healthyRuns7d"`
	CriticalRuns7d  int     `json:"criticalRuns7d"`
	TotalRuns7d     int     `json:"totalRuns7d"`
	AvgDuration7d   float64 `json:"avgDuration7dMs"` // Milliseconds
	LastOutcome     string  `json:"lastOutcome"`     // Most recent run outcome: Healthy or Critical
}

SyntheticCheckMetrics contains operational metrics for a synthetic check.

func FetchSyntheticCheckMetrics added in v0.11.0 

func FetchSyntheticCheckMetrics(ctx core.ExecutionContext, client *Client, dataset, checkID string) *SyntheticCheckMetrics

FetchSyntheticCheckMetrics queries the Dash0 Prometheus API for operational metrics of a synthetic check identified by its dash0_check_id.

type SyntheticCheckNotificationCheckRule added in v0.11.0 

type SyntheticCheckNotificationCheckRule struct {
	ID            string         `json:"id"`
	Name          string         `json:"name"`
	For           string         `json:"for"`
	KeepFiringFor string         `json:"keepFiringFor"`
	Interval      string         `json:"interval"`
	Description   string         `json:"description"`
	URL           string         `json:"url"`
	Expression    string         `json:"expression"`
	Annotations   map[string]any `json:"annotations"`
	Labels        map[string]any `json:"labels"`
	Thresholds    map[string]any `json:"thresholds"`
}

type SyntheticCheckNotificationData added in v0.11.0 

type SyntheticCheckNotificationData struct {
	Issue *SyntheticCheckNotificationIssue `json:"issue"`
}

type SyntheticCheckNotificationEvent added in v0.11.0 

type SyntheticCheckNotificationEvent struct {
	Type string                         `json:"type"`
	Data SyntheticCheckNotificationData `json:"data"`
}

type SyntheticCheckNotificationIssue added in v0.11.0 

type SyntheticCheckNotificationIssue struct {
	ID              string                                `json:"id"`
	IssueIdentifier string                                `json:"issueIdentifier"`
	Start           string                                `json:"start"`
	End             string                                `json:"end"`
	Status          string                                `json:"status"`
	Summary         string                                `json:"summary"`
	URL             string                                `json:"url"`
	Dataset         string                                `json:"dataset"`
	Description     string                                `json:"description"`
	CheckRules      []SyntheticCheckNotificationCheckRule `json:"checkrules"`
	Labels          []any                                 `json:"labels" mapstructure:"labels"`
}

SyntheticCheckNotificationIssue represents the issue in a synthetic check notification.

type SyntheticCheckNotifications added in v0.11.0 

type SyntheticCheckNotifications struct {
	Channels             []string `json:"channels"`
	OnlyCriticalChannels []string `json:"onlyCriticalChannels"`
}

type SyntheticCheckPlugin added in v0.9.0 

type SyntheticCheckPlugin struct {
	Display SyntheticCheckDisplay    `json:"display"`
	Kind    string                   `json:"kind"`
	Spec    SyntheticCheckPluginSpec `json:"spec"`
}

SyntheticCheckPlugin contains the check type, display metadata, and specification.

type SyntheticCheckPluginSpec added in v0.9.0 

type SyntheticCheckPluginSpec struct {
	Request    SyntheticCheckHTTPRequest `json:"request"`
	Assertions SyntheticCheckAssertions  `json:"assertions"`
	Retries    SyntheticCheckRetries     `json:"retries"`
}

SyntheticCheckPluginSpec contains the HTTP request, assertions, and retries for a synthetic check.

type SyntheticCheckRequest added in v0.9.0 

type SyntheticCheckRequest struct {
	Kind     string                     `json:"kind"`
	Metadata SyntheticCheckMetadata     `json:"metadata"`
	Spec     SyntheticCheckTopLevelSpec `json:"spec"`
}

SyntheticCheckRequest represents the full request payload for creating a synthetic check. Matches the Dash0 API envelope: kind + metadata + spec.

func BuildSyntheticCheckRequest added in v0.9.0 

func BuildSyntheticCheckRequest(name string, req RequestSpec, sched ScheduleSpec, assertions SyntheticCheckAssertions, retries *RetrySpec) SyntheticCheckRequest

BuildSyntheticCheckRequest builds the API request payload from spec fields (shared by create and update components).

type SyntheticCheckResponse added in v0.11.0 

type SyntheticCheckResponse struct {
	Kind     string                         `json:"kind"`
	Metadata SyntheticCheckResponseMetadata `json:"metadata"`
	Spec     SyntheticCheckResponseSpec     `json:"spec"`
}

SyntheticCheckResponse represents the response from the Dash0 GET Synthetic Check API.

type SyntheticCheckResponseMetadata added in v0.11.0 

type SyntheticCheckResponseMetadata struct {
	Annotations map[string]any    `json:"annotations"`
	Description string            `json:"description"`
	Labels      map[string]string `json:"labels"`
	Name        string            `json:"name"`
}

type SyntheticCheckResponsePlugin added in v0.11.0 

type SyntheticCheckResponsePlugin struct {
	Kind string                           `json:"kind"`
	Spec SyntheticCheckResponsePluginSpec `json:"spec"`
}

type SyntheticCheckResponsePluginSpec added in v0.11.0 

type SyntheticCheckResponsePluginSpec struct {
	Assertions SyntheticCheckAssertions  `json:"assertions"`
	Request    SyntheticCheckHTTPRequest `json:"request"`
}

type SyntheticCheckResponseRetries added in v0.11.0 

type SyntheticCheckResponseRetries struct {
	Kind string         `json:"kind"`
	Spec map[string]any `json:"spec"`
}

type SyntheticCheckResponseSpec added in v0.11.0 

type SyntheticCheckResponseSpec struct {
	Display       SyntheticCheckDisplay         `json:"display"`
	Enabled       bool                          `json:"enabled"`
	Labels        map[string]any                `json:"labels"`
	Notifications SyntheticCheckNotifications   `json:"notifications"`
	Plugin        SyntheticCheckResponsePlugin  `json:"plugin"`
	Retries       SyntheticCheckResponseRetries `json:"retries"`
	Schedule      SyntheticCheckSchedule        `json:"schedule"`
}

type SyntheticCheckRetries added in v0.9.0 

type SyntheticCheckRetries struct {
	Kind string                    `json:"kind"`
	Spec SyntheticCheckRetriesSpec `json:"spec"`
}

SyntheticCheckRetries defines retry behavior for failed checks.

type SyntheticCheckRetriesSpec added in v0.9.0 

type SyntheticCheckRetriesSpec struct {
	Attempts int    `json:"attempts"`
	Delay    string `json:"delay"`
}

SyntheticCheckRetriesSpec contains the retry parameters.

type SyntheticCheckSchedule added in v0.9.0 

type SyntheticCheckSchedule struct {
	Interval  string   `json:"interval"`
	Locations []string `json:"locations"`
	Strategy  string   `json:"strategy"`
}

SyntheticCheckSchedule defines how often and where a check runs.

type SyntheticCheckTLS added in v0.9.0 

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

SyntheticCheckTLS holds TLS configuration.

type SyntheticCheckTopLevelSpec added in v0.9.0 

type SyntheticCheckTopLevelSpec struct {
	Enabled  bool                   `json:"enabled"`
	Schedule SyntheticCheckSchedule `json:"schedule"`
	Plugin   SyntheticCheckPlugin   `json:"plugin"`
}

SyntheticCheckTopLevelSpec wraps the plugin, schedule, retries, and enabled flag.

type SyntheticCheckTracing added in v0.9.0 

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

SyntheticCheckTracing holds tracing configuration.

type UpdateHTTPSyntheticCheck added in v0.9.0 

type UpdateHTTPSyntheticCheck struct{}

func (*UpdateHTTPSyntheticCheck) Actions added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Actions() []core.Action

func (*UpdateHTTPSyntheticCheck) Cancel added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Cancel(ctx core.ExecutionContext) error

func (*UpdateHTTPSyntheticCheck) Cleanup added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Cleanup(ctx core.SetupContext) error

func (*UpdateHTTPSyntheticCheck) Color added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Color() string

func (*UpdateHTTPSyntheticCheck) Configuration added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Configuration() []configuration.Field

func (*UpdateHTTPSyntheticCheck) Description added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Description() string

func (*UpdateHTTPSyntheticCheck) Documentation added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Documentation() string

func (*UpdateHTTPSyntheticCheck) ExampleOutput added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) ExampleOutput() map[string]any

func (*UpdateHTTPSyntheticCheck) Execute added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Execute(ctx core.ExecutionContext) error

func (*UpdateHTTPSyntheticCheck) HandleAction added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) HandleAction(ctx core.ActionContext) error

func (*UpdateHTTPSyntheticCheck) HandleWebhook added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) HandleWebhook(ctx core.WebhookRequestContext) (int, error)

func (*UpdateHTTPSyntheticCheck) Icon added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Icon() string

func (*UpdateHTTPSyntheticCheck) Label added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Label() string

func (*UpdateHTTPSyntheticCheck) Name added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Name() string

func (*UpdateHTTPSyntheticCheck) OutputChannels added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) OutputChannels(configuration any) []core.OutputChannel

func (*UpdateHTTPSyntheticCheck) ProcessQueueItem added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) ProcessQueueItem(ctx core.ProcessQueueContext) (*uuid.UUID, error)

func (*UpdateHTTPSyntheticCheck) Setup added in v0.9.0 

func (c *UpdateHTTPSyntheticCheck) Setup(ctx core.SetupContext) error

type UpdateHTTPSyntheticCheckSpec added in v0.9.0 

type UpdateHTTPSyntheticCheckSpec struct {
	CheckID    string           `mapstructure:"checkId"`
	Name       string           `mapstructure:"name"`
	Dataset    string           `mapstructure:"dataset"`
	Request    RequestSpec      `mapstructure:"request"`
	Schedule   ScheduleSpec     `mapstructure:"schedule"`
	Assertions *[]AssertionSpec `mapstructure:"assertions"`
	Retries    *RetrySpec       `mapstructure:"retries"`
}

UpdateHTTPSyntheticCheckSpec has CheckID plus the same spec fields as create (full replacement).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.