db

package
v1.6.6 Latest Latest
Warning

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

 Go to latest Published: Dec 5, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AdminUserLogin           = "admin"
	AdminUserName            = "Admin"
	AdminUserDefaultPassword = ""
	AnonymousUserName        = "Anonymous"
)
View Source 
const (
	DefaultRefreshInterval = 30
)
View Source 
const (
	DeploymentsLastN = 100
)

Variables

View Source 
var (
	ErrNotFound = errors.New("not found")
	ErrConflict = errors.New("conflict")
	ErrInvalid  = errors.New("invalid")
)

Functions

This section is empty.

Types

type ApplicationCategorySettings 

type ApplicationCategorySettings struct {
	NotifyOfDeployments bool `json:"notify_of_deployments"`
}

type ApplicationDeployment 

type ApplicationDeployment model.ApplicationDeployment

func (*ApplicationDeployment) Migrate 

func (ad *ApplicationDeployment) Migrate(m *Migrator) error

type ApplicationSettings 

type ApplicationSettings struct{}

func (*ApplicationSettings) Migrate 

func (s *ApplicationSettings) Migrate(m *Migrator) error

type CheckConfigs 

type CheckConfigs struct{}

func (*CheckConfigs) Migrate 

func (cc *CheckConfigs) Migrate(m *Migrator) error

type DB 

type DB struct {
	// contains filtered or unexported fields
}

func Open 

func Open(dataDir string, pgConnString string) (*DB, error)

func (*DB) AddUser added in v1.5.0 

func (db *DB) AddUser(email, password, name string, role rbac.RoleName) error

func (*DB) AuthUser added in v1.5.0 

func (db *DB) AuthUser(email, password string) (int, error)

func (*DB) BootstrapClickhouseIntegration added in v1.5.0 

func (db *DB) BootstrapClickhouseIntegration(p *Project, addr, user, password, databaseName string) error

func (*DB) BootstrapPrometheusIntegration added in v1.5.0 

func (db *DB) BootstrapPrometheusIntegration(p *Project, url string, refreshInterval time.Duration, extraSelector string) error

func (*DB) ChangeUserPassword added in v1.5.0 

func (db *DB) ChangeUserPassword(id int, oldPassword, newPassword string) error

func (*DB) CreateAdminIfNotExists added in v1.5.0 

func (db *DB) CreateAdminIfNotExists(password string) error

func (*DB) CreateOrUpdateIncident 

func (db *DB) CreateOrUpdateIncident(projectId ProjectId, appId model.ApplicationId, now timeseries.Time, severity model.Status) (*model.ApplicationIncident, error)

func (*DB) DB 

func (db *DB) DB() *sql.DB

func (*DB) DefaultAdminUserIsTheOnlyUser added in v1.5.0 

func (db *DB) DefaultAdminUserIsTheOnlyUser() (*User, error)

func (*DB) DeleteProject 

func (db *DB) DeleteProject(id ProjectId) error

func (*DB) DeleteUser added in v1.5.0 

func (db *DB) DeleteUser(id int) error

func (*DB) GetApplicationDeployments 

func (db *DB) GetApplicationDeployments(projectId ProjectId) (map[model.ApplicationId][]*model.ApplicationDeployment, error)

func (*DB) GetApplicationIncidents 

func (db *DB) GetApplicationIncidents(projectId ProjectId, from, to timeseries.Time) (map[model.ApplicationId][]*model.ApplicationIncident, error)

func (*DB) GetApplicationSettings 

func (db *DB) GetApplicationSettings(projectId ProjectId, appId model.ApplicationId) (*model.ApplicationSettings, error)

func (*DB) GetApplicationSettingsByProject added in v1.3.0 

func (db *DB) GetApplicationSettingsByProject(projectId ProjectId) (map[model.ApplicationId]*model.ApplicationSettings, error)

func (*DB) GetCheckConfigs 

