commands

Documentation

Index

• func LoadConfig(filename string, expandENV bool, cfg *cortex.Config) error
• func RegisterChunkCommands(app *kingpin.Application)
• type AccessControlCommand
  • func (a *AccessControlCommand) Register(app *kingpin.Application)
• type AlertCommand
  • func (a *AlertCommand) Register(app *kingpin.Application)
• type AlertmanagerCommand
  • func (a *AlertmanagerCommand) Register(app *kingpin.Application)
• type AnalyseCommand
  • func (cmd *AnalyseCommand) Register(app *kingpin.Application)
• type BlockGenCommand
  • func (f *BlockGenCommand) Register(app *kingpin.Application)
• type BlockGenConfig
• type BucketValidationCommand
  • func (b *BucketValidationCommand) Register(app *kingpin.Application)
• type DashboardAnalyseCommand
• type GrafanaAnalyseCommand
• type LoadgenCommand
  • func (c *LoadgenCommand) Register(app *kingpin.Application)
• type LoggerConfig
  • func (l *LoggerConfig) Register(app *kingpin.Application)
• type OverridesExporterCommand
  • func NewOverridesExporterCommand() *OverridesExporterCommand
  • func (o *OverridesExporterCommand) AllByUserID() map[string]*validation.Limits
  • func (o *OverridesExporterCommand) ByUserID(userID string) *validation.Limits
  • func (o *OverridesExporterCommand) Register(app *kingpin.Application)
• type PrometheusAnalyseCommand
• type PushGatewayConfig
  • func (l *PushGatewayConfig) Register(app *kingpin.Application)
  • func (l *PushGatewayConfig) Stop()
• type RemoteReadCommand
  • func (c *RemoteReadCommand) Register(app *kingpin.Application)
• type RuleCommand
  • func (r *RuleCommand) Register(app *kingpin.Application)
• type RuleFileAnalyseCommand
• type RulerAnalyseCommand
• type SchemaConfig
  • func (cfg *SchemaConfig) Load() error

Functions

func LoadConfig

func LoadConfig(filename string, expandENV bool, cfg *cortex.Config) error

LoadConfig read YAML-formatted config from filename into cfg.

func RegisterChunkCommands

func RegisterChunkCommands(app *kingpin.Application)

RegisterChunkCommands registers the ChunkCommand flags with the kingpin applicattion

Types

type AccessControlCommand

type AccessControlCommand struct {
	InstanceID string
	ACLs       []string
}

AccessControlCommand is the kingpin command for ACLs.

func (*AccessControlCommand) Register

func (a *AccessControlCommand) Register(app *kingpin.Application)

Register is used to register the command to a parent command.

type AlertCommand

type AlertCommand struct {
	CortexURL      string
	IgnoreString   string
	IgnoreAlerts   map[string]interface{}
	SourceLabel    string
	NumSources     int
	GracePeriod    int
	CheckFrequency int
	ClientConfig   client.Config
	// contains filtered or unexported fields
}

AlertCommand configures and executes rule related PromQL queries for alerts comparison.

func (*AlertCommand) Register

func (a *AlertCommand) Register(app *kingpin.Application)

type AlertmanagerCommand

type AlertmanagerCommand struct {
	ClientConfig           client.Config
	AlertmanagerURL        url.URL
	AlertmanagerConfigFile string
	TemplateFiles          []string
	DisableColor           bool
	// contains filtered or unexported fields
}

AlertmanagerCommand configures and executes rule related cortex api operations

func (*AlertmanagerCommand) Register

func (a *AlertmanagerCommand) Register(app *kingpin.Application)

Register rule related commands and flags with the kingpin application

type AnalyseCommand

type AnalyseCommand struct {
}

func (*AnalyseCommand) Register

func (cmd *AnalyseCommand) Register(app *kingpin.Application)

type BlockGenCommand

type BlockGenCommand struct {
	Replicas int                `yaml:"replicas"`
	Series   []bench.SeriesDesc `yaml:"series"`
	Cfg      BlockGenConfig     `yaml:"block_gen"`
	// contains filtered or unexported fields
}

