Merge pull request #162 from prometheus/mr/getool-docs

Add changelog & documentation for #145
prometheus · Sep 1, 2021 · e1588d1 · e1588d1
2 parents 3b07e8a + 22e4447
commit e1588d1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 0.11.0 / Unreleased
+
+* [ENHANCEMENT] Add experimental tool for converting historical data ([#145](https://github.com/prometheus/graphite_exporter/pull/145))
+
+This release adds the `getool` binary to the release tarball.
+
 ## 0.10.1 / 2021-05-12
 
 No changes.

diff --git a/README.md b/README.md
@@ -146,6 +146,17 @@ docker run -d -p 9108:9108 -p 9109:9109 -p 9109:9109/udp \
         prom/graphite-exporter --graphite.mapping-config=/tmp/graphite_mapping.conf
 ```
 
+## Importing Whisper data
+
+**EXPERIMENTAL**
+
+Import data from Graphite using the bundled `getool`.
+See `getool create-blocks --help` for usage.
+
+To import long-term data in a reasonable amount of resources, increase the duration per generated TSDB block.
+The `--block-duration` must be a power of two in hours, e.g. `4h`, `8h`, and so on.
+
+To merge the data into an existing Prometheus storage directory, start Prometheus with the `--storage.tsdb.allow-overlapping-blocks` flag.
 
 [circleci]: https://circleci.com/gh/prometheus/graphite_exporter
 [hub]: https://hub.docker.com/r/prom/graphite-exporter/