func (db *DB) GetCheckConfigs(projectId ProjectId) (model.CheckConfigs, error)

func (*DB) GetIncidentByKey 

func (db *DB) GetIncidentByKey(projectId ProjectId, key string) (*model.ApplicationIncident, error)

func (*DB) GetNotSentIncidentNotifications 

func (db *DB) GetNotSentIncidentNotifications(from timeseries.Time) ([]IncidentNotification, error)

func (*DB) GetOrCreateDefaultProject added in v1.6.2 

func (db *DB) GetOrCreateDefaultProject() (*Project, error)

func (*DB) GetPreviousIncidentNotifications 

func (db *DB) GetPreviousIncidentNotifications(n IncidentNotification) ([]IncidentNotification, error)

func (*DB) GetProject 

func (db *DB) GetProject(id ProjectId) (*Project, error)

func (*DB) GetProjectNames 

func (db *DB) GetProjectNames() (map[ProjectId]string, error)

func (*DB) GetProjects 

func (db *DB) GetProjects() ([]*Project, error)

func (*DB) GetSentIncidentNotificationsStat 

func (db *DB) GetSentIncidentNotificationsStat(from timeseries.Time) map[IntegrationType]int

func (*DB) GetSetting added in v1.5.0 

func (db *DB) GetSetting(name string, value any) error

func (*DB) GetUser added in v1.5.0 

func (db *DB) GetUser(id int) (*User, error)

func (*DB) GetUsers added in v1.5.0 

func (db *DB) GetUsers() ([]*User, error)

func (*DB) IsUniqueViolationError 

func (db *DB) IsUniqueViolationError(err error) bool

func (*DB) Migrate 

func (db *DB) Migrate(extraTables ...Table) error

func (*DB) Migrator added in v1.5.0 

func (db *DB) Migrator() *Migrator

func (*DB) PutIncidentNotification 

func (db *DB) PutIncidentNotification(n IncidentNotification)

func (*DB) SaveApplicationCategory 

func (db *DB) SaveApplicationCategory(id ProjectId, category, newName model.ApplicationCategory, customPatterns []string, notifyAboutDeployments bool) error

func (*DB) SaveApplicationDeployment 

func (db *DB) SaveApplicationDeployment(projectId ProjectId, d *model.ApplicationDeployment) error

func (*DB) SaveApplicationDeploymentMetricsSnapshot 

func (db *DB) SaveApplicationDeploymentMetricsSnapshot(projectId ProjectId, d *model.ApplicationDeployment) error

func (*DB) SaveApplicationDeploymentNotifications 

func (db *DB) SaveApplicationDeploymentNotifications(projectId ProjectId, d *model.ApplicationDeployment) error

func (*DB) SaveApplicationSetting 

func (db *DB) SaveApplicationSetting(projectId ProjectId, appId model.ApplicationId, s any) error

func (*DB) SaveCheckConfig 

func (db *DB) SaveCheckConfig(projectId ProjectId, appId model.ApplicationId, checkId model.CheckId, cfg any) error

func (*DB) SaveCustomApplication added in v1.4.0 

func (db *DB) SaveCustomApplication(id ProjectId, name, newName string, instancePatterns []string) error

func (*DB) SaveIntegrationsBaseUrl 

func (db *DB) SaveIntegrationsBaseUrl(id ProjectId, baseUrl string) error

func (*DB) SaveProject 

func (db *DB) SaveProject(p Project) (ProjectId, error)

func (*DB) SaveProjectIntegration 

func (db *DB) SaveProjectIntegration(p *Project, typ IntegrationType) error

func (*DB) SetAdminPassword added in v1.5.0 

func (db *DB) SetAdminPassword(password string) error

func (*DB) SetSetting added in v1.5.0 

func (db *DB) SetSetting(name string, value any) error

func (*DB) Type 

func (db *DB) Type() Type

func (*DB) UpdateIncidentNotification 

