Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

Commit d91671b

Browse files
committed
update kafka docs
1 parent f549b3a commit d91671b

File tree

4 files changed

+17
-18
lines changed

4 files changed

+17
-18
lines changed

docs/installation-deb.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ We'll go over these in more detail below.
88
See [Cassandra](https://github.com/grafana/metrictank/blob/master/docs/cassandra.md)
99
* The latest (1.0.1 or newer) version of [Graphite](http://graphite.readthedocs.io/en/latest/install.html)
1010
* Optional: [statsd](https://github.com/etsy/statsd) or something compatible with it. For instrumentation of graphite.
11-
* Optional: Kafka, if you want to buffer data in case metrictank goes down. Kafka 0.10.0.1 is highly recommended.
11+
* Optional: Kafka, if you want to buffer data in case metrictank goes down. Kafka 2.0.0 is highly recommended.
1212
[more info](https://github.com/grafana/metrictank/blob/master/docs/kafka.md)
1313

1414
Note: Cassandra and Kafka require Java, which will be automatically installed by apt as a dependency when we install Cassandra.
1515

1616
## How things fit together
1717

1818
metrictank ingest metrics data. The data can be sent into it, or be read from a queue (see
19-
[Inputs](https://github.com/grafana/metrictank/blob/master/docs/inputs.md)).
19+
[Inputs](https://github.com/grafana/metrictank/blob/master/docs/inputs.md)).
2020
Metrictank will compress the data into chunks in RAM, a configurable number of the most recent data
2121
is kept in RAM, but the chunks are being saved to Cassandra as well. You can use a single Cassandra
2222
instance or a cluster. Metrictank will also respond to queries: if the data is recent, it'll come out of
2323
RAM, and older data is fetched from cassandra. This happens transparantly.
24-
Metrictank maintains an index of metrics metadata, for all series it sees.
24+
Metrictank maintains an index of metrics metadata, for all series it sees.
2525
You can use an index entirely in memory, or backed by Cassandra for persistence.
2626
You can query metrictank directly (it has fast, but limited built-in processing and will fallback to graphite when needed)
2727
or you can also just query graphite which will always use graphite's processing but use metrictank as a datastore.
@@ -215,16 +215,16 @@ EOF
215215

216216
### Kafka
217217

218-
Kafka 0.10.0.1 is highly recommended. 0.10.0.0 and 0.9 should work too, with some caveats [explained here](https://github.com/grafana/metrictank/blob/master/docs/kafka.md)
218+
Kafka 2.0.0 is highly recommended, though older versions work too. [more info](https://github.com/grafana/metrictank/blob/master/docs/kafka.md)
219219

220-
* Download kafka. Find a mirror at https://www.apache.org/dyn/closer.cgi?path=/kafka/0.10.0.1/kafka_2.11-0.10.0.1.tgz, and download kafka to your server.
220+
* Download kafka. Find a mirror at https://archive.apache.org/dist/kafka/2.0.0/kafka_2.12-2.0.0.tgz, and download kafka to your server.
221221

222222
* Unpack kafka. Like zookeeper, we'll do so in `/opt`.
223223

224224
```
225225
cd /opt
226-
tar -zxvf /root/kafka_2.11-0.10.0.1.tgz # update path if you downloaded elsewhere
227-
ln -s /opt/kafka_2.11-0.10.0.1 /opt/kafka
226+
tar -zxvf /root/kafka_2.12-2.0.0.tgz # update path if you downloaded elsewhere
227+
ln -s /opt/kafka_2.12-2.0.0 /opt/kafka
228228
```
229229

230230
* Start kafka: `/opt/kafka/bin/kafka-server-start.sh -daemon /opt/kafka/config/server.properties`

docs/installation-rpm.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ We'll go over these in more detail below.
88
See [Cassandra](https://github.com/grafana/metrictank/blob/master/docs/cassandra.md)
99
* The latest (1.0.1 or newer) version of [Graphite](http://graphite.readthedocs.io/en/latest/install.html)
1010
* Optional: [statsd](https://github.com/etsy/statsd) or something compatible with it. For instrumentation of graphite.
11-
* Optional: Kafka, if you want to buffer data in case metrictank goes down. Kafka 0.10.0.1 is highly recommended.
11+
* Optional: Kafka, if you want to buffer data in case metrictank goes down. Kafka 2.0.0 is highly recommended.
1212
[more info](https://github.com/grafana/metrictank/blob/master/docs/kafka.md)
1313

1414
Note: Cassandra and Kafka require Java. We recommend using Oracle Java 8.
1515

1616
## How things fit together
1717

1818
metrictank ingest metrics data. The data can be sent into it, or be read from a queue (see
19-
[Inputs](https://github.com/grafana/metrictank/blob/master/docs/inputs.md)).
19+
[Inputs](https://github.com/grafana/metrictank/blob/master/docs/inputs.md)).
2020
Metrictank will compress the data into chunks in RAM, a configurable number of the most recent data
2121
is kept in RAM, but the chunks are being saved to Cassandra as well. You can use a single Cassandra
2222
instance or a cluster. Metrictank will also respond to queries: if the data is recent, it'll come out of
2323
RAM, and older data is fetched from cassandra. This happens transparantly.
24-
Metrictank maintains an index of metrics metadata, for all series it sees.
24+
Metrictank maintains an index of metrics metadata, for all series it sees.
2525
You can use an index entirely in memory, or backed by Cassandra for persistence.
2626
You can query metrictank directly (it has fast, but limited built-in processing and will fallback to graphite when needed)
2727
or you can also just query graphite which will always use graphite's processing but use metrictank as a datastore.
@@ -221,16 +221,16 @@ EOF
221221

222222
### Kafka
223223

224-
Kafka 0.10.0.1 is highly recommended. 0.10.0.0 and 0.9 should work too, with some caveats [explained here](https://github.com/grafana/metrictank/blob/master/docs/kafka.md)
224+
Kafka 2.0.0 is highly recommended, though older versions work too. [more info](https://github.com/grafana/metrictank/blob/master/docs/kafka.md)
225225

226-
* Download kafka. Find a mirror at https://www.apache.org/dyn/closer.cgi?path=/kafka/0.10.0.1/kafka_2.11-0.10.0.1.tgz, and download kafka to your server.
226+
* Download kafka. Find a mirror at https://archive.apache.org/dist/kafka/2.0.0/kafka_2.12-2.0.0.tgz, and download kafka to your server.
227227

228228
* Unpack kafka. Like zookeeper, we'll do so in `/opt`.
229229

230230
```
231231
cd /opt
232-
tar -zxvf /root/kafka_2.11-0.10.0.1.tgz # update path if you downloaded elsewhere
233-
ln -s /opt/kafka_2.11-0.10.0.1 /opt/kafka
232+
tar -zxvf /root/kafka_2.12-2.0.0.tgz # update path if you downloaded elsewhere
233+
ln -s /opt/kafka_2.12-2.0.0 /opt/kafka
234234
```
235235

236236
* Start kafka: `/opt/kafka/bin/kafka-server-start.sh -daemon /opt/kafka/config/server.properties`

docs/kafka.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ Kafka can be used as an [ingestion option](https://github.com/grafana/metrictank
44

55
# Kafka version
66

7-
We recommend 0.10.0.1 or higher.
7+
Kafka v2.0.0 or newer is recommended.
8+
Older versions should still work
89

910
If you use 0.10.0.0 and want snappy compression, watch out for [kafka-3789](https://issues.apache.org/jira/browse/KAFKA-3789) as you'll need to do a hack [like this](https://github.com/raintank/raintank-docker/commit/e98883b08f343d896a3333801f16c7a603e89422)
10-
11-
0.9 should work too (we used to use it), but we don't support it.

docs/tools.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ Flags:
354354
-enabled
355355
356356
-kafka-version string
357-
Kafka version in semver format. All brokers must be this version or newer. (default "0.10.0.0")
357+
Kafka version in semver format. All brokers must be this version or newer. (default "2.0.0")
358358
-offset string
359359
Set the offset to start consuming from. Can be oldest, newest or a time duration (default "newest")
360360
-partitions string

0 commit comments

Comments
 (0)