quota

README

Определение квоты по памяти и цпу.

Компонент автоматически определяет квоты на использование цпу и памяти и передает это значение в runtime GoLang.

Объект конфигурации.

type Config struct {
	MemoryLimitHumanReadable     string
	MemoryLimit                  uint64
	CpuSecondsLimitHumanReadable string
	CpuSecondsLimit              uint32
}

Описание полей:

Поле	Описание	Значение по умолчанию
MemoryLimitHumanReadable	Человеко читаемое значение квоты памяти, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --quota.memory - переменная окружения GOMEMLIMIT - значение в конфиг файле quota.memory
MemoryLimit	Значение квоты памяти в байтах, если пустое, в это поле будет распарсино значение из поля MemoryLimitHumanReadable, это поле может быть установлено только в коде на этапе конфигурирования приложения
CpuSecondsLimitHumanReadable	Человеко читаемое значение квоты использования цпу в значениях процессорного времени, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --quota.cpu - переменная окружения GOMAXPROC - значение в конфиг файле quota.cpu
CpuSecondsLimit	Значение квоты использования цпу в значениях процессорного времени, если пустое, в это поле будет распарсино значение из поля CpuSecondsLimitHumanReadable, это поле может быть установлено только в коде на этапе конфигурирования приложения

Важно. Если все параметры пустые или не установлены, компонент предпринимает попытку автоматического получение квот от ОС:

• Linux - пакет будет парсить конфиги CGroup для получения квот, если в cgroup квоты не будут установлены, пакет запросит информацию у ОС о максимальном кол. памяти и цпу и будет использовать эти значения в качестве квоты;
• Остальные ОС, компонент будет полагаться на runtime GoLang.

Пакет предоставляет следующие метрики:

• go_memory_limit_bytes - метрика с лимитом занятой памяти
• go_cpu_limit_seconds - метрика с лимитом по цпу

Documentation

Index

• Constants
• Variables
• type Config
  • func Configuration(config *Config, configurator configurator.Configurator) (*Config, error)
  • func NewConfig() *Config
• type GetQuotas
• type Metric
  • func NewMetric(appConfig *app.Config) *Metric
• type Quota
  • func New(config *Config, appConfig *app.Config, getQuotas GetQuotas, metric *Metric, ...) Quota
  • func NewWithConfigurator(config *Config, configurator configurator.Configurator, appConfig *app.Config, ...) (Quota, error)
• type ReConfiguration
  • func NewReConfiguration(appConfig *app.Config, logger logger.Logger, config *Config, metric *Metric) *ReConfiguration
  • func NewReConfigurationWithConfigurator(config *Config, configurator configurator.Configurator, appConfig *app.Config, ...) (*ReConfiguration, error)
  • func (reConfiguration *ReConfiguration) Memory() uint64
  • func (reConfiguration *ReConfiguration) Process(ctx context.Context) error
  • func (reConfiguration *ReConfiguration) Processes() uint8
  • func (reConfiguration *ReConfiguration) Quota() Quota
  • func (reConfiguration *ReConfiguration) ReConfiguration(configurator configurator.Configurator) error

Constants

const (
	MemoryLimitEnvFieldName  = "GOMEMLIMIT"
	ProcessLimitEnvFieldName = "GOMAXPROC"

	MemoryLimitHumanReadableFieldName     = "quota.memory.limit"
	CpuSecondsLimitHumanReadableFieldName = "quota.cpu.limit"

	DelayFieldName = "quota.delay"

	DelayDefault = 5 * time.Minute
)

Variables

var (
	MemoryLimitHumanReadableDefault = os.Getenv(MemoryLimitEnvFieldName)
	CpuSecondsLimitHumanReadable    = os.Getenv(ProcessLimitEnvFieldName)
)

var Component = &app.Component{
	Dependencies: app.Components{
		logger.Component,
		configurator.Component,
		reConfiguration.Component,
		repeater.Component,
	},
	Constructor: app.Constructor(func(container container.Container) error {
		return container.Provides(
			NewMetric,
			NewConfig,
			NewReConfigurationWithConfigurator,
			func(reConfiguration *ReConfiguration) Quota {
				return reConfiguration
			},
		)
	}),
	BindFlags: app.BindFlags(func(flagSet *pflag.FlagSet, container container.Container) error {
		return container.Invoke(func(config *Config) {
			flagSet.StringVar(&config.MemoryLimitHumanReadable, MemoryLimitHumanReadableFieldName, MemoryLimitHumanReadableDefault, "memory limit")
			flagSet.StringVar(&config.CpuSecondsLimitHumanReadable, CpuSecondsLimitHumanReadableFieldName, CpuSecondsLimitHumanReadable, "cpu limit")
			flagSet.DurationVar(&config.Delay, DelayFieldName, DelayDefault, "quota update interval")
		})
	}),
	Run: app.Run(func(container container.Container) error {
		return container.Invoke(func(
			logger logger.Logger,
			quota *ReConfiguration,
			reConfiguration reConfiguration.ReConfiguration,
			config *Config,
			configurator configurator.Configurator,
			r repeater.Repeater,
			closer closer.Closer,
		) error {
			reConfiguration.Registration(quota)
			logger.Info("quota: registration in the reConfigurator")

			r.AddProcess("quota", config.Delay, quota.Process)

			return nil
		})
	}),
}

Types

type Config

type Config struct {
	MemoryLimitHumanReadable     string
	MemoryLimit                  uint64
	CpuSecondsLimitHumanReadable string
	CpuSecondsLimit              uint32
	Delay                        time.Duration
}

func Configuration

func Configuration(config *Config, configurator configurator.Configurator) (*Config, error)

func NewConfig

func NewConfig() *Config

type GetQuotas

type GetQuotas func(appConfig *app.Config, logger logger.Logger) (uint64, uint32, error)

type Metric

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

func NewMetric

func NewMetric(appConfig *app.Config) *Metric

type Quota

type Quota interface {
	repeater.Process

	Memory() uint64
	Processes() uint8
}

func New

func New(config *Config, appConfig *app.Config, getQuotas GetQuotas, metric *Metric, logger logger.Logger) Quota

func NewWithConfigurator

func NewWithConfigurator(config *Config, configurator configurator.Configurator, appConfig *app.Config, metric *Metric, logger logger.Logger) (Quota, error)

type ReConfiguration

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

func NewReConfiguration

func NewReConfiguration(appConfig *app.Config, logger logger.Logger, config *Config, metric *Metric) *ReConfiguration

func NewReConfigurationWithConfigurator

func NewReConfigurationWithConfigurator(config *Config, configurator configurator.Configurator, appConfig *app.Config, logger logger.Logger, metric *Metric) (*ReConfiguration, error)

func (*ReConfiguration) Memory

func (reConfiguration *ReConfiguration) Memory() uint64

func (*ReConfiguration) Process

func (reConfiguration *ReConfiguration) Process(ctx context.Context) error

func (*ReConfiguration) Processes

func (reConfiguration *ReConfiguration) Processes() uint8

func (*ReConfiguration) Quota

func (reConfiguration *ReConfiguration) Quota() Quota

func (*ReConfiguration) ReConfiguration

func (reConfiguration *ReConfiguration) ReConfiguration(configurator configurator.Configurator) error