Skip to content

Commit 9b9c279

Browse files
committed
Fix typos in code and docs
1 parent e034437 commit 9b9c279

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+80
-80
lines changed

CHANGELOG.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@
304304
* [FEATURE] Compactor: Add `-compactor.skip-blocks-with-out-of-order-chunks-enabled` configuration to mark blocks containing index with out-of-order chunks for no compact instead of halting the compaction. #4707
305305
* [FEATURE] Querier/Query-Frontend: Add `-querier.per-step-stats-enabled` and `-frontend.cache-queryable-samples-stats` configurations to enable query sample statistics. #4708
306306
* [FEATURE] Add shuffle sharding for the compactor #4433
307-
* [FEATURE] Querier: Use streaming for ingester metdata APIs. #4725
307+
* [FEATURE] Querier: Use streaming for ingester metadata APIs. #4725
308308
* [ENHANCEMENT] Update Go version to 1.17.8. #4602 #4604 #4658
309309
* [ENHANCEMENT] Keep track of discarded samples due to bad relabel configuration in `cortex_discarded_samples_total`. #4503
310310
* [ENHANCEMENT] Ruler: Add `-ruler.disable-rule-group-label` to disable the `rule_group` label on exported metrics. #4571
@@ -443,7 +443,7 @@
443443
* `memberlist_client_kv_store_value_tombstones`
444444
* `memberlist_client_kv_store_value_tombstones_removed_total`
445445
* `memberlist_client_messages_to_broadcast_dropped_total`
446-
* [ENHANCEMENT] Alertmanager: Added `-alertmanager.max-dispatcher-aggregation-groups` option to control max number of active dispatcher groups in Alertmanager (per tenant, also overrideable). When the limit is reached, Dispatcher produces log message and increases `cortex_alertmanager_dispatcher_aggregation_group_limit_reached_total` metric. #4254
446+
* [ENHANCEMENT] Alertmanager: Added `-alertmanager.max-dispatcher-aggregation-groups` option to control max number of active dispatcher groups in Alertmanager (per tenant, also overridable). When the limit is reached, Dispatcher produces log message and increases `cortex_alertmanager_dispatcher_aggregation_group_limit_reached_total` metric. #4254
447447
* [ENHANCEMENT] Alertmanager: Added `-alertmanager.max-alerts-count` and `-alertmanager.max-alerts-size-bytes` to control max number of alerts and total size of alerts that a single user can have in Alertmanager's memory. Adding more alerts will fail with a log message and incrementing `cortex_alertmanager_alerts_insert_limited_total` metric (per-user). These limits can be overrided by using per-tenant overrides. Current values are tracked in `cortex_alertmanager_alerts_limiter_current_alerts` and `cortex_alertmanager_alerts_limiter_current_alerts_size_bytes` metrics. #4253
448448
* [ENHANCEMENT] Store-gateway: added `-store-gateway.sharding-ring.wait-stability-min-duration` and `-store-gateway.sharding-ring.wait-stability-max-duration` support to store-gateway, to wait for ring stability at startup. #4271
449449
* [ENHANCEMENT] Ruler: added `rule_group` label to metrics `cortex_prometheus_rule_group_iterations_total` and `cortex_prometheus_rule_group_iterations_missed_total`. #4121
@@ -530,7 +530,7 @@
530530
* [ENHANCEMENT] Alertmanager: validate configured `-alertmanager.web.external-url` and fail if ends with `/`. #4081
531531
* [ENHANCEMENT] Alertmanager: added `-alertmanager.receivers-firewall.block.cidr-networks` and `-alertmanager.receivers-firewall.block.private-addresses` to block specific network addresses in HTTP-based Alertmanager receiver integrations. #4085
532532
* [ENHANCEMENT] Allow configuration of Cassandra's host selection policy. #4069
533-
* [ENHANCEMENT] Store-gateway: retry synching blocks if a per-tenant sync fails. #3975 #4088
533+
* [ENHANCEMENT] Store-gateway: retry syncing blocks if a per-tenant sync fails. #3975 #4088
534534
* [ENHANCEMENT] Add metric `cortex_tcp_connections` exposing the current number of accepted TCP connections. #4099
535535
* [ENHANCEMENT] Querier: Allow federated queries to run concurrently. #4065
536536
* [ENHANCEMENT] Label Values API call now supports `match[]` parameter when querying blocks on storage (assuming `-querier.query-store-for-labels-enabled` is enabled). #4133
@@ -607,7 +607,7 @@
607607
* Prevent compaction loop in TSDB on data gap.
608608
* [ENHANCEMENT] Query-Frontend now returns server side performance metrics using `Server-Timing` header when query stats is enabled. #3685
609609
* [ENHANCEMENT] Runtime Config: Add a `mode` query parameter for the runtime config endpoint. `/runtime_config?mode=diff` now shows the YAML runtime configuration with all values that differ from the defaults. #3700
610-
* [ENHANCEMENT] Distributor: Enable downstream projects to wrap distributor push function and access the deserialized write requests berfore/after they are pushed. #3755
610+
* [ENHANCEMENT] Distributor: Enable downstream projects to wrap distributor push function and access the deserialized write requests before/after they are pushed. #3755
611611
* [ENHANCEMENT] Add flag `-<prefix>.tls-server-name` to require a specific server name instead of the hostname on the certificate. #3156
612612
* [ENHANCEMENT] Alertmanager: Remove a tenant's alertmanager instead of pausing it as we determine it is no longer needed. #3722
613613
* [ENHANCEMENT] Blocks storage: added more configuration options to S3 client. #3775
@@ -895,7 +895,7 @@ Note the blocks storage compactor runs a migration task at startup in this versi
895895
* [ENHANCEMENT] Chunks GCS object storage client uses the `fields` selector to limit the payload size when listing objects in the bucket. #3218 #3292
896896
* [ENHANCEMENT] Added shuffle sharding support to ruler. Added new metric `cortex_ruler_sync_rules_total`. #3235
897897
* [ENHANCEMENT] Return an explicit error when the store-gateway is explicitly requested without a blocks storage engine. #3287
898-
* [ENHANCEMENT] Ruler: only load rules that belong to the ruler. Improves rules synching performances when ruler sharding is enabled. #3269
898+
* [ENHANCEMENT] Ruler: only load rules that belong to the ruler. Improves rules syncing performances when ruler sharding is enabled. #3269
899899
* [ENHANCEMENT] Added `-<prefix>.redis.tls-insecure-skip-verify` flag. #3298
900900
* [ENHANCEMENT] Added `cortex_alertmanager_config_last_reload_successful_seconds` metric to show timestamp of last successful AM config reload. #3289
901901
* [ENHANCEMENT] Blocks storage: reduced number of bucket listing operations to list block content (applies to newly created blocks only). #3363
@@ -1453,7 +1453,7 @@ This is the first major release of Cortex. We made a lot of **breaking changes**
14531453
* `-flusher.concurrent-flushes` for number of concurrent flushes.
14541454
* `-flusher.flush-op-timeout` is duration after which a flush should timeout.
14551455
* [FEATURE] Ingesters can now have an optional availability zone set, to ensure metric replication is distributed across zones. This is set via the `-ingester.availability-zone` flag or the `availability_zone` field in the config file. #2317
1456-
* [ENHANCEMENT] Better re-use of connections to DynamoDB and S3. #2268
1456+
* [ENHANCEMENT] Better reuse of connections to DynamoDB and S3. #2268
14571457
* [ENHANCEMENT] Reduce number of goroutines used while executing a single index query. #2280
14581458
* [ENHANCEMENT] Experimental TSDB: Add support for local `filesystem` backend. #2245
14591459
* [ENHANCEMENT] Experimental TSDB: Added memcached support for the TSDB index cache. #2290
@@ -2243,7 +2243,7 @@ migrate -path <absolute_path_to_cortex>/cmd/cortex/migrations -database postgre
22432243

