File tree Expand file tree Collapse file tree 2 files changed +20
-4
lines changed Expand file tree Collapse file tree 2 files changed +20
-4
lines changed Original file line number Diff line number Diff line change @@ -21,12 +21,15 @@ Cortex is a primarily used as a [remote write](https://prometheus.io/docs/operat
21
21
22
22
## Documentation
23
23
24
- Read the [ getting started guide] ( docs/getting_started.md ) if you're new to the project.
24
+ Read the [ getting started guide] ( docs/getting_started.md ) if you're new to the
25
+ project. Before deploying Cortex with a permanent storage backend you
26
+ should read:
27
+ 1 . [ An overview of Cortex's architecture] ( docs/architecture.md )
28
+ 1 . [ A general guide to running Cortex] ( docs/running.md )
29
+ 1 . [ Information regarding configuring Cortex] ( docs/arguments.md )
25
30
26
31
For a guide to contributing to Cortex, see the [ contributor guidelines] ( CONTRIBUTING.md ) .
27
32
28
- You can also read [ an overview of Cortex's architecture] ( docs/architecture.md ) and [ information about configuring Cortex] ( docs/arguments.md ) .
29
-
30
33
## Further reading
31
34
32
35
To learn more about Cortex, consult the following documents & talks:
Original file line number Diff line number Diff line change @@ -47,7 +47,20 @@ replica and be unconcerned, as we still have two copies of the data
47
47
left for redundancy. This is configurable: you can run with more
48
48
redundancy or less, depending on your risk appetite.
49
49
50
- ### Index schema
50
+ ### Schema
51
+
52
+ #### Schema periodic table
53
+
54
+ The periodic table from argument (` -dynamodb.periodic-table.from=<date> ` if
55
+ using command line flags, the ` from ` field for the first schema entry if using
56
+ YAML) should be set to the date the oldest metrics you will be sending to
57
+ Cortex. Generally that means set it to the date you are first deploying this
58
+ instance. If you use an example date from years ago table-manager will create
59
+ hundreds of tables. You can also avoid creating too many tables by setting a
60
+ reasonable retention in the table-manager
61
+ (` -table-manager.retention-period=<duration> ` ).
62
+
63
+ #### Schema version
51
64
52
65
Choose schema version 9 in most cases; version 10 if you expect
53
66
hundreds of thousands of timeseries under a single name. Anything
You can’t perform that action at this time.
0 commit comments