Skip to content

Commit be4244a

Browse files
authored
Update README.md (#246)
1 parent db03c74 commit be4244a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This repo contains tools used for interacting with [Cortex](https://github.com/c
44

55
* [benchtool](docs/benchtool.md): A powerful YAML driven tool for benchmarking
66
Cortex write and query API.
7-
* [cortextool](#cortextool): Interacts with user-facing Cortex APIs and backend storage components
7+
* [cortextool](#cortextool): Interacts with user-facing Cortex APIs and backend storage components.
88
* [chunktool](#chunktool): Interacts with chunks stored and indexed in Cortex storage backends.
99
* [logtool](#logtool): Tool which parses Cortex query-frontend logs and formats them for easy analysis.
10-
* [e2ealerting](docs/e2ealerting.md): Tool that helps measure how long an alerts takes from scrape of sample to Alertmanager notifcation delivery.
10+
* [e2ealerting](docs/e2ealerting.md): Tool that helps measure how long an alert takes from scrape of sample to Alertmanager notification delivery.
1111

1212

1313
# Installation
@@ -32,7 +32,7 @@ This tool is designed to interact with the various user-facing APIs provided by
3232

3333
### Config Commands
3434

35-
Config commands interact with the Cortex api and read/create/update/delete user configs from Cortex. Specifically a users alertmanager and rule configs can be composed and updated using these commands.
35+
Config commands interact with the Cortex api and read/create/update/delete user configs from Cortex. Specifically, a user's alertmanager and rule configs can be composed and updated using these commands.
3636

3737
#### Configuration
3838

@@ -88,7 +88,7 @@ This command will delete the specified rule group from the specified namespace.
8888

8989
##### Rules Load
9090

91-
This command will load each rule group in the specified files and load them into Cortex. If a rule already exists in Cortex it will be overwritten if a diff is found.
91+
This command will load each rule group in the specified files and load them into Cortex. If a rule already exists in Cortex it will be overwritten, if a diff is found.
9292

9393
cortextool rules load ./example_rules_one.yaml ./example_rules_two.yaml ...
9494

@@ -106,7 +106,7 @@ This command prepares a rules file for upload to Cortex. It lints all your PromQ
106106

107107
There are two flags of note for this command:
108108
- `-i` which allows you to edit in place, otherwise a a new file with a `.output` extension is created with the results of the run.
109-
- `-l` which allows you specify the label you want you add for your aggregations, it is `cluster` by default.
109+
- `-l` which allows you to specify the label you want to add for your aggregations, which is `cluster` by default.
110110

111111
At the end of the run, the command tells you whenever the operation was a success in the form of
112112

@@ -123,7 +123,7 @@ This commands checks rules against the recommended [best practices](https://prom
123123

124124
#### Remote Read
125125

126-
Cortex exposes a [Remote Read API] which allows access to the stored series. The `remote-read` subcommand of `cortextool` allows to interact with its API, to find out which series are stored.
126+
Cortex exposes a [Remote Read API] which allows access to the stored series. The `remote-read` subcommand of `cortextool` allows interacting with its API, to find out which series are stored.
127127

128128
[Remote Read API]: https://prometheus.io/docs/prometheus/latest/storage/#remote-storage-integrations
129129

@@ -178,7 +178,7 @@ prometheus --storage.tsdb.path ./local-tsdb --config.file=<(echo "")
178178

179179
#### Overrides Exporter
180180

181-
The Overrides Exporter allows to continuously export [per tenant configuration overrides][runtime-config] as metrics. Optionally it can also export a presets file (cf. example [override config file] and [presets file]).
181+
The Overrides Exporter allows to continuously export [per tenant configuration overrides][runtime-config] as metrics. It can also, optionally, export a presets file (cf. example [override config file] and [presets file]).
182182

183183
cortextool overrides-exporter --overrides-file overrides.yaml --presets-file presets.yaml
184184

@@ -387,7 +387,7 @@ The delete command currently cleans all index entries pointing to chunks in the
387387

388388
The migrate command helps with migrating chunks across cortex clusters. It also takes care of setting right index in the new cluster as per the specified schema config.
389389

390-
As of now it only supports `Bigtable` or `GCS` as a source to read chunks from for migration while for writing it supports all the storages that Cortex supports.
390+
As of now it only supports `Bigtable` or `GCS` as a source to read chunks from for migration. For writing it supports all the storages that Cortex supports.
391391
More details about it [here](./pkg/chunk/migrate/README.md)
392392

393393
##### Chunk Validate/Clean-Index

0 commit comments

Comments
 (0)