checks

Documentation

Overview

Package checks provides security checks functionality.

Index

• func GetAdditionalContext() map[string]starlark.GoFunc
• func GetFuncsForVersion(version uint32) (map[string]starlark.GoFunc, error)
• type Service
  • func New(agentsRegistry agentsRegistry, alertmanagerService alertmanagerService, ...) (*Service, error)
  • func (s *Service) Collect(ch chan<- prom.Metric)
  • func (s *Service) Describe(ch chan<- *prom.Desc)
  • func (s *Service) DisableChecks(checkNames []string) error
  • func (s *Service) EnableChecks(checkNames []string) error
  • func (s *Service) GetAllChecks() []check.Check
  • func (s *Service) GetDisabledChecks() ([]string, error)
  • func (s *Service) GetSecurityCheckResults() ([]check.Result, error)
  • func (s *Service) Run(ctx context.Context)
  • func (s *Service) StartChecks(ctx context.Context) error
• type StarlarkScriptData

Functions

func GetAdditionalContext

func GetAdditionalContext() map[string]starlark.GoFunc

GetAdditionalContext returns additional functions to be used in check scripts.

func GetFuncsForVersion

func GetFuncsForVersion(version uint32) (map[string]starlark.GoFunc, error)

GetFuncsForVersion returns predefined functions for specified check version.

Types

type Service

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

Service is responsible for interactions with Percona Check service.

func New

func New(agentsRegistry agentsRegistry, alertmanagerService alertmanagerService, db *reform.DB) (*Service, error)

New returns Service with given PMM version.

func (*Service) Collect

func (s *Service) Collect(ch chan<- prom.Metric)

Collect implements prom.Collector.

func (*Service) Describe

func (s *Service) Describe(ch chan<- *prom.Desc)

Describe implements prom.Collector.

func (*Service) DisableChecks

func (s *Service) DisableChecks(checkNames []string) error

DisableChecks disables checks with provided names.

func (*Service) EnableChecks

func (s *Service) EnableChecks(checkNames []string) error

EnableChecks enables checks with provided names.

func (*Service) GetAllChecks

func (s *Service) GetAllChecks() []check.Check

GetAllChecks returns all available checks.

func (*Service) GetDisabledChecks

func (s *Service) GetDisabledChecks() ([]string, error)

GetDisabledChecks returns disabled checks.

func (*Service) GetSecurityCheckResults

func (s *Service) GetSecurityCheckResults() ([]check.Result, error)

GetSecurityCheckResults returns the results of the STT checks that were run. It returns services.ErrSTTDisabled if STT is disabled.

func (*Service) Run

func (s *Service) Run(ctx context.Context)

Run runs main service loops.

func (*Service) StartChecks

func (s *Service) StartChecks(ctx context.Context) error

StartChecks triggers STT checks downloading and execution. It returns services.ErrSTTDisabled if STT is disabled.

type StarlarkScriptData

type StarlarkScriptData struct {
	Version     uint32 `json:"version"`
	Name        string `json:"name"`
	Script      string `json:"script"`
	QueryResult []byte `json:"query_result"`
}

StarlarkScriptData represents the data we need to pass to the binary to run starlark scripts.