duty

README

duty

Duty (Database Utility) is a home for common database tools, models and helpers used within the mission control suite of projects.

Duty wraps the awesome atlas library, and copies some of its code to make use of internal functions.

Documentation

Index

• Variables
• func BindFlags(flags *pflag.FlagSet)
• func CheckSummary(ctx DBContext, checkID string) (*models.CheckSummary, error)
• func DefaultGormConfig() *gorm.Config
• func DeleteNotificationSendHistory(ctx DBContext, days int) (int64, error)
• func FindCachedAgent(ctx DBContext, id string) (*models.Agent, error)
• func FindCachedCanary(ctx DBContext, id string) (*models.Canary, error)
• func FindCachedCheck(ctx DBContext, id string) (*models.Check, error)
• func FindCachedComponent(ctx DBContext, id string) (*models.Component, error)
• func FindCachedConfig(ctx DBContext, id string) (*models.ConfigItem, error)
• func FindCachedIncident(ctx DBContext, id string) (*models.Incident, error)
• func FindPerson(ctx DBContext, identifier string, opts ...GetterOption) (*models.Person, error)
• func FindTeam(ctx DBContext, identifier string, opts ...GetterOption) (*models.Team, error)
• func GetComponent(ctx gocontext.Context, db *gorm.DB, id string) (*models.Component, error)
• func GetConfigMapFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)
• func GetEnvStringFromCache(c kubernetes.Interface, env string, namespace string) (string, error)
• func GetEnvValueFromCache(c kubernetes.Interface, input types.EnvVar, namespace string) (string, error)
• func GetSecretFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)
• func InitDB(connection string, migrateOpts *migrate.MigrateOptions) (*dutyContext.Context, error)
• func LookupComponents(ctx context.Context, lookup LookupSpec, labels map[string]string, ...) ([]uuid.UUID, error)
• func LookupConfigs(ctx context.Context, lookup LookupSpec, labels map[string]string, ...) ([]uuid.UUID, error)
• func Migrate(connection string, opts *migrate.MigrateOptions) error
• func NewDB(connection string) (*sql.DB, error)
• func NewGorm(connection string, config *gorm.Config) (*gorm.DB, error)
• func NewGormLogger(level string) gLogger.Interface
• func NewPgxPool(connection string) (*pgxpool.Pool, error)
• func QueryCheckSummary(ctx gocontext.Context, dbpool *pgxpool.Pool, opts ...query.CheckSummaryOptions) ([]models.CheckSummary, error)
• func SetupDB(connection string, migrateOpts *migrate.MigrateOptions) (gormDB *gorm.DB, pgxpool *pgxpool.Pool, err error)
• type DBContext
• type GetterOption
• type GetterOptions
  • func (t GetterOptions) IsSet(option GetterOption) bool
• type Lookup
  • func (t *Lookup) Empty() bool
  • func (t *Lookup) Eval(labels map[string]string, envVar map[string]any) (string, error)
• type LookupEvalResult
• type LookupSpec
  • func (t *LookupSpec) Eval(labels map[string]string, envVar map[string]any) (*LookupEvalResult, error)
• type TopologyOptions
• type TopologyResponse
  • func QueryTopology(ctx gocontext.Context, dbpool *pgxpool.Pool, params TopologyOptions) (*TopologyResponse, error)

Variables

var DefaultQueryTimeout = 30 * time.Second

var LogLevel string

LogLevel is the log level for gorm logger

Functions

func BindFlags

func BindFlags(flags *pflag.FlagSet)

func CheckSummary

func CheckSummary(ctx DBContext, checkID string) (*models.CheckSummary, error)

deprecated use query.CheckSummaryByID

func DefaultGormConfig

func DefaultGormConfig() *gorm.Config

func DeleteNotificationSendHistory

func DeleteNotificationSendHistory(ctx DBContext, days int) (int64, error)

DeleteNotificationSendHistory deletes notification send history older than the given duration.

func FindCachedAgent

func FindCachedAgent(ctx DBContext, id string) (*models.Agent, error)

func FindCachedCanary

func FindCachedCanary(ctx DBContext, id string) (*models.Canary, error)

func FindCachedCheck

func FindCachedCheck(ctx DBContext, id string) (*models.Check, error)

func FindCachedComponent

func FindCachedComponent(ctx DBContext, id string) (*models.Component, error)

func FindCachedConfig

func FindCachedConfig(ctx DBContext, id string) (*models.ConfigItem, error)

func FindCachedIncident

func FindCachedIncident(ctx DBContext, id string) (*models.Incident, error)

func FindPerson

