Skip to content

Commit

Permalink
Addressed doc review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Marco Pracucci <marco@pracucci.com>
  • Loading branch information
pracucci committed Jun 25, 2024
1 parent 1cccdc0 commit 1efcf6f
Show file tree
Hide file tree
Showing 8 changed files with 67 additions and 68 deletions.
24 changes: 12 additions & 12 deletions cmd/mimir/config-descriptor.json
Original file line number Diff line number Diff line change
Expand Up @@ -2694,7 +2694,7 @@
"kind": "field",
"name": "heartbeat_timeout",
"required": false,
"desc": "The heartbeat timeout after which ingesters are skipped for reads/writes. 0 = never (timeout disabled). This option needs be set on ingesters, distributors, queriers and rulers when running in microservices mode.",
"desc": "The heartbeat timeout after which ingesters are skipped for reads/writes. 0 = never (timeout disabled). This option needs be set on ingesters, distributors, queriers, and rulers when running in microservices mode.",
"fieldValue": null,
"fieldDefaultValue": 60000000000,
"fieldFlag": "ingester.ring.heartbeat-timeout",
Expand All @@ -2705,7 +2705,7 @@
"kind": "field",
"name": "replication_factor",
"required": false,
"desc": "Number of ingesters that each time series is replicated to. This option needs be set on ingesters, distributors, queriers and rulers when running in microservices mode.",
"desc": "Number of ingesters that each time series is replicated to. This option needs be set on ingesters, distributors, queriers, and rulers when running in microservices mode.",
"fieldValue": null,
"fieldDefaultValue": 3,
"fieldFlag": "ingester.ring.replication-factor",
Expand All @@ -2715,7 +2715,7 @@
"kind": "field",
"name": "zone_awareness_enabled",
"required": false,
"desc": "True to enable the zone-awareness and replicate ingested samples across different availability zones. This option needs be set on ingesters, distributors, queriers and rulers when running in microservices mode.",
"desc": "True to enable the zone-awareness and replicate ingested samples across different availability zones. This option needs be set on ingesters, distributors, queriers, and rulers when running in microservices mode.",
"fieldValue": null,
"fieldDefaultValue": false,
"fieldFlag": "ingester.ring.zone-awareness-enabled",
Expand All @@ -2725,7 +2725,7 @@
"kind": "field",
"name": "excluded_zones",
"required": false,
"desc": "Comma-separated list of zones to exclude from the ring. Instances in excluded zones will be filtered out from the ring. This option needs be set on ingesters, distributors, queriers and rulers when running in microservices mode.",
"desc": "Comma-separated list of zones to exclude from the ring. Instances in excluded zones will be filtered out from the ring. This option needs be set on ingesters, distributors, queriers, and rulers when running in microservices mode.",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "ingester.ring.excluded-zones",
Expand Down Expand Up @@ -3241,7 +3241,7 @@
"kind": "field",
"name": "min_partition_owners_duration",
"required": false,
"desc": "How long the minimum number of owners should have been enforced before a PENDING partition gets switched to ACTIVE.",
"desc": "How long the minimum number of owners are enforced before a PENDING partition gets switched to ACTIVE.",
"fieldValue": null,
"fieldDefaultValue": 10000000000,
"fieldFlag": "ingester.partition-ring.min-partition-owners-duration",
Expand All @@ -3251,7 +3251,7 @@
"kind": "field",
"name": "delete_inactive_partition_after",
"required": false,
"desc": "How long to wait before an INACTIVE partition is eligible for deletion. The partition will be deleted only if it has been in INACTIVE state for at least the configured duration and it has no owners registered. A value of 0 disables partitions deletion.",
"desc": "How long to wait before an INACTIVE partition is eligible for deletion. The partition is deleted only if it has been in INACTIVE state for at least the configured duration and it has no owners registered. A value of 0 disables partitions deletion.",
"fieldValue": null,
"fieldDefaultValue": 46800000000000,
"fieldFlag": "ingester.partition-ring.delete-inactive-partition-after",
Expand Down Expand Up @@ -4714,7 +4714,7 @@
"kind": "field",
"name": "ingest_storage_read_consistency",
"required": false,
"desc": "The default consistency level to enforce to queries when using the ingest storage. Supports values: strong, eventual.",
"desc": "The default consistency level to enforce for queries when using the ingest storage. Supports values: strong, eventual.",
"fieldValue": null,
"fieldDefaultValue": "eventual",
"fieldFlag": "ingest-storage.read-consistency",
Expand Down Expand Up @@ -6501,7 +6501,7 @@
"kind": "field",
"name": "write_clients",
"required": false,
"desc": "The number of Kafka clients used by producers. When the configured number of clients is greater than 1, partitions are sharded among Kafka clients. An higher number of clients may provide higher write throughput at the cost of additional Metadata requests pressure to Kafka.",
"desc": "The number of Kafka clients used by producers. When the configured number of clients is greater than 1, partitions are sharded among Kafka clients. A higher number of clients may provide higher write throughput at the cost of additional Metadata requests pressure to Kafka.",
"fieldValue": null,
"fieldDefaultValue": 1,
"fieldFlag": "ingest-storage.kafka.write-clients",
Expand All @@ -6511,7 +6511,7 @@
"kind": "field",
"name": "consumer_group",
"required": false,
"desc": "The consumer group used by the consumer to track the last consumed offset. The consumer group must be different for each ingester. If the configured consumer group contains the '\u003cpartition\u003e' placeholder, it will be replaced with the actual partition ID owned by the ingester. When empty (recommended), Mimir will use the ingester instance ID to guarantee uniqueness.",
"desc": "The consumer group used by the consumer to track the last consumed offset. The consumer group must be different for each ingester. If the configured consumer group contains the '\u003cpartition\u003e' placeholder, it is replaced with the actual partition ID owned by the ingester. When empty (recommended), Mimir uses the ingester instance ID to guarantee uniqueness.",
"fieldValue": null,
"fieldDefaultValue": "",
"fieldFlag": "ingest-storage.kafka.consumer-group",
Expand Down Expand Up @@ -6591,7 +6591,7 @@
"kind": "field",
"name": "auto_create_topic_default_partitions",
"required": false,
"desc": "When auto-creation of Kafka topic is enabled and this value is positive, Kafka's num.partitions configuration option is set on Kafka brokers with this value when Mimir component that uses Kafka starts. This configuration option specifies the default number of partitions that Kafka broker will use for auto-created topics. Note that this is Kafka-cluster wide setting, and applies to any auto-created topic. If setting of num.partitions fails, Mimir will proceed anyway, but auto-created topic may have incorrect number of partitions.",
"desc": "When auto-creation of Kafka topic is enabled and this value is positive, Kafka's num.partitions configuration option is set on Kafka brokers with this value when Mimir component that uses Kafka starts. This configuration option specifies the default number of partitions that the Kafka broker uses for auto-created topics. Note that this is a Kafka-cluster wide setting, and applies to any auto-created topic. If the setting of num.partitions fails, Mimir proceeds anyways, but auto-created topics could have an incorrect number of partitions.",
"fieldValue": null,
"fieldDefaultValue": 0,
"fieldFlag": "ingest-storage.kafka.auto-create-topic-default-partitions",
Expand All @@ -6601,7 +6601,7 @@
"kind": "field",
"name": "producer_max_record_size_bytes",
"required": false,
"desc": "The maximum size of a Kafka record data that should be generated by the producer. An incoming write request bigger than this size is split into multiple Kafka records. We strongly recommend to not change this setting unless for testing purposes.",
"desc": "The maximum size of a Kafka record data that should be generated by the producer. An incoming write request larger than this size is split into multiple Kafka records. We strongly recommend to not change this setting unless for testing purposes.",
"fieldValue": null,
"fieldDefaultValue": 15983616,
"fieldFlag": "ingest-storage.kafka.producer-max-record-size-bytes",
Expand All @@ -6621,7 +6621,7 @@
"kind": "field",
"name": "distributor_send_to_ingesters_enabled",
"required": false,
"desc": "When both this option and ingest storage is enabled, distributors will both write to Kafka and ingesters. A write request will be considered successful only when written to both backends.",
"desc": "When both this option and ingest storage are enabled, distributors write to both Kafka and ingesters. A write request is considered successful only when written to both backends.",
"fieldValue": null,
"fieldDefaultValue": false,
"fieldFlag": "ingest-storage.migration.distributor-send-to-ingesters-enabled",
Expand Down
Loading

0 comments on commit 1efcf6f

Please sign in to comment.