Skip to content

Commit 2f140e5

Browse files
authored
Recommend schema v9 and v10 for production (cortexproject#2896)
* Recommend schema v10 for production Signed-off-by: Marco Pracucci <marco@pracucci.com> * Updated recommended schema Signed-off-by: Marco Pracucci <marco@pracucci.com> * Clarified recommended version Signed-off-by: Marco Pracucci <marco@pracucci.com>
1 parent 32427f7 commit 2f140e5

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Internally, the access to the chunks storage relies on a unified interface calle
4848

4949
The chunk and index format are versioned, this allows Cortex operators to upgrade the cluster to take advantage of new features and improvements. This strategy enables changes in the storage format without requiring any downtime or complex procedures to rewrite the stored data. A set of schemas are used to map the version while reading and writing time series belonging to a specific period of time.
5050

51-
The current schema recommendation is the **v10 schema** (v11 is still experimental). For more information about the schema, please check out the [Schema](configuration/schema-config-reference.md) documentation.
51+
The current schema recommendation is the **v9 schema** for most use cases and **v10 schema** if you expect to have very high cardinality metrics (v11 is still experimental). For more information about the schema, please check out the [Schema](configuration/schema-config-reference.md) documentation.
5252

5353
### Blocks storage (experimental)
5454

docs/configuration/schema-config-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: schema-configuration
77

88
Cortex uses a NoSQL Store to store its index and optionally an Object store to store its chunks. Cortex has overtime evolved its schema to be more optimal and better fit the use cases and query patterns that arose.
99

10-
Currently there are 9 schemas that are used in production but we recommend running with `v9` schema when possible. You can move from one schema to another if a new schema fits your purpose better, but you still need to configure Cortex to make sure it can read the old data in the old schemas.
10+
Currently there are 11 schemas that are used in production but we recommend running with the **v9 schema** for most use cases and **v10 schema** if you expect to have very high cardinality metrics. You can move from one schema to another if a new schema fits your purpose better, but you still need to configure Cortex to make sure it can read the old data in the old schemas.
1111

1212
You can configure the schemas using a YAML config file, that you can point to using the `-schema-config-file` flag. It has the following YAML spec:
1313

@@ -23,7 +23,7 @@ from: <string>
2323
store: <string>
2424
# The object client to use. If none is specified, `store` is used for storing chunks as well. Valid options: s3, aws-dynamo, bigtable, bigtable-hashed, gcs, cassandra, filesystem.
2525
object_store: <string>
26-
# The schema version to use. Valid ones are v1, v2, v3,... v6, v9, v10, v11. Recommended for production: v9.
26+
# The schema version to use. Valid ones are v1, v2, v3,... v6, v9, v10, v11. Recommended for production: v9 for most use cases or v10 if you expect to have very high cardinality metrics.
2727
schema: <string>
2828
index: <periodic_table_config>
2929
chunks: <periodic_table_config>

0 commit comments

Comments
 (0)