Skip to content

Commit e7b4e2f

Browse files
authored
Cleanup duration defaults in the generated config doc (#2449)
Signed-off-by: Marco Pracucci <[email protected]>
1 parent 88fe1b1 commit e7b4e2f

File tree

3 files changed

+68
-50
lines changed

3 files changed

+68
-50
lines changed

docs/configuration/config-file-reference.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ The `server_config` configures the HTTP and gRPC server of the launched service(
197197
198198
# Idle timeout for HTTP server
199199
# CLI flag: -server.http-idle-timeout
200-
[http_server_idle_timeout: <duration> | default = 2m0s]
200+
[http_server_idle_timeout: <duration> | default = 2m]
201201
202202
# Limit on the size of a gRPC message this server can receive (bytes).
203203
# CLI flag: -server.grpc-max-recv-msg-size-bytes
@@ -229,7 +229,7 @@ The `server_config` configures the HTTP and gRPC server of the launched service(
229229
# Duration after which a keepalive probe is sent in case of no activity over the
230230
# connection., Default: 2h
231231
# CLI flag: -server.grpc.keepalive.time
232-
[grpc_server_keepalive_time: <duration> | default = 2h0m0s]
232+
[grpc_server_keepalive_time: <duration> | default = 2h]
233233
234234
# After having pinged for keepalive check, the duration after which an idle
235235
# connection should be closed, Default: 20s
@@ -377,7 +377,7 @@ ring:
377377
# The heartbeat timeout after which distributors are considered unhealthy
378378
# within the ring.
379379
# CLI flag: -distributor.ring.heartbeat-timeout
380-
[heartbeat_timeout: <duration> | default = 1m0s]
380+
[heartbeat_timeout: <duration> | default = 1m]
381381
```
382382

383383
### `ingester_config`
@@ -406,7 +406,7 @@ walconfig:
406406
407407
# Interval at which checkpoints should be created.
408408
# CLI flag: -ingester.checkpoint-duration
409-
[checkpoint_duration: <duration> | default = 30m0s]
409+
[checkpoint_duration: <duration> | default = 30m]
410410
411411
lifecycler:
412412
ring:
@@ -445,7 +445,7 @@ lifecycler:
445445
446446
# The heartbeat timeout after which ingesters are skipped for reads/writes.
447447
# CLI flag: -ring.heartbeat-timeout
448-
[heartbeat_timeout: <duration> | default = 1m0s]
448+
[heartbeat_timeout: <duration> | default = 1m]
449449
450450
# The number of ingesters to write to and read from.
451451
# CLI flag: -distributor.replication-factor
@@ -472,7 +472,7 @@ lifecycler:
472472
# Minimum duration to wait before becoming ready. This is to work around race
473473
# conditions with ingesters exiting and updating the ring.
474474
# CLI flag: -ingester.min-ready-duration
475-
[min_ready_duration: <duration> | default = 1m0s]
475+
[min_ready_duration: <duration> | default = 1m]
476476
477477
# Name of network interface to read address from.
478478
# CLI flag: -ingester.lifecycler.interface
@@ -499,29 +499,29 @@ lifecycler:
499499
500500
# Period with which to attempt to flush chunks.
501501
# CLI flag: -ingester.flush-period
502-
[flush_period: <duration> | default = 1m0s]
502+
[flush_period: <duration> | default = 1m]
503503
504504
# Period chunks will remain in memory after flushing.
505505
# CLI flag: -ingester.retain-period
506-
[retain_period: <duration> | default = 5m0s]
506+
[retain_period: <duration> | default = 5m]
507507
508508
# Maximum chunk idle time before flushing.
509509
# CLI flag: -ingester.max-chunk-idle
510-
[max_chunk_idle_time: <duration> | default = 5m0s]
510+
[max_chunk_idle_time: <duration> | default = 5m]
511511
512512
# Maximum chunk idle time for chunks terminating in stale markers before
513513
# flushing. 0 disables it and a stale series is not flushed until the
514514
# max-chunk-idle timeout is reached.
515515
# CLI flag: -ingester.max-stale-chunk-idle
516-
[max_stale_chunk_idle_time: <duration> | default = 2m0s]
516+
[max_stale_chunk_idle_time: <duration> | default = 2m]
517517
518518
# Timeout for individual flush operations.
519519
# CLI flag: -ingester.flush-op-timeout
520-
[flush_op_timeout: <duration> | default = 1m0s]
520+
[flush_op_timeout: <duration> | default = 1m]
521521
522522
# Maximum chunk age before flushing.
523523
# CLI flag: -ingester.max-chunk-age
524-
[max_chunk_age: <duration> | default = 12h0m0s]
524+
[max_chunk_age: <duration> | default = 12h]
525525
526526
# Range of time to subtract from -ingester.max-chunk-age to spread out flushes
527527
# CLI flag: -ingester.chunk-age-jitter
@@ -552,7 +552,7 @@ The `querier_config` configures the Cortex querier.
552552
553553
# The timeout for a query.
554554
# CLI flag: -querier.timeout
555-
[timeout: <duration> | default = 2m0s]
555+
[timeout: <duration> | default = 2m]
556556
557557
# Use iterators to execute query, as opposed to fully materialising the series
558558
# in memory.
@@ -584,11 +584,11 @@ The `querier_config` configures the Cortex querier.
584584
585585
# Maximum duration into the future you can query. 0 to disable.
586586
# CLI flag: -querier.max-query-into-future
587-
[max_query_into_future: <duration> | default = 10m0s]
587+
[max_query_into_future: <duration> | default = 10m]
588588
589589
# The default evaluation interval or step size for subqueries.
590590
# CLI flag: -querier.default-evaluation-interval
591-
[default_evaluation_interval: <duration> | default = 1m0s]
591+
[default_evaluation_interval: <duration> | default = 1m]
592592
593593
# Active query tracker monitors active queries, and writes them to the file in
594594
# given directory. If Cortex discovers any queries in this log during startup,
@@ -681,7 +681,7 @@ results_cache:
681681
# Most recent allowed cacheable result, to prevent caching very recent results
682682
# that might still be in flux.
683683
# CLI flag: -frontend.max-cache-freshness
684-
[max_freshness: <duration> | default = 1m0s]
684+
[max_freshness: <duration> | default = 1m]
685685
686686
# Cache query results.
687687
# CLI flag: -querier.cache-results
@@ -709,7 +709,7 @@ The `ruler_config` configures the Cortex ruler.
709709
710710
# How frequently to evaluate rules
711711
# CLI flag: -ruler.evaluation-interval
712-
[evaluation_interval: <duration> | default = 1m0s]
712+
[evaluation_interval: <duration> | default = 1m]
713713
714714
# Duration to delay the evaluation of rules to ensure they underlying metrics
715715
# have been pushed to cortex.
@@ -718,7 +718,7 @@ The `ruler_config` configures the Cortex ruler.
718718
719719
# How frequently to poll for rule changes
720720
# CLI flag: -ruler.poll-interval
721-
[poll_interval: <duration> | default = 1m0s]
721+
[poll_interval: <duration> | default = 1m]
722722
723723
storage:
724724
# Method to use for backend rule storage (configdb, azure, gcs, s3)
@@ -817,7 +817,7 @@ storage:
817817

818818
# How long to wait between refreshing alertmanager hosts.
819819
# CLI flag: -ruler.alertmanager-refresh-interval
820-
[alertmanager_refresh_interval: <duration> | default = 1m0s]
820+
[alertmanager_refresh_interval: <duration> | default = 1m]
821821

822822
# If enabled requests to alertmanager will utilize the V2 API.
823823
# CLI flag: -ruler.alertmanager-use-v2
@@ -837,7 +837,7 @@ storage:
837837

838838
# Time to spend searching for a pending ruler when shutting down.
839839
# CLI flag: -ruler.search-pending-for
840-
[search_pending_for: <duration> | default = 5m0s]
840+
[search_pending_for: <duration> | default = 5m]
841841

842842
ring:
843843
kvstore:
@@ -882,15 +882,15 @@ ring:
882882
# The heartbeat timeout after which rulers are considered unhealthy within the
883883
# ring.
884884
# CLI flag: -ruler.ring.heartbeat-timeout
885-
[heartbeat_timeout: <duration> | default = 1m0s]
885+
[heartbeat_timeout: <duration> | default = 1m]
886886

887887
# Number of tokens for each ingester.
888888
# CLI flag: -ruler.ring.num-tokens
889889
[num_tokens: <int> | default = 128]
890890

891891
# Period with which to attempt to flush rule groups.
892892
# CLI flag: -ruler.flush-period
893-
[flush_period: <duration> | default = 1m0s]
893+
[flush_period: <duration> | default = 1m]
894894

895895
# Enable the ruler api
896896
# CLI flag: -experimental.ruler.enable-api
@@ -908,7 +908,7 @@ The `alertmanager_config` configures the Cortex alertmanager.
908908
909909
# How long to keep data for.
910910
# CLI flag: -alertmanager.storage.retention
911-
[retention: <duration> | default = 120h0m0s]
911+
[retention: <duration> | default = 120h]
912912
913913
# The URL under which Alertmanager is externally reachable (for example, if
914914
# Alertmanager is served via a reverse proxy). Used for generating relative and
@@ -983,12 +983,12 @@ The `table_manager_config` configures the Cortex table-manager.
983983
984984
# How frequently to poll backend to learn our capacity.
985985
# CLI flag: -table-manager.poll-interval
986-
[poll_interval: <duration> | default = 2m0s]
986+
[poll_interval: <duration> | default = 2m]
987987
988988
# Periodic tables grace period (duration which table will be created/deleted
989989
# before/after it's needed).
990990
# CLI flag: -table-manager.periodic-table.grace-period
991-
[creation_grace_period: <duration> | default = 10m0s]
991+
[creation_grace_period: <duration> | default = 10m]
992992
993993
index_tables_provisioning:
994994
# Enables on demand throughput provisioning for the storage provider (if
@@ -1480,7 +1480,7 @@ bigtable:
14801480

14811481
# Duration to cache tables before checking again.
14821482
# CLI flag: -bigtable.table-cache.expiration
1483-
[table_cache_expiration: <duration> | default = 30m0s]
1483+
[table_cache_expiration: <duration> | default = 30m]
14841484

14851485
gcs:
14861486
# Name of GCS bucket to put chunks in.
@@ -1588,7 +1588,7 @@ filesystem:
15881588
# Cache validity for active index entries. Should be no higher than
15891589
# -ingester.max-chunk-idle.
15901590
# CLI flag: -store.index-cache-validity
1591-
[index_cache_validity: <duration> | default = 5m0s]
1591+
[index_cache_validity: <duration> | default = 5m]
15921592

15931593
index_queries_cache_config:
15941594
# Cache config for index entry reading. Enable in-memory cache.
@@ -1654,7 +1654,7 @@ The `flusher_config` configures the WAL flusher target, used to manually run one
16541654
16551655
# Timeout for individual flush operations.
16561656
# CLI flag: -flusher.flush-op-timeout
1657-
[flush_op_timeout: <duration> | default = 2m0s]
1657+
[flush_op_timeout: <duration> | default = 2m]
16581658
```
16591659

16601660
### `chunk_store_config`
@@ -1964,7 +1964,7 @@ The `memberlist_config` configures the Gossip memberlist.
19641964
19651965
# How long to keep LEFT ingesters in the ring.
19661966
# CLI flag: -memberlist.left-ingesters-timeout
1967-
[left_ingesters_timeout: <duration> | default = 5m0s]
1967+
[left_ingesters_timeout: <duration> | default = 5m]
19681968
19691969
# Timeout for leaving memberlist cluster.
19701970
# CLI flag: -memberlist.leave-timeout
@@ -2049,12 +2049,12 @@ The `limits_config` configures default and per-tenant limits imposed by Cortex s
20492049
20502050
# Maximum accepted sample age before rejecting.
20512051
# CLI flag: -validation.reject-old-samples.max-age
2052-
[reject_old_samples_max_age: <duration> | default = 336h0m0s]
2052+
[reject_old_samples_max_age: <duration> | default = 336h]
20532053
20542054
# Duration which table will be created/deleted before/after it's needed; we
20552055
# won't accept sample from before this time.
20562056
# CLI flag: -validation.create-grace-period
2057-
[creation_grace_period: <duration> | default = 10m0s]
2057+
[creation_grace_period: <duration> | default = 10m]
20582058
20592059
# Enforce every metadata has a metric name.
20602060
# CLI flag: -validation.enforce-metadata-metric-name
@@ -2230,7 +2230,7 @@ The `memcached_client_config` configures the client used to connect to Memcached
22302230
22312231
# Period with which to poll DNS for memcache servers.
22322232
# CLI flag: -<prefix>.memcached.update-interval
2233-
[update_interval: <duration> | default = 1m0s]
2233+
[update_interval: <duration> | default = 1m]
22342234
22352235
# Use consistent hashing to distribute to memcache servers.
22362236
# CLI flag: -<prefix>.memcached.consistent-hash
@@ -2332,12 +2332,12 @@ The `tsdb_config` configures the experimental blocks storage.
23322332
# be larger than the block_ranges_period and large enough to give queriers
23332333
# enough time to discover newly uploaded blocks.
23342334
# CLI flag: -experimental.tsdb.retention-period
2335-
[retention_period: <duration> | default = 6h0m0s]
2335+
[retention_period: <duration> | default = 6h]
23362336
23372337
# How frequently the TSDB blocks are scanned and new ones are shipped to the
23382338
# storage. 0 means shipping is disabled.
23392339
# CLI flag: -experimental.tsdb.ship-interval
2340-
[ship_interval: <duration> | default = 1m0s]
2340+
[ship_interval: <duration> | default = 1m]
23412341
23422342
# Maximum number of tenants concurrently shipping blocks to the storage.
23432343
# CLI flag: -experimental.tsdb.ship-concurrency
@@ -2355,7 +2355,7 @@ bucket_store:
23552355
# How frequently scan the bucket to look for changes (new blocks shipped by
23562356
# ingesters and blocks removed by retention or compaction). 0 disables it.
23572357
# CLI flag: -experimental.tsdb.bucket-store.sync-interval
2358-
[sync_interval: <duration> | default = 5m0s]
2358+
[sync_interval: <duration> | default = 5m]
23592359
23602360
# Max size - in bytes - of a per-tenant chunk pool, used to reduce memory
23612361
# allocations.
@@ -2460,12 +2460,12 @@ bucket_store:
24602460
# replacement yet.Default is 6h, half of the default value for
24612461
# -compactor.deletion-delay.
24622462
# CLI flag: -experimental.tsdb.bucket-store.ignore-deletion-marks-delay
2463-
[ignore_deletion_mark_delay: <duration> | default = 6h0m0s]
2463+
[ignore_deletion_mark_delay: <duration> | default = 6h]
24642464
24652465
# How frequently does Cortex try to compact TSDB head. Block is only created if
24662466
# data covers smallest block range. Must be greater than 0 and max 5 minutes.
24672467
# CLI flag: -experimental.tsdb.head-compaction-interval
2468-
[head_compaction_interval: <duration> | default = 1m0s]
2468+
[head_compaction_interval: <duration> | default = 1m]
24692469
24702470
# Maximum number of tenants concurrently compacting TSDB head into a new block
24712471
# CLI flag: -experimental.tsdb.head-compaction-concurrency
@@ -2565,15 +2565,15 @@ The `compactor_config` configures the compactor for the experimental blocks stor
25652565
# Malformed blocks older than the maximum of consistency-delay and 48h0m0s will
25662566
# be removed.
25672567
# CLI flag: -compactor.consistency-delay
2568-
[consistency_delay: <duration> | default = 30m0s]
2568+
[consistency_delay: <duration> | default = 30m]
25692569
25702570
# Data directory in which to cache blocks and process compactions
25712571
# CLI flag: -compactor.data-dir
25722572
[data_dir: <string> | default = "./data"]
25732573
25742574
# The frequency at which the compaction runs
25752575
# CLI flag: -compactor.compaction-interval
2576-
[compaction_interval: <duration> | default = 1h0m0s]
2576+
[compaction_interval: <duration> | default = 1h]
25772577
25782578
# How many times to retry a failed compaction during a single compaction
25792579
# interval
@@ -2587,7 +2587,7 @@ The `compactor_config` configures the compactor for the experimental blocks stor
25872587
# failures, if store gateway still has the block loaded, or compactor is
25882588
# ignoring the deletion because it's compacting the block at the same time.
25892589
# CLI flag: -compactor.deletion-delay
2590-
[deletion_delay: <duration> | default = 12h0m0s]
2590+
[deletion_delay: <duration> | default = 12h]
25912591
25922592
# Shard tenants across multiple compactor instances. Sharding is required if you
25932593
# run multiple compactor instances, in order to coordinate compactions and avoid
@@ -2639,7 +2639,7 @@ sharding_ring:
26392639
# The heartbeat timeout after which compactors are considered unhealthy within
26402640
# the ring.
26412641
# CLI flag: -compactor.ring.heartbeat-timeout
2642-
[heartbeat_timeout: <duration> | default = 1m0s]
2642+
[heartbeat_timeout: <duration> | default = 1m]
26432643
```
26442644

26452645
### `purger_config`

0 commit comments

Comments
 (0)