duty

package module
v1.0.1260 Latest Latest
Warning

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

 Go to latest Published: Apr 14, 2026 License: Apache-2.0 Imports: 39 Imported by: 22

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.

Running Tests

make test will run tests against a new embedded postgres instance

Env Vars
  • DUTY_DB_URL: the postgres db, each test will run against a new database called duty_gingko
  • TEST_DB_PORT: will set the port that the test database will run on.

Documentation

Index

Constants

View Source 
const SessionPropertyPrefix = "postgres.session."

SessionPropertyPrefix is the property-name prefix used to route values into Postgres session/transaction-local settings. A property "postgres.session.debug_log.enabled=on" translates to `SET LOCAL debug_log.enabled = 'on'` inside the provided transaction.

Variables

View Source 
var ClientOnly = func(config api.Config) api.Config {
	config.Postgrest.Disable = true
	config.SkipMigrations = true
	return config
}
View Source 
var DefaultQueryTimeout = 30 * time.Second
View Source 
var DisableKubernetes = func(config api.Config) api.Config {
	config.DisableKubernetes = true
	return config
}
View Source 
var DisablePostgrest = func(config api.Config) api.Config {
	config.Postgrest.Disable = true
	return config
}
View Source 
var DisableRLS = func(config api.Config) api.Config {
	config.DisableRLS = true
	return config
}
View Source 
var EnableMetrics = func(config api.Config) api.Config {
	config.Metrics = true
	return config
}
View Source 
var EnableRLS = func(config api.Config) api.Config {
	config.EnableRLS = true
	return config
}
View Source 
var KratosAuth = func(config api.Config) api.Config {
	config.KratosAuth = true
	return config
}
View Source 
var LocalFilter = "deleted_at is NULL AND agent_id = '00000000-0000-0000-0000-000000000000' OR agent_id IS NULL"
View Source 
var LogLevel string

LogLevel is the log level for gorm logger

View Source 
var RunMigrations = func(config api.Config) api.Config {
	config.MigrationMode = api.SkipByDefault
	config.RunMigrations = true
	return config
}
View Source 
var SkipChangelogMigration = func(config api.Config) api.Config {
	config.SkipMigrationFiles = []string{"007_events.sql", "012_changelog_triggers_others.sql", "012_changelog_triggers_scrapers.sql"}
	return config
}
View Source 
var SkipMigrationByDefaultMode = func(config api.Config) api.Config {
	config.MigrationMode = api.SkipByDefault
	return config
}
View Source 
var SkipMigrations = func(config api.Config) api.Config {
	config.MigrationMode = api.RunByDefault
	config.RunMigrations = false
	return config
}
View Source 
var WithUrl = func(url string) func(config api.Config) api.Config {
	return func(config api.Config) api.Config {
		config.ConnectionString = url
		return config
	}
}

Functions

func ApplySessionProperties added in v1.0.1260 

func ApplySessionProperties(ctx dutyContext.Context, tx *gorm.DB) error

ApplySessionProperties runs `SET LOCAL <key> = '<value>'` inside the supplied GORM transaction for every property in `ctx.Properties()` whose key starts with SessionPropertyPrefix. The prefix is stripped before the SET is issued. Values are passed as text; Postgres will coerce them as needed by the GUC's type.

The transaction MUST be an open tx (returned by `db.Begin()` or `db.WithContext(...).Begin()`); `SET LOCAL` outside a tx has no effect.

Typical usage: 

tx := ctx.DB().Begin()
if err := duty.ApplySessionProperties(ctx, tx); err != nil { ... }
defer tx.Rollback() // or commit
...

func BindGoFlags added in v1.0.310 

func BindGoFlags()

func BindPFlags added in v1.0.564 

func BindPFlags(flags *pflag.FlagSet, opts ...StartOption)

func CheckSummary added in v1.0.164 

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

deprecated use query.CheckSummaryByID

func DefaultGormConfig added in v1.0.6 