22442244
## 0.4.0 / 2019-12-02
22452245

2246-
* [CHANGE] The frontend component has been refactored to be easier to re-use. When upgrading the frontend, cache entries will be discarded and re-created with the new protobuf schema. #1734
2246+
* [CHANGE] The frontend component has been refactored to be easier to reuse. When upgrading the frontend, cache entries will be discarded and re-created with the new protobuf schema. #1734
22472247
* [CHANGE] Removed direct DB/API access from the ruler. `-ruler.configs.url` has been now deprecated. #1579
22482248
* [CHANGE] Removed `Delta` encoding. Any old chunks with `Delta` encoding cannot be read anymore. If `ingester.chunk-encoding` is set to `Delta` the ingester will fail to start. #1706
22492249
* [CHANGE] Setting `-ingester.max-transfer-retries` to 0 now disables hand-over when ingester is shutting down. Previously, zero meant infinite number of attempts. #1771

RELEASE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ To prepare release branch, first create new release branch (release-X.Y) in Cort
8585
* `[BUGFIX]`
8686
- Run `./tools/release/check-changelog.sh LAST-RELEASE-TAG...master` and add any missing PR which includes user-facing changes
8787

88-
Once your PR with release prepartion is approved, merge it to "release-X.Y" branch, and continue with publishing.
88+
Once your PR with release preparation is approved, merge it to "release-X.Y" branch, and continue with publishing.
8989

