duty

README

duty

Duty (Database Utility) is a home for common database tools, models and helpers.

Documentation

Index

• Constants
• Variables
• func CheckSummary(ctx DBContext, checkID string) (*models.CheckSummary, error)
• func DefaultGormConfig() *gorm.Config
• 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 FindConnection(ctx context.Context, db *gorm.DB, connectionType, name string) (*models.Connection, error)
• func FindConnectionByURL(ctx context.Context, db *gorm.DB, connectionString string) (*models.Connection, 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 context.Context, db *gorm.DB, id string) (*models.Component, error)
• func GetConfigMapFromCache(c kubernetes.Interface, namespace, name, key string) (string, error)
• func GetConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, ...) (*models.Connection, 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 HydrateConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, ...) (*models.Connection, error)
• func HydratedConnectionByURL(ctx context.Context, db *gorm.DB, k8sClient kubernetes.Interface, ...) (*models.Connection, error)
• func IsValidConnectionURL(connectionString string) bool
• 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 NewPgxPool(connection string) (*pgxpool.Pool, error)
• func QueryCheckSummary(ctx context.Context, dbpool *pgxpool.Pool) (models.Checks, error)
• func RefreshCheckStatusSummary(dbpool *pgxpool.Pool) 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 Tags
• type TopologyOptions
  • func (opt TopologyOptions) String() string
• type TopologyResponse
  • func QueryTopology(ctx context.Context, dbpool *pgxpool.Pool, params TopologyOptions) (*TopologyResponse, error)

Constants

const DefaultDepth = 5

Variables

var DefaultQueryTimeout = 30 * time.Second

var (
	ErrNotFound = errors.New("NOT_FOUND")
)

Functions

func CheckSummary

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

func DefaultGormConfig

func DefaultGormConfig() *gorm.Config

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 FindConnection

func FindConnection(ctx context.Context, db *gorm.DB, connectionType, name string) (*models.Connection, error)

FindConnection returns the connection with the given type and name

func FindConnectionByURL

func FindConnectionByURL(ctx context.Context, db *gorm.DB, connectionString string) (*models.Connection, error)

FindConnectionByURL retrieves a connection from the given connection string. The connection string is expected to be of the form: connection://<type>/<name>

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 context.Context, db *gorm.DB, id string) (*models.Component, error)

func GetConfigMapFromCache

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

func GetConnection

func GetConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, connectionType string, name string, namespace string) (*models.Connection, error)

func GetEnvStringFromCache

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

func GetEnvValueFromCache

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

func GetSecretFromCache

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

func HydrateConnection

func HydrateConnection(ctx context.Context, client kubernetes.Interface, db *gorm.DB, connection *models.Connection, namespace string) (*models.Connection, error)

Create a cache with a default expiration time of 5 minutes, and which purges expired items every 10 minutes var connectionCache = cache.New(5*time.Minute, 10*time.Minute)

func HydratedConnectionByURL

func HydratedConnectionByURL(ctx context.Context, db *gorm.DB, k8sClient kubernetes.Interface, namespace, connectionString string) (*models.Connection, error)

HydratedConnectionByURL retrieves a connection from the given connection string. The connection string is expected to be in one of the following forms:

• connection://<type>/<name> or
• the UUID of the connection.

func IsValidConnectionURL

func IsValidConnectionURL(connectionString string) bool

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 NewPgxPool

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

func QueryCheckSummary

func QueryCheckSummary(ctx context.Context, dbpool *pgxpool.Pool) (models.Checks, error)

func RefreshCheckStatusSummary

func RefreshCheckStatusSummary(dbpool *pgxpool.Pool) error

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
}

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 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
}

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 QueryTopology

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