func DefaultGormConfig() *gorm.Config

func Delete added in v1.0.253 

func Delete(ctx dutyContext.Context, model Table) error

func FreePort added in v1.0.580 

func FreePort() int

func GetComponent added in v1.0.45 

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

deprecated use query.GetComponent

func GetResourceContext added in v1.0.829 

func GetResourceContext(ctx context.Context, resource types.ResourceSelectable) map[string]any

GetResourceContext returns a common set of variables to be used in templates and expressions

func HasMigrationsRun added in v1.0.447 

func HasMigrationsRun(ctx dutyContext.Context) (bool, error)

HasMigrationsRun performs a rudimentary check to see if the migrations have run at least once.

func InitDB added in v1.0.207 

func InitDB(config api.Config) (*dutyContext.Context, error)

func LookupComponents added in v1.0.236 

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

func LookupConfigs added in v1.0.236 

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

func Migrate added in v1.0.10 

func Migrate(config api.Config) 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 NewGormFromPool added in v1.0.1260 

func NewGormFromPool(pool *pgxpool.Pool, config *gorm.Config) (*gorm.DB, error)

NewGormFromPool creates a Gorm DB that reuses an existing *pgxpool.Pool. This is the preferred path for the main application: it shares the same connection pool (and therefore the ConnConfig.OnNotice handler, pgx Tracer, and MaxConns) with any direct pgxpool users on the same context.

In particular, without sharing the pool, RAISE NOTICE / RAISE WARNING messages emitted by server-side functions are invisible to Go callers using ctx.DB() (GORM) because the stdlib driver creates its own pgx config with no notice handler.

stdlib.OpenDBFromPool automatically sets db.SetMaxIdleConns(0), so GORM will not hoard connections from the pool.

func NewPgxPool 

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

func Now added in v1.0.253 

func Now() clause.Expr

func SetupDB added in v1.0.141 

func SetupDB(config api.Config) (gormDB *gorm.DB, pgxpool *pgxpool.Pool, err error)

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

func Start added in v1.0.564 

func Start(name string, opts ...StartOption) (context.Context, func(), error)

Types

type FindOption added in v1.0.253 

type FindOption func(db *gorm.DB)

func PickColumns added in v1.0.253 

func PickColumns(columns ...string) FindOption

func WhereClause added in v1.0.287 

func WhereClause(query any, args ...any) FindOption

type Lookup added in v1.0.236 

type Lookup struct {
	Expr  string `json:"expr,omitempty"`
	Value string `json:"value,omitempty"`
	Label string `json:"label,omitempty"`
}

Lookup offers different ways to specify a lookup value

+kubebuilder:object:generate=true

func (*Lookup) DeepCopy added in v1.0.532 

func (in *Lookup) DeepCopy() *Lookup

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Lookup.

func (*Lookup) DeepCopyInto added in v1.0.532 

func (in *Lookup) DeepCopyInto(out *Lookup)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Lookup) Eval added in v1.0.236 

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

func (Lookup) IsEmpty added in v1.0.532 

func (t Lookup) IsEmpty() bool

type RelationshipSelector added in v1.0.532 

type RelationshipSelector struct {
	ID         string            `json:"id,omitempty"`
	ExternalID string            `json:"external_id,omitempty"`
	Name       string            `json:"name,omitempty"`
	Namespace  string            `json:"namespace,omitempty"`
	Type       string            `json:"type,omitempty"`
	Agent      string            `json:"agent,omitempty"`
	Labels     map[string]string `json:"labels,omitempty"`

	// Scope is the id parent of the resource to select.
	// Example: For config items, the scope is the scraper id
	// - for checks, it's canaries and
	// - for components, it's topology.
	Scope string `json:"scope,omitempty"`
}

+kubebuilder:object:generate=true RelationshipSelector is the evaluated output of RelationshipSelectorTemplate.

func (*RelationshipSelector) DeepCopy added in v1.0.532 