func FindPerson(ctx DBContext, identifier string, opts ...GetterOption) (*models.Person, error)

FindPerson looks up a person by the given identifier which can either be

• UUID
• email

func FindTeam

func FindTeam(ctx DBContext, identifier string, opts ...GetterOption) (*models.Team, error)

FindTeam looks up a team by the given identifier which can either be

• UUID
• team name

func GetComponent

func GetComponent(ctx gocontext.Context, db *gorm.DB, id string) (*models.Component, error)

deprecated use query.GetComponent

func GetConfigMapFromCache

func GetConfigMapFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)

deprecated use the methods in the context package

func GetEnvStringFromCache

func GetEnvStringFromCache(c kubernetes.Interface, env string, namespace string) (string, error)

deprecated use the methods in the context package

func GetEnvValueFromCache

func GetEnvValueFromCache(c kubernetes.Interface, input types.EnvVar, namespace string) (string, error)

deprecated use the methods in the context package

func GetSecretFromCache

func GetSecretFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)

deprecated use the methods in the context package

func InitDB

func InitDB(connection string, migrateOpts *migrate.MigrateOptions) (*dutyContext.Context, error)

func LookupComponents

func LookupComponents(ctx context.Context, lookup LookupSpec, labels map[string]string, env map[string]any) ([]uuid.UUID, error)

func LookupConfigs

func LookupConfigs(ctx context.Context, lookup LookupSpec, labels map[string]string, env map[string]any) ([]uuid.UUID, error)

func Migrate

func Migrate(connection string, opts *migrate.MigrateOptions) error

func NewDB

func NewDB(connection string) (*sql.DB, error)

func NewGorm

func NewGorm(connection string, config *gorm.Config) (*gorm.DB, error)

creates a new Gorm DB connection using the global pgx connection pool, must be called after NewPgxPool

func NewGormLogger

func NewGormLogger(level string) gLogger.Interface

func NewPgxPool

func NewPgxPool(connection string) (*pgxpool.Pool, error)

func QueryCheckSummary

func QueryCheckSummary(ctx gocontext.Context, dbpool *pgxpool.Pool, opts ...query.CheckSummaryOptions) ([]models.CheckSummary, error)

deprecated use query.CheckSummary

func SetupDB

func SetupDB(connection string, migrateOpts *migrate.MigrateOptions) (gormDB *gorm.DB, pgxpool *pgxpool.Pool, err error)

SetupDB runs migrations for the connection and returns a gorm.DB and a pgxpool.Pool

Types

type DBContext

type DBContext interface {
	context.Context
	DB() *gorm.DB
	Pool() *pgxpool.Pool
}

type GetterOption

type GetterOption uint8

const (
	GetterOptionNoCache GetterOption = iota + 1
)

type GetterOptions

type GetterOptions []GetterOption

func (GetterOptions) IsSet

func (t GetterOptions) IsSet(option GetterOption) bool

type Lookup

type Lookup struct {
	// Expr is a cel-expression.
	Expr string `json:"expr,omitempty" yaml:"expr,omitempty"`
	// Value is the static value to use.
	Value string `json:"value,omitempty" yaml:"value,omitempty"`
	// Label specifies the key to lookup on the label.
	Label string `json:"label,omitempty" yaml:"label,omitempty"`
}

Lookup specifies the type of lookup to perform.

func (*Lookup) Empty

func (t *Lookup) Empty() bool

func (*Lookup) Eval

func (t *Lookup) Eval(labels map[string]string, envVar map[string]any) (string, error)

type LookupEvalResult

type LookupEvalResult struct {
	Name      string
	Namespace string
	Type      string
}

LookupEvalResult is the result of evaluation of a LookupSpec.

type LookupSpec

type LookupSpec struct {
	Name      Lookup `json:"name,omitempty" yaml:"name,omitempty"`
	Namespace Lookup `json:"namespace,omitempty" yaml:"namespace,omitempty"`
	Type      Lookup `json:"type,omitempty" yaml:"type,omitempty"`
}

LookupSpec defines a tuple of fields to lookup.

func (*LookupSpec) Eval

func (t *LookupSpec) Eval(labels map[string]string, envVar map[string]any) (*LookupEvalResult, error)

Eval evaluates all the fields in the lookup spec based on labels and environment variables. Returns nil if any non-empty lookup evaluates to an empty value.

type TopologyOptions

type TopologyOptions = query.TopologyOptions

type TopologyResponse

type TopologyResponse = query.TopologyResponse

func QueryTopology

func QueryTopology(ctx gocontext.Context, dbpool *pgxpool.Pool, params TopologyOptions) (*TopologyResponse, error)

deprecated use query.Topology