query

Documentation

Index

• Constants
• Variables
• func CheckSummary(ctx context.Context, opts ...CheckSummaryOptions) (models.Checks, error)
• func CheckSummaryByID(ctx context.Context, checkID string) (*models.CheckSummary, error)
• func Config(ctx context.Context, sqlQuery string) ([]map[string]any, error)
• func GetComponent(ctx context.Context, id string) (*models.Component, error)
• func RefreshCheckStatusSummary(ctx context.Context) error
• type CheckSummaryOptions
  • func OrderByName() CheckSummaryOptions
• type CheckSummarySortBy
• type Tags
• type TopologyOptions
  • func (opt TopologyOptions) String() string
• type TopologyResponse
  • func Topology(ctx context.Context, params TopologyOptions) (*TopologyResponse, error)

Constants

const DefaultDepth = 5

Variables

var DefaultQueryTimeout = 30 * time.Second

Functions

func CheckSummary

func CheckSummary(ctx context.Context, opts ...CheckSummaryOptions) (models.Checks, error)

func CheckSummaryByID

func CheckSummaryByID(ctx context.Context, checkID string) (*models.CheckSummary, error)

func Config

func Config(ctx context.Context, sqlQuery string) ([]map[string]any, error)

Query executes a SQL query against the "config_" tables in the database.

func GetComponent

func GetComponent(ctx context.Context, id string) (*models.Component, error)

func RefreshCheckStatusSummary

func RefreshCheckStatusSummary(ctx context.Context) error

Types

type CheckSummaryOptions

type CheckSummaryOptions struct {
	Timeout    time.Duration
	CheckID    *uuid.UUID
	SortBy     CheckSummarySortBy
	DeleteFrom *time.Time

	// Labels apply to both the canary and check labels
	Labels map[string]string
}

func OrderByName

func OrderByName() CheckSummaryOptions

type CheckSummarySortBy

type CheckSummarySortBy string

var CheckSummarySortByName CheckSummarySortBy = "name"

type Tags

type Tags map[string][]string

Map of tag keys to the list of available values

type TopologyOptions

type TopologyOptions struct {
	ID      string
	Owner   string
	Labels  map[string]string
	AgentID string
	Flatten bool
	Depth   int
	// TODO: Filter status and types in DB Query
	Types  []string
	Status []string
	// contains filtered or unexported fields
}

func (TopologyOptions) String

func (opt TopologyOptions) String() string

type TopologyResponse

type TopologyResponse struct {
	Components     models.Components `json:"components"`
	HealthStatuses []string          `json:"healthStatuses"`
	Teams          []string          `json:"teams"`
	Tags           Tags              `json:"tags"`
	Types          []string          `json:"types"`
}

func Topology

func Topology(ctx context.Context, params TopologyOptions) (*TopologyResponse, error)