func (in *RelationshipSelector) DeepCopy() *RelationshipSelector

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RelationshipSelector.

func (*RelationshipSelector) DeepCopyInto added in v1.0.532 

func (in *RelationshipSelector) DeepCopyInto(out *RelationshipSelector)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RelationshipSelector) IsEmpty added in v1.0.532 

func (t *RelationshipSelector) IsEmpty() bool

func (*RelationshipSelector) ToResourceSelector added in v1.0.532 

func (t *RelationshipSelector) ToResourceSelector() types.ResourceSelector

type RelationshipSelectorTemplate added in v1.0.532 

type RelationshipSelectorTemplate struct {
	ID         Lookup `json:"id,omitempty"`
	ExternalID Lookup `json:"external_id,omitempty"`
	Name       Lookup `json:"name,omitempty"`
	Namespace  Lookup `json:"namespace,omitempty"`
	Type       Lookup `json:"type,omitempty"`

	// Agent can be one of
	//  - agent id
	//  - agent name
	//  - 'self' (no agent)
	Agent Lookup `json:"agent,omitempty"`

	// Scope is the id of the parent of the resource to select.
	// Example: For config items, the scope is the scraper id
	// - for checks, it's canaries and
	// - for components, it's topology.
	// If left empty, the scope is the requester's scope.
	// Use `all` to disregard scope.
	Scope Lookup `json:"scope,omitempty"`

	Labels map[string]string `json:"labels,omitempty"`
}

+kubebuilder:object:generate=true

func (*RelationshipSelectorTemplate) DeepCopy added in v1.0.532 

func (in *RelationshipSelectorTemplate) DeepCopy() *RelationshipSelectorTemplate

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RelationshipSelectorTemplate.

func (*RelationshipSelectorTemplate) DeepCopyInto added in v1.0.532 

func (in *RelationshipSelectorTemplate) DeepCopyInto(out *RelationshipSelectorTemplate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RelationshipSelectorTemplate) Eval added in v1.0.532 

func (t *RelationshipSelectorTemplate) Eval(labels map[string]string, env map[string]any) (*RelationshipSelector, error)

Eval evaluates the template and returns a RelationshipSelector. If any of the filter returns an empty value, the evaluation results to a nil selector. i.e. if a lookup is non-empty, it must return a non-empty value.

func (*RelationshipSelectorTemplate) IsEmpty added in v1.0.532 

func (t *RelationshipSelectorTemplate) IsEmpty() bool

type StartOption added in v1.0.564 

type StartOption func(config api.Config) api.Config

type Table added in v1.0.253 

type Table interface {
	TableName() string
}

type TopologyOptions added in v1.0.11 

type TopologyOptions = query.TopologyOptions

type TopologyResponse added in v1.0.71 

type TopologyResponse = query.TopologyResponse

func QueryTopology added in v1.0.24 

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

deprecated use query.Topology

Source Files

View all Source files

Directories

Path Synopsis
clients/aws
clients/azure
clients/gcp
clients/sftp
clients/smb
fs
hack
generate-schemas command
migrate command
azureloganalytics
ABOUTME: Implements log searching against Azure Monitor Log Analytics workspaces.
 ABOUTME: Implements log searching against Azure Monitor Log Analytics workspaces.
bigquery
cloudwatch
gcpcloudlogging
k8s
loki
opensearch
pkg
kube/auth
Referenced from: https://github.com/kubernetes/client-go/blob/master/plugin/pkg/client/auth/exec/exec.go
 Referenced from: https://github.com/kubernetes/client-go/blob/master/plugin/pkg/client/auth/exec/exec.go
kube/labels
Package labels implements a simple label system, parsing and matching selectors with sets of labels.
 Package labels implements a simple label system, parsing and matching selectors with sets of labels.
tokenizer
pg
grammar
policy
openapi
e2e-blobs
fixtures/dummy
generator
matcher
setup

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.