9090
### Publish a release candidate
9191

@@ -127,7 +127,7 @@ To publish a stable release:
127127
1. Open a PR to add the new version to the backward compatibility integration test (`integration/backward_compatibility_test.go`)
128128

129129
### <a name="sing-and-sbom"></a>Sign the release artifacts and generate SBOM
130-
1. Make sure you have the release brnach checked out, and you don't have any local modifications
130+
1. Make sure you have the release branch checked out, and you don't have any local modifications
131131
1. Create and `cd` to an empty directory not within the project directory
132132
1. Run `mkdir sbom`
133133
1. Generate SBOMs using https://github.com/kubernetes-sigs/bom

build-image/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ RUN curl -sL https://deb.nodesource.com/setup_14.x | bash -
77
RUN apt-get install -y nodejs && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
88

99
# Install website builder dependencies. Whenever you change these version, please also change website/package.json
10-
# and viceversa.
10+
# and vice-versa.
1111
1212

1313
ENV SHFMT_VERSION=3.2.4

docs/blocks-storage/migrate-from-chunks-to-blocks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Where parameters are:
104104

105105
After starting new pod in `ingester-new` statefulset, script then triggers `/shutdown` endpoint on the old ingester. When the flushing on the old ingester is complete, scale down of statefulset continues, and process repeats.
106106

107-
_The script supports both migration from chunks to blocks, and viceversa (eg. rollback)._
107+
_The script supports both migration from chunks to blocks, and vice-versa (eg. rollback)._
108108

109109
### Known issues
110110

docs/blocks-storage/querier.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -522,11 +522,11 @@ blocks_storage:
522522
# CLI flag: -blocks-storage.bucket-store.max-inflight-requests
523523
[max_inflight_requests: <int> | default = 0]
524524

525-
# Maximum number of concurrent tenants synching blocks.
525+
# Maximum number of concurrent tenants syncing blocks.
526526
# CLI flag: -blocks-storage.bucket-store.tenant-sync-concurrency
527527
[tenant_sync_concurrency: <int> | default = 10]
528528

529-
# Maximum number of concurrent blocks synching per tenant.
529+
# Maximum number of concurrent blocks syncing per tenant.
530530
# CLI flag: -blocks-storage.bucket-store.block-sync-concurrency
531531
[block_sync_concurrency: <int> | default = 20]
532532

docs/blocks-storage/store-gateway.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -633,11 +633,11 @@ blocks_storage:
633633
# CLI flag: -blocks-storage.bucket-store.max-inflight-requests
634634
[max_inflight_requests: <int> | default = 0]
635635

636-
# Maximum number of concurrent tenants synching blocks.
636+
# Maximum number of concurrent tenants syncing blocks.
637637
# CLI flag: -blocks-storage.bucket-store.tenant-sync-concurrency
638638
[tenant_sync_concurrency: <int> | default = 10]
639639

640-
# Maximum number of concurrent blocks synching per tenant.
640+
# Maximum number of concurrent blocks syncing per tenant.
641641
# CLI flag: -blocks-storage.bucket-store.block-sync-concurrency
642642
[block_sync_concurrency: <int> | default = 20]
643643

docs/configuration/arguments.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -504,13 +504,13 @@ The DNS service discovery, inspired from Thanos DNS SD, supports different disco
504504
- **`dnssrvnoa+`**<br />
505505
The domain name after the prefix is looked up as a SRV query, with no A/AAAA lookup made after that. For example: `dnssrvnoa+_memcached._tcp.memcached.namespace.svc.cluster.local`
506506

