This doc is likely out of date. It should be updated for blocks storage.
You will want to estimate how many nodes are required, how many of each component to run, and how much storage space will be required. In practice, these will vary greatly depending on the metrics being sent to Cortex.
Some key parameters are:
- The number of active series. If you have Prometheus already you
prometheus_tsdb_head_seriesto see this number.
- Sampling rate, e.g. a new sample for each series every minute (the default Prometheus scrape_interval). Multiply this by the number of active series to get the total rate at which samples will arrive at Cortex.
- The rate at which series are added and removed. This can be very high if you monitor objects that come and go - for example if you run thousands of batch jobs lasting a minute or so and capture metrics with a unique ID for each one. Read how to analyse this on Prometheus.
- How compressible the time-series data are. If a metric stays at the same value constantly, then Cortex can compress it very well, so 12 hours of data sampled every 15 seconds would be around 2KB. On the other hand if the value jumps around a lot it might take 10KB. There are not currently any tools available to analyse this.
- How long you want to retain data for, e.g. 1 month or 2 years.
Other parameters which can become important if you have particularly high values:
- Number of different series under one metric name.
- Number of labels per series.
- Rate and complexity of queries.
Now, some rules of thumb:
- Each million series in an ingester takes 15GB of RAM. Total number
of series in ingesters is number of active series times the
replication factor. This is with the default of 12-hour chunks - RAM
required will reduce if you set
-ingester.max-chunk-agelower (trading off more back-end database IO). There are some additional considerations for planning for ingester memory usage.
- Memory increases during write ahead log (WAL) replay, See Prometheus issue #6934. If you do not have enough memory for WAL replay, the ingester will not be able to restart successfully without intervention.
- Memory temporarily increases during resharding since timeseries are temporarily on both the new and old ingesters. This means you should scale up the number of ingesters before memory utilization is too high, otherwise you will not have the headroom to account for the temporary increase.
- Each million series (including churn) consumes 15GB of chunk storage and 4GB of index, per day (so multiply by the retention period).
- The distributors CPU utilization depends on the specific Cortex cluster
setup, while they don’t need much RAM. Typically, distributors are capable
to process between 20,000 and 100,000 samples/sec with 1 CPU core. It’s also
highly recommended to configure Prometheus
max_samples_per_sendto 1,000 samples, in order to reduce the distributors CPU utilization given the same total samples/sec throughput.
If you turn on compression between distributors and ingesters (for example to save on inter-zone bandwidth charges at AWS/GCP) they will use significantly more CPU (approx 100% more for distributor and 50% more for ingester).