func (db *DB) UpdateIncidentNotification(n IncidentNotification) error

func (*DB) UpdateUser added in v1.5.0 

func (db *DB) UpdateUser(id int, email, password, name string, role rbac.RoleName) error

type Incident 

type Incident model.ApplicationIncident

func (*Incident) Migrate 

func (i *Incident) Migrate(m *Migrator) error

type IncidentNotification 

type IncidentNotification struct {
	ProjectId     ProjectId
	ApplicationId model.ApplicationId
	IncidentKey   string
	Status        model.Status
	Destination   IntegrationType
	Timestamp     timeseries.Time
	SentAt        timeseries.Time
	ExternalKey   string
	Details       *IncidentNotificationDetails
}

func (*IncidentNotification) Migrate 

func (n *IncidentNotification) Migrate(m *Migrator) error

type IncidentNotificationDetails 

type IncidentNotificationDetails struct {
	Reports []IncidentNotificationDetailsReport `json:"reports"`
}

type IncidentNotificationDetailsReport 

type IncidentNotificationDetailsReport struct {
	Name    model.AuditReportName `json:"name"`
	Check   string                `json:"check"`
	Message string                `json:"message"`
}

type IntegrationClickhouse 

type IntegrationClickhouse struct {
	Global          bool            `json:"global"`
	Protocol        string          `json:"protocol"`
	Addr            string          `json:"addr"`
	Auth            utils.BasicAuth `json:"auth"`
	Database        string          `json:"database"`
	InitialDatabase string          `json:"-"`
	TlsEnable       bool            `json:"tls_enable"`
	TlsSkipVerify   bool            `json:"tls_skip_verify"`
}

type IntegrationInfo 

type IntegrationInfo struct {
	Type        IntegrationType
	Configured  bool
	Incidents   bool
	Deployments bool
	Title       string
	Details     string
}

type IntegrationOpsgenie 

type IntegrationOpsgenie struct {
	ApiKey     string `json:"api_key"`
	EUInstance bool   `json:"eu_instance"`
	Incidents  bool   `json:"incidents"`
}

type IntegrationPagerduty 

type IntegrationPagerduty struct {
	IntegrationKey string `json:"integration_key"`
	Incidents      bool   `json:"incidents"`
}

type IntegrationSlack 

type IntegrationSlack struct {
	Token          string `json:"token"`
	DefaultChannel string `json:"default_channel"`
	Enabled        bool   `json:"enabled"` // deprecated: use Incidents and Deployments
	Incidents      bool   `json:"incidents"`
	Deployments    bool   `json:"deployments"`
}

type IntegrationTeams 

type IntegrationTeams struct {
	WebhookUrl  string `json:"webhook_url"`
	Incidents   bool   `json:"incidents"`
	Deployments bool   `json:"deployments"`
}

type IntegrationType 

type IntegrationType string
const (
	IntegrationTypePrometheus IntegrationType = "prometheus"
	IntegrationTypeClickhouse IntegrationType = "clickhouse"
	IntegrationTypeAWS        IntegrationType = "aws"
	IntegrationTypeSlack      IntegrationType = "slack"
	IntegrationTypePagerduty  IntegrationType = "pagerduty"
	IntegrationTypeTeams      IntegrationType = "teams"
	IntegrationTypeOpsgenie   IntegrationType = "opsgenie"
	IntegrationTypeWebhook    IntegrationType = "webhook"
)

type IntegrationWebhook added in v1.0.0 

type IntegrationWebhook struct {
	Url                string           `json:"url"`
	TlsSkipVerify      bool             `json:"tls_skip_verify"`
	BasicAuth          *utils.BasicAuth `json:"basic_auth"`
	CustomHeaders      []utils.Header   `json:"custom_headers"`
	Incidents          bool             `json:"incidents"`
	Deployments        bool             `json:"deployments"`
	IncidentTemplate   string           `json:"incident_template"`
	DeploymentTemplate string           `json:"deployment_template"`
}