507-
If **no prefix** is provided, the provided IP or hostname will be used straightaway without pre-resolving it.
507+
If **no prefix** is provided, the provided IP or hostname will be used straight away without pre-resolving it.
508508

509509
If you are using a managed memcached service from [Google Cloud](https://cloud.google.com/memorystore/docs/memcached/auto-discovery-overview), or [AWS](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/AutoDiscovery.HowAutoDiscoveryWorks.html), use the [auto-discovery](./config-file-reference.md#memcached-client-config) flag instead of DNS discovery, then use the discovery/configuration endpoint as the domain name without any prefix.
510510

511511
## Logging of IP of reverse proxy
512512

513-
If a reverse proxy is used in front of Cortex it might be diffult to troubleshoot errors. The following 3 settings can be used to log the IP address passed along by the reverse proxy in headers like X-Forwarded-For.
513+
If a reverse proxy is used in front of Cortex it might be difficult to troubleshoot errors. The following 3 settings can be used to log the IP address passed along by the reverse proxy in headers like X-Forwarded-For.
514514

515515
- `-server.log_source_ips_enabled`
516516

docs/configuration/config-file-reference.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1067,11 +1067,11 @@ bucket_store:
10671067
# CLI flag: -blocks-storage.bucket-store.max-inflight-requests
10681068
[max_inflight_requests: <int> | default = 0]
10691069

1070-
# Maximum number of concurrent tenants synching blocks.
1070+
# Maximum number of concurrent tenants syncing blocks.
10711071
# CLI flag: -blocks-storage.bucket-store.tenant-sync-concurrency
10721072
[tenant_sync_concurrency: <int> | default = 10]
10731073

1074-
# Maximum number of concurrent blocks synching per tenant.
1074+
# Maximum number of concurrent blocks syncing per tenant.
10751075
# CLI flag: -blocks-storage.bucket-store.block-sync-concurrency
10761076
[block_sync_concurrency: <int> | default = 20]
10771077

@@ -4750,7 +4750,7 @@ grpc_tls_config:
47504750
# CLI flag: -server.grpc-tls-ca-path
47514751
[client_ca_file: <string> | default = ""]
47524752
4753-
# Register the intrumentation handlers (/metrics etc).
4753+
# Register the instrumentation handlers (/metrics etc).
47544754
# CLI flag: -server.register-instrumentation
47554755
[register_instrumentation: <boolean> | default = true]
47564756

docs/guides/gossip-ring-getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ but it can also build its own KV store on top of memberlist library using a goss
1010

1111
This short guide shows how to start Cortex in [single-binary mode](../architecture.md) with memberlist-based ring.
1212
To reduce number of required dependencies in this guide, it will use [blocks storage](../blocks-storage/_index.md) with no shipping to external stores.
13-
Storage engine and external storage configuration are not dependant on the ring configuration.
13+
Storage engine and external storage configuration are not dependent on the ring configuration.
1414

1515
## Single-binary, two Cortex instances
1616

17-
For simplicity and to get started, we'll run it as a two instances of Cortex on local computer.
17+
For simplicity and to get started, we'll run it as two instances of Cortex on local computer.
1818
We will use prepared configuration files ([file 1](../../configuration/single-process-config-blocks-gossip-1.yaml), [file 2](../../configuration/single-process-config-blocks-gossip-2.yaml)), with no external
1919
dependencies.
2020

docs/guides/tls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ openssl x509 -req -in server.csr -CA root.crt -CAkey root.key -CAcreateserial -o
3838

3939
Note that the above script generates certificates that are valid for 100000 days.
4040
This can be changed by adjusting the `-days` option in the above commands.
41-
It is recommended that the certs be replaced atleast once every 2 years.
41+
It is recommended that the certs be replaced at least once every 2 years.
4242

4343
The above script generates keys `client.key, server.key` and certs
4444
`client.crt, server.crt` for both the client and server. The CA cert is

docs/proposals/api_design.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Cortex will utilize path based versioning similar to both Prometheus and Alertma
7171

7272
The new API endpoints and the current http prefix endpoints can be maintained concurrently. The flag to configure these endpoints will be maintained as `http.prefix`. This will allow us to roll out the new API without disrupting the current routing schema. The original http prefix endpoints can maintained indefinitely or be phased out over time. Deprecation warnings can be added to the current API either when initialized or utilized. This can be accomplished by injecting a middleware that logs a warning whenever a legacy API endpoint is used.
7373

74-
In cases where Cortex is run as a single binary, the Alertmanager module will only be accesible using the new API.
74+
In cases where Cortex is run as a single binary, the Alertmanager module will only be accessible using the new API.
7575

7676
### Implementation
7777

docs/proposals/parallel-compaction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ slug: parallel-compaction
1111
---
1212

1313
## Introduction
14-
As a part of pushing Cortex’s scaling capability at AWS, we have done performance testing with Cortex and found the compactor to be one of the main limiting factors for higher active timeseries limit per tenant. The documentation [Compactor](https://cortexmetrics.io/docs/blocks-storage/compactor/#how-compaction-works) describes the responsibilities of a compactor, and this proposal focuses on the limitations of the current compactor architecture. In the current architecture, compactor has simple sharding, meaning that a single tenant is sharded to a single compactor. The compactor generates compaction groups, which are groups of Prometheus TSDB blocks that can be compacted together, independently of another group. However, a compactor currnetly handles compaction groups of a single tenant iteratively, meaning that blocks belonging non-overlapping times are not compacted in parallel.
14+
As a part of pushing Cortex’s scaling capability at AWS, we have done performance testing with Cortex and found the compactor to be one of the main limiting factors for higher active timeseries limit per tenant. The documentation [Compactor](https://cortexmetrics.io/docs/blocks-storage/compactor/#how-compaction-works) describes the responsibilities of a compactor, and this proposal focuses on the limitations of the current compactor architecture. In the current architecture, compactor has simple sharding, meaning that a single tenant is sharded to a single compactor. The compactor generates compaction groups, which are groups of Prometheus TSDB blocks that can be compacted together, independently of another group. However, a compactor currently handles compaction groups of a single tenant iteratively, meaning that blocks belonging non-overlapping times are not compacted in parallel.
1515

1616
Cortex ingesters are responsible for uploading TSDB blocks with data emitted by a tenant. These blocks are considered as level-1 blocks, as they contain duplicate timeseries for the same time interval, depending on the replication factor. [Vertical compaction](https://cortexmetrics.io/docs/blocks-storage/compactor/#how-compaction-works) is done to merge all the blocks with the same time interval and deduplicate the samples. These merged blocks are level-2 blocks. Subsequent compactions such as horizontal compaction can happen, further increasing the compaction level of the blocks.
1717

docs/proposals/ring-multikey.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ type MultiKey interface {
112112
```
113113

114114
* SplitById - responsible to split the codec in multiple keys and interface.
115-
* JoinIds - responsible to receive multiple keys and interface creating the codec objec
115+
* JoinIds - responsible to receive multiple keys and interface creating the codec object
116116
* GetChildFactory - Allow the kv store to know how to serialize and deserialize the interface returned by “SplitById”.
117117
The interface returned by SplitById need to be a proto.Message
118118
* FindDifference - optimization used to know what need to be updated or deleted from a codec. This avoids updating all keys every

integration/e2e/service.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -523,9 +523,9 @@ func (s *HTTPService) Metrics() (_ string, err error) {
523523
localPort := s.networkPortsContainerToLocal[s.httpPort]
524524

525525
// Fetch metrics.
526-
// We use IPv4 ports from Dokcer for e2e tests, so lt's use 127.0.0.1 to force IPv4; localhost may map to IPv6.
527-
// It's possible that same port number map to IPv4 for serviceA and IPv6 for servieB, so using localhost makes
528-
// tests flaky because you connect to serviceB while you want to connec to serviceA.
526+
// We use IPv4 ports from Docker for e2e tests, so let's use 127.0.0.1 to force IPv4; localhost may map to IPv6.
527+
// It's possible that same port number map to IPv4 for serviceA and IPv6 for serveB, so using localhost makes
528+
// tests flaky because you connect to serviceB while you want to connect to serviceA.
529529
res, err := GetRequest(fmt.Sprintf("http://127.0.0.1:%d/metrics", localPort))
530530
if err != nil {
531531
return "", err

0 commit comments

Comments
 (0)