Commit Graph

112 Commits

Author SHA1 Message Date
Adil Houmadi cc00dffade
MINOR: Fix typo in MirrorMaker v2 documentation (#10433)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2021-04-01 16:08:28 +01:00
Bruno Cadonna 58d4e527d0
MINOR: Fix docs for end-to-end record latency metrics (#10449)
Reviewers: Anna Sophie Blee-Goldman <ableegoldman@apache.org>
2021-03-31 11:02:16 -07:00
A. Sophie Blee-Goldman 5c22e03e9e
MINOR: add missing docs for record-e2e-latency metrics (#10251)
Need to add missing docs for the record-e2e-latency metrics, and new TRACE recording level

Reviewers: Walker Carlson <wcarlson@confluent.io>
2021-03-04 14:42:56 -08:00
Michael G. Noll 1fd75bf1ed
KAFKA-12393: Document multi-tenancy considerations (#334) (#10263)
KAFKA-12393: Document multi-tenancy considerations
Addressed review feedback by @dajac and @rajinisivaram
Ported from apache/kafka-site#334

Reviewers: Bill Bejeck <bbejeck@apache.org>
2021-03-04 10:47:48 -05:00
Lee Dongjin ea005cc700
KAFKA-12407: Document Controller Health Metrics (#10257)
Reviewers: Luke Chen <showuon@gmail.com>, Dong Lin <lindong28@gmail.com>
2021-03-04 22:24:50 +08:00
Luke Chen 5a9435afd1
KAFKA-12350: Correct the default value in doc (#10165)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2021-02-25 01:52:34 +08:00
leah 8bdfc5770d
MINOR: adding docs for failed stream thread metric (#9974)
Add docs for KIP-663.

Reviewers: Jim Galasyn <jim.galasyn@confluent.io>, Walker Carlson <wcarlson@confluent.io>, Matthias J. Sax <matthias@confluent.io>
2021-02-02 10:12:22 -08:00
Michael G. Noll f4983f4172
KAFKA-8930: MirrorMaker v2 documentation (#324) (#9983)
This adds a new user-facing documentation "Geo-replication (Cross-Cluster Data Mirroring)" section to the Kafka Operations documentation that covers MirrorMaker v2.

Was already merged to kafka-site via apache/kafka-site#324.
Reviewers: Bill Bejeck <bbejeck@apache.org>
2021-01-27 11:51:34 -05:00
Bruno Cadonna add160d522
KAFKA-9924: Add docs for RocksDB properties-based metrics (#9895)
Document the new properties-based metrics for RocksDB

Reviewers: Leah Thomas <lthomas@confluent.io>, Anna Sophie Blee-Goldman <ableegoldman@apache.org>
2021-01-19 13:30:23 -08:00
Luke Chen 3717ab0ff2
KAFKA-10776: Add version attribute in RequestsPerSec metrics documentation (#9661)
See https://cwiki.apache.org/confluence/display/KAFKA/KIP-272%3A+Add+API+version+tag+to+broker%27s+RequestsPerSec+metric

Reviewers: Ismael Juma <ismael@juma.me.uk>
2020-12-15 06:39:07 -08:00
James Cheng 16eb1f5cd1
KAFKA-10473: Add docs on partition size-on-disk, and other log-related metrics (#9276)
kafka.log,type=Log,name=Size
kafka.log,type=Log,name=NumLogSegments
kafka.log,type=Log,name=LogStartOffset
kafka.log,type=Log,name=LogEndOffset

Reviewers: Guozhang Wang <wangguoz@gmail.com>
2020-12-03 11:18:12 -08:00
Bill Bejeck b4f00d7ef6
KAFKA-10679: Migrate upgrade changes from site to kafka/docs (#9551)
During the AK website upgrade, changes made to kafka-site weren't migrated back to kafka-docs.

This PR is an initial attempt at porting the changes to kafka/docs, but it does not include the streams changes. Those will come in a separate PR.

For the most part, the bulk of the changes in the PR are cosmetic. Only the introduction.html has substantial changes, but it's a direct port from the live documentation.

For testing:

I reviewed the PR diffs
Rendered the changes locally

Reviewers: Matthias J. Sax <mjsax@apache.org>
2020-11-03 13:40:44 -05:00
Ankit Kumar e98b38cb1e
KAFKA-8360: Docs do not mention RequestQueueSize JMX metric (#9325)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Viktor Somogyi-Vass <viktorsomogyi@gmail.com>

Co-authored-by: akumar <akumar@cloudera.com>
2020-09-29 10:32:17 +02:00
Ismael Juma 6004ee9f22
MINOR: Recommend Java 11 (#9080)
Java 11 has been recommended for a while, but the ops section had not been updated.
Also added `-XX:+ExplicitGCInvokesConcurrent` which has been in `kafka-run-class`
for a while. Finally, tweaked the text slightly to read better.

Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>
2020-07-26 12:25:30 -07:00
showuon 3ec5e8e652
MINOR: Small fixes in the documentation (#8623)
These minor documentation fixes included: 

1. fix broken links
2. remove redundant sentences
3. fix content format issue

Reviewers: Konstantine Karantasis <konstantine@confluent.io>
2020-05-19 07:31:06 -07:00
Viktor Somogyi 74fdbc42dd
KAFKA-8835; KIP-352 docs update (#7434)
Doc updates for KIP-352.

Reviewers: Stanislav Kozlovski <stanislav_kozlovski@outlook.com>, Jason Gustafson <jason@confluent.io>
2020-04-30 08:36:01 -07:00
showuon e4e28883d4
MINOR: Fix typo and rephrase content in ops docs (#8581)
1. fix typo: `atleast` -> `at least`
2. add missing `--` from `--bootstrap-servers` argument to be consistent
3. rephrase a sentence, to make it more clear:

before: `LinkedIn is currently running JDK 1.8 u5 (looking to upgrade to a newer version) with the G1 collector`

It will misguide the users to use JDK 1.8 u5, while the JDK 1.8 u251 is already released, which will include many important bug fixes. I did some rephrase as below:

after: `At the time this is written, LinkedIn is running JDK 1.8 u5 (looking to upgrade to a newer version) with the G1 collector`

Reviewers: Konstantine Karantasis <konstantine@confluent.io>
2020-04-29 23:06:21 -07:00
showuon 417d9b1801
MINOR: Fix broken JMX link in docs by adding missing starting double quote (#8587)
The href attribute missed the starting double quote, so the hyperlink is interpreted as https://docs.oracle.com/.../agent.html", with a redundant tailing double quote. 

Add the missing starting double quote back to fix this issue.

Reviewers: Konstantine Karantasis <konstantine@confluent.io>
2020-04-29 20:25:33 -07:00
showuon a91b06708b
KAFKA-9863: replace the deprecated --zookeeper options in the documentation (#8482)
Reviewers: Ron Dagostino <rdagostino@confluent.io>, Colin P. McCabe <cmccabe@apache.org>
2020-04-22 13:42:35 -07:00
Agam Brahma 24d05aa601
KAFKA-9553; Improve measurement for loading groups and transactions (#8155)
This patch modifies the loading time metric to account for time spent waiting for the loading time task to be scheduled.

Reviewers: Jason Gustafson <jason@confluent.io>
2020-03-19 23:35:16 -07:00
Lee Dongjin 75268cb8e9 KAFKA-9327: Document GroupMetadata metrics
This commit adds documentation on following `GroupMetadata` gauges:

- `NumOffsets`
- `NumGroups`
- `NumGroupsPreparingRebalance`
- `NumGroupsCompletingRebalance`
- `NumGroupsEmpty`
- `NumGroupsStable`
- `NumGroupsDead`

cc/ gwenshap

Author: Lee Dongjin <dongjin@apache.org>

Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>

Closes #7890 from dongjinleekr/feature/KAFKA-9327
2020-03-02 12:14:51 +05:30
Bruno Cadonna d2c42125aa
Adapt docs about metrics of Streams according to KIP-444 (#8171)
Adapts the docs about metrics of Streams according to https://cwiki.apache.org/confluence/display/KAFKA/KIP-444%253A+Augment+metrics+for+Kafka+Streams

Reviewers: Boyang Chen <boyang@confluent.io>, Guozhang Wang <wangguoz@gmail.com>
2020-02-27 09:48:53 -08:00
Lee Dongjin b28aa4ece6 KAFKA-9586: Fix errored json filename in ops documentation
This PR is the counterpart of apache/kafka-site#253.

cc/ omkreddy

Author: Lee Dongjin <dongjin@apache.org>

Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>

Closes #8149 from dongjinleekr/feature/KAFKA-9586
2020-02-21 18:49:11 +05:30
Alice ff50f28794 MINOR: fix docs around leader rebalancing to reflect default of true (#7614)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2019-11-10 18:15:44 +00:00
Mickael Maison e4262471c9 MINOR: Fix command examples in kafka-reassign-partitions.sh docs (#7583)
Reviewers: Jason Gustafson <jason@confluent.io>
2019-10-26 13:16:26 -07:00
Guozhang Wang eac367c76a
MINOR: Add metrics in operations doc for KIP-429 / KIP-467 (#7527)
Reviewers: Tu V. Tran <tu@confluent.io>, A. Sophie Blee-Goldman <sophie@confluent.io>, Matthias J. Sax <matthias@confluent.io>
2019-10-18 17:32:03 -07:00
Kevin Lu ed078bd702 KAFKA-8874: Add consumer metrics to observe user poll behavior (KIP-517)
https://cwiki.apache.org/confluence/display/KAFKA/KIP-517%3A+Add+consumer+metrics+to+observe+user+poll+behavior

Author: Kevin Lu <kelu@paypal.com>

Reviewers: Sriharsha Chintalapani <sriharsha@apache.org>, Jason Gustafson <jason@confluent.io>

Closes #7395 from KevinLiLu/KIP517-KAFKA8874
2019-10-17 14:46:42 +05:30
Bruno Cadonna e58401b2f0 KAFKA-9030: Document client-level (a.k.a. instance-level) metrics (#7501)
Reviewers: A. Sophie Blee-Goldman <sophie@confluent.io>, Matthias J. Sax <matthias@confluent.io>
2019-10-15 14:30:16 -07:00
Bruno Cadonna 9c80a06466 KAFKA-8942: Document RocksDB metrics
Author: Bruno Cadonna <bruno@confluent.io>

Reviewers: Guozhang Wang <wangguoz@gmail.com>

Closes #7490 from cadonna/AK8942-docs-rocksdb_metrics

Minor comments
2019-10-15 11:13:43 -07:00
David Arthur c1f2b0ffb8 KAFKA-8753; Expose controller topic deletion metrics (KIP-503) (#7156)
This is the implementation for [KIP-503](https://cwiki.apache.org/confluence/display/KAFKA/KIP-503%3A+Add+metric+for+number+of+topics+marked+for+deletion)

When deleting a large number of topics, the Controller can get quite bogged down. One problem with this is the lack of visibility into the progress of the Controller. We can look into the ZK path for topics marked for deletion, but in a production environment this is inconvenient. This PR adds a JMX metric `kafka.controller:type=KafkaController,name=TopicsToDeleteCount` to make it easier to see how many topics are being deleted.

Reviewers: Stanislav Kozlovski <stanislav@confluent.io>, Jun Rao <junrao@gmail.com>, Jason Gustafson <jason@confluent.io>
2019-08-23 13:22:41 -07:00
anatasiavela 0b1dc1ca7b KAFKA-6263; Expose metrics for group and transaction metadata loading duration
[JIRA](https://issues.apache.org/jira/browse/KAFKA-6263)

- Add metrics to provide visibility for how long group metadata and transaction metadata take to load in order to understand some inactivity seen in the consumer groups
- Tests include mocking load times by creating a delay after each are loaded and ensuring the measured JMX metric is as it should be

Author: anatasiavela <anastasiavela@berkeley.edu>

Reviewers: Gwen Shapira, Jason Gustafson

Closes #7045 from anatasiavela/KAFKA-6263
2019-08-03 21:00:46 -07:00
Ismael Juma 22d4ccd8ac
MINOR: Update docs to reflect the ZK 3.5.5 upgrade (#7149)
Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>
2019-08-02 06:09:51 -07:00
opera443399 96096cebe1 MINOR: docs typo in '--zookeeper myhost:2181--execute'
this PR will fix a typo related to docs:
http://kafka.apache.org/21/documentation.html#rep-throttle

```bash
$ bin/kafka-reassign-partitions.sh --zookeeper myhost:2181--execute --reassignment-json-file bigger-cluster.json —throttle 50000000
```

I think `myhost:2181` should be `localhost:2181` and followed by a `space`

Author: opera443399 <pc@pcswo.com>

Reviewers: Gwen Shapira

Closes #6704 from opera443399/docs-ops-typo
2019-05-09 22:16:13 -07:00
Rajini Sivaram 950cfe3e70 MINOR: Add security considerations for remote JMX in Kafka docs (#6544)
Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>
2019-04-10 12:39:11 +05:30
Kevin Lu 31d191fc85 KAFKA-7904; Add AtMinIsr partition metric and TopicCommand option (KIP-427)
- Add `AtMinIsrPartitionCount` metric to `ReplicaManager`
- Add `AtMinIsr` metric to `Partition`
- Add `--at-min-isr-partitions` describe `TopicCommand` option

https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=103089398

Author: Kevin Lu <lu.kevin@berkeley.edu>
Author: lu.kevin@berkeley.edu <kelu@paypal.com>

Reviewers: Gwen Shapira

Closes #6421 from KevinLiLu/KAFKA-7904
2019-04-05 09:14:41 -07:00
A. Sophie Blee-Goldman ff603c63bb KAFKA-4730: Streams does not have an in-memory windowed store (#6239)
Implemented an in-memory window store allowing for range queries. A finite retention period defines how long records will be kept, ie the window of time for fetching, and the grace period defines the window within which late-arriving data may still be written to the store.

Unit tests were written to test the functionality of the window store, including its insert/update/delete and fetch operations. Single-record, all records, and range fetch were tested, for both time ranges and key ranges. The logging and metrics for late-arriving (dropped)records were tested as well as the ability to restore from a changelog.

Reviewers: John Roesler <john@confluent.io>, Matthias J. Sax <matthias@confluent.io>, Bill Bejeck <bill@confluent.io>, Guozhang Wang <wangguoz@gmail.com>
2019-02-20 19:09:50 -08:00
lambdaliu 826b6d9424 MINOR: fix docs of common per-broker metrics
Author: lambdaliu <lambdaliu@tencent.com>

Reviewers: Manikumar Reddy <manikumar.reddy@gmail.com>

Closes #6212 from lambdaliu/fix_metrics_error
2019-02-13 11:45:59 +05:30
Viktor Somogyi-Vass 776041db11 KAFKA-7804: Update docs for topic-command related KIP-377
This PR adds a upgrade notes and changes examples to use the bootstrap-server.

Author: Viktor Somogyi-Vass <viktorsomogyi@gmail.com>

Reviewers: Srinivas <srinivas96alluri@gmail.com>, Manikumar Reddy <manikumar.reddy@gmail.com>

Closes #6118 from viktorsomogyi/topiccommand-adminclient-doc
2019-02-04 13:46:33 -08:00
John Roesler fdd33bcab0 KAFKA-7223: document suppression buffer metrics (#6024)
Document the new metrics added in #5795

Reviewers: Bill Bejeck <bill@confluent.io>, Guozhang Wang <wangguoz@gmail.com>
2018-12-12 18:22:54 -08:00
lu.kevin@berkeley.edu e869d8f7b4 MINOR: Improve docs by adding ToC links to Monitoring
My top 2 reasons for visiting the Kafka docs are to:
- View configurations
- View metrics

This PR aims to improve the user experience for viewing metrics:
- Add href links to the `Monitoring` section of the Table of Contents so users do not need to scroll or Ctrl/Cmd-F to find specific metric details (Monitoring section has grown large as more component & metrics are added)

Author: lu.kevin@berkeley.edu <kelu@paypal.com>

Reviewers: Viktor Somogyi <viktorsomogyi@gmail.com>, Manikumar Reddy <manikumar.reddy@gmail.com>

Closes #5511 from KevinLiLu/feature/minor-improve-docs
2018-11-28 12:13:26 +05:30
Ron Dagostino e8a3bc7425 KAFKA-7352; Allow SASL Connections to Periodically Re-Authenticate (KIP-368) (#5582)
KIP-368 implementation to enable periodic re-authentication of SASL clients. Also adds a broker configuration option to terminate client connections that do not re-authenticate within the configured interval.
2018-10-26 23:18:15 +01:00
John Roesler 4b7148a5b6 KAFKA-7223: Suppression documentation (#5787)
Reviewers: Matthias J. Sax <matthias@confluent.io>, Bill Bejeck <bill@confluent.io>
2018-10-15 21:04:01 -07:00
Alex Dunayevsky bf0675ac5f KAFKA-6343 Documentation update in OS-level tuning section: add vm.ma… (#4358)
Reviewers: Manikumar Reddy O <manikumar.reddy@gmail.com>, Ismael Juma <ismael@juma.me.uk>, Jun Rao <junrao@gmail.com>
2018-08-22 10:13:10 -07:00
Manikumar Reddy O 49c5994dd9 KAFKA-7063; Remove references to old producers and consumers in docs (#5240)
Reviewers: Vahid Hashemian <vahidhashemian@us.ibm.com>, Ismael Juma <ismael@juma.me.uk>, Jason Gustafson <jason@confluent.io>
2018-08-21 14:02:14 -07:00
Mayank Tankhiwale da35cd5114 KAFKA-6312; Document --reset-offsets option for consumer group tool (#4527)
KIP-122 added the ability for kafka-consumer-groups.sh to reset/change consumer offsets, at a fine grained level. This patch adds documentation for this feature.

Reviewers: Manikumar Reddy O <manikumar.reddy@gmail.com>, Jason Gustafson <jason@confluent.io>
2018-08-20 13:27:44 -07:00
Kevin Lu fb8eba3d33 KAFKA-7207: Make rate & total metrics documentation consistent (#5429)
Some sections of the Monitoring metrics documentation list out the -total metrics, and some sections do not list them out. Make them consistent and list out the missing -total metrics.
2018-08-07 08:49:57 +01:00
Guozhang Wang 6bfaf4dc60
MINOR: Store metrics scope, total metrics (#5290)
1. Rename metrics scope of rocksDB window and session stores; also modify the store metrics accordingly with guidance on its correlations to metricsScope.

2. Add the missing total metrics for per-thread, per-task, per-node and per-store sensors.


Reviewers: John Roesler <john@confluent.io>, Bill Bejeck <bill@confluent.io>, Matthias J. Sax <matthias@confluent.io>
2018-06-28 14:32:02 -07:00
Ismael Juma e70a191d30
KAFKA-4423: Drop support for Java 7 (KIP-118) and update deps (#5046)
* Set --source, --target and --release to 1.8.
* Build Scala 2.12 by default.
* Remove some conditionals in the build file now that Java 8
is the minimum version.
* Bump the version of Jetty, Jersey and Checkstyle (the newer
versions require Java 8).
* Fixed issues uncovered by the new version if Checkstyle.
* A couple of minor updates to handle an incompatible source
change in the new version of Jetty.
* Add dependency to jersey-hk2 to fix failing tests caused
by Jersey upgrade.
* Update release script to use Java 8 and to take into account
that Scala 2.12 is now built by default.
* While we're at it, bump the version of Gradle, Gradle plugins,
ScalaLogging, JMH and apache directory api.
* Minor documentation updates including the readme and upgrade
notes. A number of Streams Java 7 examples can be removed
subsequently.
2018-05-21 23:17:42 -07:00
John Roesler 12a0f46895 KAFKA-6376: Document skipped records metrics changes (#4922)
Reviewers: Bill Bejeck <bill@confluent.io>, Guozhang Wang <wangguoz@gmail.com>
2018-04-24 15:40:16 -07:00
wushujames 75df8cc77a MINOR: Add docs for ReplicationBytesInPerSec and ReplicationBytesOutPerSec (#4595)
Add docs for the ReplicationBytesInPerSec and ReplicationBytesOutPerSec metrics. These metrics were introduced in KIP-153 (KAFKA-5194) but the docs were not updated.

Built site-docs, and viewed them in a web browser to confirm.

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Ismael Juma <ismael@juma.me.uk>
2018-02-20 13:53:49 -08:00