cluster

Documentation

Index

• Variables
• type Cluster
  • func New(l log.Logger, reg prometheus.Registerer, cfg Config, im instance.Manager, ...) (*Cluster, error)
  • func (c *Cluster) ApplyConfig(cfg Config) error
  • func (c *Cluster) Reshard(ctx context.Context, _ *agentproto.ReshardRequest) (*empty.Empty, error)
  • func (c *Cluster) Stop()
  • func (c *Cluster) WireAPI(r *mux.Router)
  • func (c *Cluster) WireGRPC(srv *grpc.Server)
• type Config
  • func (c *Config) RegisterFlags(f *flag.FlagSet)
  • func (c *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type OwnershipFunc
• type ValidationFunc

Variables

var DefaultConfig = *flagutil.DefaultConfigFromFlags(&Config{}).(*Config)

DefaultConfig provides default values for the config

Types

type Cluster

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

Cluster connects an Agent to other Agents and allows them to distribute workload.

func New

func New(
	l log.Logger,
	reg prometheus.Registerer,
	cfg Config,
	im instance.Manager,
	validate ValidationFunc,
) (*Cluster, error)

New creates a new Cluster.

func (*Cluster) ApplyConfig

func (c *Cluster) ApplyConfig(cfg Config) error

ApplyConfig applies configuration changes to Cluster.

func (*Cluster) Reshard

func (c *Cluster) Reshard(ctx context.Context, _ *agentproto.ReshardRequest) (*empty.Empty, error)

Reshard implements agentproto.ScrapingServiceServer, and syncs the state of configs with the configstore.

func (*Cluster) Stop

func (c *Cluster) Stop()

Stop stops the cluster and all of its dependencies.

func (*Cluster) WireAPI

func (c *Cluster) WireAPI(r *mux.Router)

WireAPI injects routes into the provided mux router for the config management API.

func (*Cluster) WireGRPC

func (c *Cluster) WireGRPC(srv *grpc.Server)

WireGRPC injects gRPC server handlers into the provided gRPC server.

type Config

type Config struct {
	Enabled                    bool                  `yaml:"enabled"`
	ReshardInterval            time.Duration         `yaml:"reshard_interval"`
	ReshardTimeout             time.Duration         `yaml:"reshard_timeout"`
	ClusterReshardEventTimeout time.Duration         `yaml:"cluster_reshard_event_timeout"`
	KVStore                    kv.Config             `yaml:"kvstore"`
	Lifecycler                 ring.LifecyclerConfig `yaml:"lifecycler"`

	DangerousAllowReadingFiles bool `yaml:"dangerous_allow_reading_files"`

	// TODO(rfratto): deprecate scraping_service_client in Agent and replace with this.
	Client                    client.Config `yaml:"-"`
	APIEnableGetConfiguration bool          `yaml:"-"`
}

Config describes how to instantiate a scraping service Server instance.

func (*Config) RegisterFlags

func (c *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags adds the flags required to config the Server to the given FlagSet.

func (*Config) RegisterFlagsWithPrefix

func (c *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix adds the flags required to config this to the given FlagSet with a specified prefix.

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.

type OwnershipFunc

type OwnershipFunc = func(key string) (bool, error)

OwnershipFunc should determine if a given keep is owned by the caller.

type ValidationFunc

type ValidationFunc = func(*instance.Config) error

ValidationFunc should validate a config.