type Integrations 

type Integrations struct {
	BaseUrl string `json:"base_url"`

	Slack     *IntegrationSlack     `json:"slack,omitempty"`
	Pagerduty *IntegrationPagerduty `json:"pagerduty,omitempty"`
	Teams     *IntegrationTeams     `json:"teams,omitempty"`
	Opsgenie  *IntegrationOpsgenie  `json:"opsgenie,omitempty"`
	Webhook   *IntegrationWebhook   `json:"webhook,omitempty"`

	Clickhouse *IntegrationClickhouse `json:"clickhouse,omitempty"`

	AWS *model.AWSConfig `json:"aws"`
}

func (Integrations) GetInfo 

func (integrations Integrations) GetInfo() []IntegrationInfo

type IntegrationsPrometheus 

type IntegrationsPrometheus struct {
	Global          bool                `json:"global"`
	Url             string              `json:"url"`
	RefreshInterval timeseries.Duration `json:"refresh_interval"`
	TlsSkipVerify   bool                `json:"tls_skip_verify"`
	BasicAuth       *utils.BasicAuth    `json:"basic_auth"`
	ExtraSelector   string              `json:"extra_selector"`
	CustomHeaders   []utils.Header      `json:"custom_headers"`
	ExtraLabels     map[string]string   `json:"-"`
}

type Migrator 

type Migrator struct {
	// contains filtered or unexported fields
}

func NewMigrator 

func NewMigrator(t Type, db *sql.DB) *Migrator

func (*Migrator) AddColumnIfNotExists 

func (m *Migrator) AddColumnIfNotExists(table, column, dataType string) error

func (*Migrator) Exec 

func (m *Migrator) Exec(query string, args ...any) error

func (*Migrator) Migrate 

func (m *Migrator) Migrate(tables ...Table) error

type Project 

type Project struct {
	Id   ProjectId
	Name string

	Prometheus IntegrationsPrometheus
	Settings   ProjectSettings
}

func (*Project) ClickHouseConfig added in v1.6.0 

func (p *Project) ClickHouseConfig(globalClickHouse *IntegrationClickhouse) *IntegrationClickhouse

func (*Project) GetCustomApplicationName added in v1.4.0 

func (p *Project) GetCustomApplicationName(instance string) string

func (*Project) Migrate 

func (p *Project) Migrate(m *Migrator) error

func (*Project) PrometheusConfig added in v1.6.0 

func (p *Project) PrometheusConfig(globalPrometheus *IntegrationsPrometheus) *IntegrationsPrometheus

type ProjectId 

type ProjectId string

type ProjectSettings added in v1.5.0 

type ProjectSettings struct {
	ApplicationCategories       map[model.ApplicationCategory][]string                    `json:"application_categories"`
	ApplicationCategorySettings map[model.ApplicationCategory]ApplicationCategorySettings `json:"application_category_settings"`
	Integrations                Integrations                                              `json:"integrations"`
	CustomApplications          map[string]model.CustomApplication                        `json:"custom_applications"`
}

type Setting added in v1.5.0 

type Setting struct {
	Name  string
	Value string
}

func (*Setting) Migrate added in v1.5.0 

func (s *Setting) Migrate(m *Migrator) error

type Table 

type Table interface {
	Migrate(m *Migrator) error
}

type Type 

type Type string
const (
	TypeSqlite   Type = "sqlite"
	TypePostgres Type = "postgres"
)

type User added in v1.5.0 

type User struct {
	Id        int
	Email     string
	Name      string
	Roles     []rbac.RoleName
	Anonymous bool
}

func AnonymousUser added in v1.5.0 

func AnonymousUser(role rbac.RoleName) *User

func (*User) Migrate added in v1.5.0 

func (u *User) Migrate(m *Migrator) error

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.