Updating the readme and removing the parselogs specific one

Author: mattmendick

README.md

@@ -1,80 +1,113 @@
-# cortextool
+# Cortex Tools
 
-This tool is designed to interact with the various user facing APIs provided by Cortex, as well as, interact with various backend storage components containing Cortex data.
+This repo contains tools used for interacting with [Cortex](https://github.com/cortexproject/cortex).
 
-## Config Commands
+* [cortextool](#cortextool): Interacts with user-facing Cortex APIs and backend storage components
+* [chunktool](#chunktool): Interacts with chunks stored and indexed in Cortex storage backends.
+* [parselogs](#parselogs): Tool which parses Cortex query-frontend logs and formats them for easy analysis.
+
+## cortextool
+
+This tool is designed to interact with the various user-facing APIs provided by Cortex, as well as, interact with various backend storage components containing Cortex data.
+
+### Config Commands
 
 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.
 
-### Configuration
+#### Configuration
 
 | Env Variables     | Flag      | Description                                                                                                   |
 | ----------------- | --------- | ------------------------------------------------------------------------------------------------------------- |
 | CORTEX_ADDRESS    | `address` | Addess of the API of the desired Cortex cluster.                                                              |
 | CORTEX_API_KEY    | `key`     | In cases where the Cortex API is set behind a basic auth gateway, an key can be set as a basic auth password. |
 | CORTEX_TENANT_ID | `id`      | The tenant ID of the Cortex instance to interact with.                                                        |
 
-### Alertmanager
+#### Alertmanager
 
 The following commands are used by users to interact with their Cortex alertmanager configuration, as well as their alert template files.
 
-#### Alertmanager Get
+##### Alertmanager Get
 
     cortextool alertmanager get
 
-#### Alertmanager Load
+##### Alertmanager Load
 
     cortextool alertmanager load ./example_alertmanager_config.yaml
 
-### Rules
+#### Rules
 
 The following commands are used by users to interact with their Cortex ruler configuration. They can load prometheus rule files, as well as interact with individual rule groups.
 
-#### Rules List
+##### Rules List
 
 This command will retrieve all of the rule groups stored in the specified Cortex instance and print each one by rule group name and namespace to the terminal.
 
     cortextool rules list
 
-#### Rules Print
+##### Rules Print
 
 This command will retrieve all of the rule groups stored in the specified Cortex instance and print them to the terminal.
 
     cortextool rules print
 
-#### Rules Get
+##### Rules Get
 
 This command will retrieve the specified rule group from Cortex and print it to the terminal.
 
     cortextool rules get example_namespace example_rule_group
 
-#### Rules Delete
+##### Rules Delete
 
 This command will retrieve the specified rule group from Cortex and print it to the terminal.
 
     cortextool rules delete example_namespace example_rule_group
 
-#### Rules Load
+##### Rules Load
 
 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.
 
     cortextool rules load ./example_rules_one.yaml ./example_rules_two.yaml  ...
 
-# chunktool
+## chunktool
 
 This repo also contains the `chunktool`. A client meant to interact with chunks stored and indexed in cortex backends.
 
-### Chunk Delete
+#### Chunk Delete
 
 The delete command currently cleans all index entries pointing to chunks in the specified index. Only bigtable and the v10 schema are currently fully supported. This will not delete the entire index entry, only the corresponding chunk entries within the index row.
 
-### Chunk Migrate
+#### Chunk Migrate
 
 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.
 
 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.
 More details about it [here](./pkg/chunk/migrate/README.md)
 
-## License
+## parselogs
+
+A CLI tool to parse Cortex query-frontend logs and formats them for easy analysis.
+
+```
+Options:
+  -dur duration
+        only show queries which took longer than this duration, e.g. -dur 10s
+  -query
+        show the query
+  -utc
+        show timestamp in UTC time
+```
+
+Feed logs into it using `logcli` from Loki, `kubectl` from Kubernetes, `cat` from a file, or any other way to get raw logs:
+
+```
+$ cat query-frontend-logs.log | ./parselogs -dur 5s
+Timestamp                                TraceID           Length    Duration       Status  Path
+2020-05-26 13:51:15.0577354 -0400 EDT    76b9939fd5c78b8f  6h0m0s    10.249149614s  (200)   /api/prom/api/v1/query_range
+2020-05-26 13:52:15.771988849 -0400 EDT  2e7473ab10160630  10h33m0s  7.472855362s   (200)   /api/prom/api/v1/query_range
+2020-05-26 13:53:46.712563497 -0400 EDT  761f3221dcdd85de  10h33m0s  11.874296689s  (200)   /api/prom/api/v1/query_range
+```
+
+
+### License
 
 Licensed Apache 2.0, see [LICENSE](LICENSE).