BlockGenCommand is the kingpin command to generate blocks of mock data.

func (*BlockGenCommand) Register

func (f *BlockGenCommand) Register(app *kingpin.Application)

Register is used to register the command to a parent command.

type BlockGenConfig

type BlockGenConfig struct {
	Interval  time.Duration `yaml:"interval"`
	BlockSize time.Duration `yaml:"block_size"`
	BlockDir  string        `yaml:"block_dir"`
	MinT      int64         `yaml:"min_t"`
	MaxT      int64         `yaml:"max_t"`
}

type BucketValidationCommand

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

BucketValidationCommand is the kingpin command for bucket validation.

func (*BucketValidationCommand) Register

func (b *BucketValidationCommand) Register(app *kingpin.Application)

Register is used to register the command to a parent command.

type DashboardAnalyseCommand

type DashboardAnalyseCommand struct {
	DashFilesList []string
	// contains filtered or unexported fields
}

type GrafanaAnalyseCommand

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

type LoadgenCommand

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

func (*LoadgenCommand) Register

func (c *LoadgenCommand) Register(app *kingpin.Application)

type LoggerConfig

type LoggerConfig struct {
	Level string
}

func (*LoggerConfig) Register

func (l *LoggerConfig) Register(app *kingpin.Application)

Register configures log related flags

type OverridesExporterCommand

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

func NewOverridesExporterCommand

func NewOverridesExporterCommand() *OverridesExporterCommand

func (*OverridesExporterCommand) AllByUserID

func (o *OverridesExporterCommand) AllByUserID() map[string]*validation.Limits

AllByUserID implements validation.TenantLimits.

func (*OverridesExporterCommand) ByUserID

func (o *OverridesExporterCommand) ByUserID(userID string) *validation.Limits

ByUserID implements validation.TenantLimits.

func (*OverridesExporterCommand) Register

func (o *OverridesExporterCommand) Register(app *kingpin.Application)

type PrometheusAnalyseCommand

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

type PushGatewayConfig

type PushGatewayConfig struct {
	Endpoint *url.URL
	JobName  string
	Interval time.Duration
	// contains filtered or unexported fields
}

PushGatewayConfig configures the pushgateway

func (*PushGatewayConfig) Register

func (l *PushGatewayConfig) Register(app *kingpin.Application)

Register configures log related flags

func (*PushGatewayConfig) Stop

func (l *PushGatewayConfig) Stop()

Stop shutsdown the pushgateway

type RemoteReadCommand

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

func (*RemoteReadCommand) Register

func (c *RemoteReadCommand) Register(app *kingpin.Application)

type RuleCommand

type RuleCommand struct {
	ClientConfig client.Config

	// Get Rule Groups Configs
	Namespace string
	RuleGroup string

	// Load Rules Config
	RuleFilesList []string
	RuleFiles     string
	RuleFilesPath string

	// Sync/Diff Rules Config
	Namespaces string

	IgnoredNamespaces string

	// Prepare Rules Config
	InPlaceEdit                        bool
	AggregationLabel                   string
	AggregationLabelExcludedRuleGroups string

	// Lint Rules Config
	LintDryRun bool

	// Rules check flags
	Strict bool

	// List Rules Config
	Format string

	DisableColor bool

	// Diff Rules Config
	Verbose bool
	// contains filtered or unexported fields
}

RuleCommand configures and executes rule related cortex operations

func (*RuleCommand) Register

func (r *RuleCommand) Register(app *kingpin.Application)

Register rule related commands and flags with the kingpin application

type RuleFileAnalyseCommand

type RuleFileAnalyseCommand struct {
	RuleFilesList []string
	// contains filtered or unexported fields
}

type RulerAnalyseCommand

type RulerAnalyseCommand struct {
	ClientConfig client.Config
	// contains filtered or unexported fields
}

type SchemaConfig

type SchemaConfig struct {
	Configs  []*chunk.PeriodConfig `yaml:"configs"`
	FileName string
}

SchemaConfig contains the config for our chunk index schemas

func (*SchemaConfig) Load

func (cfg *SchemaConfig) Load() error

Load the yaml file, or build the config from legacy command-line flags