Distributor

target: distributor

#auth_enabled: false

distributor:
  pool:
    client_cleanup_period: 15s
    health_check_ingesters: true
  ha_tracker:
    enable_ha_tracker: false
    ha_tracker_update_timeout: 15s
    ha_tracker_update_timeout_jitter_max: 5s
    ha_tracker_failover_timeout: 30s
    kvstore:
      store: etcd
      prefix: ha-tracker/
      etcd:
        endpoints: []
        dial_timeout: 10s
        max_retries: 10
        tls_enabled: false
        tls_cert_path: ""
        tls_key_path: ""
        tls_ca_path: ""
        tls_server_name: ""
        tls_insecure_skip_verify: false
        username: ""
        password: ""
  max_recv_msg_size: 104857600
  remote_timeout: 2s
  extra_queue_delay: 0s
  sharding_strategy: default
  shard_by_all_labels: true
  extend_writes: true
  ring:
    kvstore:
      store: etcd
      prefix: collectors/
      etcd:
        endpoints: []
        dial_timeout: 10s
        max_retries: 10
        tls_enabled: false
        tls_cert_path: ""
        tls_key_path: ""
        tls_ca_path: ""
        tls_server_name: ""
        tls_insecure_skip_verify: false
        username: ""
        password: ""
    heartbeat_period: 5s
    heartbeat_timeout: 1m0s
    instance_id: limiqi-mac2016-01.local
    instance_interface_names:
    - eth0
    - en0
    instance_port: 0
    instance_addr: ""
  instance_limits:
    max_ingestion_rate: 0
    max_inflight_push_requests: 0

POST /api/v1/push

X-Prometheus-Remote-Write-Version: 0.1.0

<snappy <protoc buffer> >

GET /distributor/ring

GET /distributor/all_user_stats

GET /distributor/ha_tracker

// Config contains the configuration required to
// create a Distributor
type Config struct {
    PoolConfig PoolConfig `yaml:"pool"`

    HATrackerConfig HATrackerConfig `yaml:"ha_tracker"`

    MaxRecvMsgSize  int           `yaml:"max_recv_msg_size"`
    RemoteTimeout   time.Duration `yaml:"remote_timeout"`
    ExtraQueryDelay time.Duration `yaml:"extra_queue_delay"`

    ShardingStrategy string `yaml:"sharding_strategy"`
    ShardByAllLabels bool   `yaml:"shard_by_all_labels"`
    ExtendWrites     bool   `yaml:"extend_writes"`

    // Distributors ring
    DistributorRing RingConfig `yaml:"ring"`

    // for testing and for extending the ingester by adding calls to the client
    IngesterClientFactory ring_client.PoolFactory `yaml:"-"`

    // when true the distributor does not validate the label name, Cortex doesn't directly use
    // this (and should never use it) but this feature is used by other projects built on top of it
    SkipLabelNameValidation bool `yaml:"-"`

    // This config is dynamically injected because defined in the querier config.
    ShuffleShardingLookbackPeriod time.Duration `yaml:"-"`

    // Limits for distributor
    InstanceLimits InstanceLimits `yaml:"instance_limits"`
}

// PoolConfig is config for creating a Pool.
type PoolConfig struct {
    ClientCleanupPeriod  time.Duration `yaml:"client_cleanup_period"`
    HealthCheckIngesters bool          `yaml:"health_check_ingesters"`
    RemoteTimeout        time.Duration `yaml:"-"`
}

// HATrackerConfig contains the configuration require to
// create a HA Tracker.
type HATrackerConfig struct {
    EnableHATracker bool `yaml:"enable_ha_tracker"`
    // We should only update the timestamp if the difference
    // between the stored timestamp and the time we received a sample at
    // is more than this duration.
    UpdateTimeout          time.Duration `yaml:"ha_tracker_update_timeout"`
    UpdateTimeoutJitterMax time.Duration `yaml:"ha_tracker_update_timeout_jitter_max"`
    // We should only failover to accepting samples from a replica
    // other than the replica written in the KVStore if the difference
    // between the stored timestamp and the time we received a sample is
    // more than this duration
    FailoverTimeout time.Duration `yaml:"ha_tracker_failover_timeout"`

    KVStore kv.Config `yaml:"kvstore" doc:"description=Backend storage to use for the ring. Please be aware that memberlist is not supported by the HA tracker since gossip propagation is too slow for HA purposes."`
}

// Config is config for a KVStore currently used by ring and HA tracker,
// where store can be consul or inmemory.
type Config struct {
    Store       string `yaml:"store"`
    Prefix      string `yaml:"prefix"`
    StoreConfig `yaml:",inline"`

    Mock Client `yaml:"-"`
}

// StoreConfig is a configuration used for building single store client, either
// Consul, Etcd, Memberlist or MultiClient. It was extracted from Config to keep
// single-client config separate from final client-config (with all the wrappers)
type StoreConfig struct {
    DynamoDB dynamodb.Config `yaml:"dynamodb"`
    Consul   consul.Config   `yaml:"consul"`
    Etcd     etcd.Config     `yaml:"etcd"`
    Multi    MultiConfig     `yaml:"multi"`

    // Function that returns memberlist.KV store to use. By using a function, we can delay
    // initialization of memberlist.KV until it is actually required.
    MemberlistKV func() (*memberlist.KV, error) `yaml:"-"`
}

// Config for a new etcd.Client.
type Config struct {
    Endpoints   []string               `yaml:"endpoints"`
    DialTimeout time.Duration          `yaml:"dial_timeout"`
    MaxRetries  int                    `yaml:"max_retries"`
    EnableTLS   bool                   `yaml:"tls_enabled"`
    TLS         cortextls.ClientConfig `yaml:",inline"`

    UserName string `yaml:"username"`
    Password string `yaml:"password"`
}

// RingConfig masks the ring lifecycler config which contains
// many options not really required by the distributors ring. This config
// is used to strip down the config to the minimum, and avoid confusion
// to the user.
type RingConfig struct {
    KVStore          kv.Config     `yaml:"kvstore"`
    HeartbeatPeriod  time.Duration `yaml:"heartbeat_period"`
    HeartbeatTimeout time.Duration `yaml:"heartbeat_timeout"`

    // Instance details
    InstanceID             string   `yaml:"instance_id" doc:"hidden"`
    InstanceInterfaceNames []string `yaml:"instance_interface_names"`
    InstancePort           int      `yaml:"instance_port" doc:"hidden"`
    InstanceAddr           string   `yaml:"instance_addr" doc:"hidden"`

    // Injected internally
    ListenPort int `yaml:"-"`
}

type InstanceLimits struct {
    MaxIngestionRate        float64 `yaml:"max_ingestion_rate"`
    MaxInflightPushRequests int     `yaml:"max_inflight_push_requests"`
}

// KVConfig is a config for memberlist.KV
type KVConfig struct {
    // Memberlist options.
    NodeName            string        `yaml:"node_name"`
    RandomizeNodeName   bool          `yaml:"randomize_node_name"`
    StreamTimeout       time.Duration `yaml:"stream_timeout"`
    RetransmitMult      int           `yaml:"retransmit_factor"`
    PushPullInterval    time.Duration `yaml:"pull_push_interval"`
    GossipInterval      time.Duration `yaml:"gossip_interval"`
    GossipNodes         int           `yaml:"gossip_nodes"`
    GossipToTheDeadTime time.Duration `yaml:"gossip_to_dead_nodes_time"`
    DeadNodeReclaimTime time.Duration `yaml:"dead_node_reclaim_time"`
    EnableCompression   bool          `yaml:"compression_enabled"`

    // ip:port to advertise other cluster members. Used for NAT traversal
    AdvertiseAddr string `yaml:"advertise_addr"`
    AdvertisePort int    `yaml:"advertise_port"`

    // List of members to join
    JoinMembers      flagext.StringSlice `yaml:"join_members"`
    MinJoinBackoff   time.Duration       `yaml:"min_join_backoff"`
    MaxJoinBackoff   time.Duration       `yaml:"max_join_backoff"`
    MaxJoinRetries   int                 `yaml:"max_join_retries"`
    AbortIfJoinFails bool                `yaml:"abort_if_cluster_join_fails"`
    RejoinInterval   time.Duration       `yaml:"rejoin_interval"`

    // Remove LEFT ingesters from ring after this timeout.
    LeftIngestersTimeout time.Duration `yaml:"left_ingesters_timeout"`

    // Timeout used when leaving the memberlist cluster.
    LeaveTimeout time.Duration `yaml:"leave_timeout"`

    // How much space to use to keep received and sent messages in memory (for troubleshooting).
    MessageHistoryBufferBytes int `yaml:"message_history_buffer_bytes"`

    TCPTransport TCPTransportConfig `yaml:",inline"`

    // Where to put custom metrics. Metrics are not registered, if this is nil.
    MetricsRegisterer prometheus.Registerer `yaml:"-"`
    MetricsNamespace  string                `yaml:"-"`

    // Codecs to register. Codecs need to be registered before joining other members.
    Codecs []codec.Codec `yaml:"-"`
}