Commit Graph

227 Commits

Author SHA1 Message Date
Nancy 25b955ddf2
Kafka 16887 : Upgrade the document to add remote copy/fetch quotas metrics values. (#16863)
Reviewers: Abhijeet Kumar<abhijeet.cse.kgp@gmail.com>, Luke Chen <showuon@gmail.com>, Satish Duggana <satishd@apache.org>
2024-08-13 12:29:22 +05:30
Igor Soarez 8c066e625c
MINOR: Update docs, remove JBOD from missing features (#16801)
Reviewers: Josep Prat <josep.prat@aiven.io>
2024-08-06 11:18:14 +01:00
David Arthur b3fd9a5a95
KAFKA-17146 Include note to remove migration znode (#16770)
When reverting the ZK migration, we must also remove the /migration ZNode in order to allow the migration to be re-attempted in the future.

Reviewers: Colin P. McCabe <cmccabe@apache.org>, Chia-Ping Tsai <chia7712@gmail.com>
2024-08-05 03:13:26 +08:00
TingIāu "Ting" Kì baa0fc9722
KAFKA-17042 The migration docs should remind users to set "broker.id.generation.enable" when adding broker.id (#16491)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia771@gmail.com>
2024-07-05 18:21:40 +08:00
Lucas Brutschy 7ab7773617
MINOR: Update 3.8 documentation for Kafka Streams (#16265)
All public interface changes should be briefly mentioned in the
upgrade guide.

Reviewers: Matthias J. Sax <matthias@confluent.io>, Anna Sophie Blee-Goldman <sophie@responsive.dev>, Nick Telford <nick.telford@gmail.com>
2024-06-26 13:55:18 +02:00
Mickael Maison 2b491f9611
MINOR: Add docs for replica.alter.log.dirs.io.max.bytes.per.second config (#16386)
Reviewers: Luke Chen <showuon@gmail.com>
2024-06-19 11:19:59 +02:00
Mickael Maison c4a3d2475f
MINOR: Refresh of the docs (#16375)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-06-18 17:15:47 +02:00
Matthias J. Sax f80deeabbc
MINOR: update Kafka Streams docs with 3.4 KIP information (#16336)
Reviewers: Jim Galasyn <jim.galasyn@confluent.io>, Bill Bejeck <bill@confluent.io>
2024-06-14 15:01:35 -07:00
Matthias J. Sax 92614699e6
MINOR: update Kafka Streams docs with 3.3 KIP information (#16316)
Reviewers: Lucas Brutschy <lbrutschy@confluent.io>, Jim Galasyn <jim.galasyn@confluent.io>
2024-06-13 15:17:00 -07:00
Maciej Moscicki 53841625fc
MINOR: Add fast_commit ext4 config to ops docs (#15496)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
Co-authored-by: Piotr Rzysko <piotr.rzysko@allegro.com>
2024-06-10 12:49:21 +02:00
Sebastien Viale 871b1db044
MINOR: update all-latency-max, range-latency-avg|max and add prefix-scan documentation (#16182)
Reviewers: Matthias J. Sax <matthias@confluent.io>
2024-06-07 14:23:29 -07:00
Sebastien Viale f8ad9ee892
MINOR: update all-latency-avg documentation (#16148)
Change description: from iterator create to close time.

Reviewers: Matthias J. Sax <matthias@confluent.io>
2024-05-31 12:24:01 -07:00
Igor Soarez 269b457d30
MINOR: Add missing docs for migration metrics (#15718)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2024-04-16 16:20:52 +02:00
Igor Soarez 31171d0791
MINOR: Document JBOD limitation during migration (#15692)
Document JBOD limitation during migration when log dir failure.

Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-04-12 14:50:09 +08:00
John Yu cfa7d39360
MINOR : Removed the depreciated information about Zk to Kraft migration. (#15552)
Reviewers: Luke Chen <showuon@gmail.com>, Chia-Ping Tsai <chia7712@gmail.com>
2024-03-21 10:57:59 +08:00
PoAn Yang 1bb36c2bc1
MINOR: change "inter.broker.protocol version" to inter.broker.protocol.version (#15504)
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-03-10 03:28:06 +08:00
Owen Leung 3f3cee1b21
KAFKA-16325 Add missing producer metrics to documentatio (#15466)
Add `buffer-exhausted-rate`, `buffer-exhausted-total`, `bufferpool-wait-ratio` and `metadata-wait-time-ns-total`

Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
2024-03-08 07:07:21 +08:00
Stanislav Kozlovski a512ef1478
MINOR: Add 3.7 JBOD KRaft Early Acces disclaimer (#15418)
This patch adds a small disclaimer to the ops documentation page to mention that JBOD is in early access with 3.7
2024-02-22 23:55:19 +01:00
Paolo Patierno 9118ad653f
Additional fix on the rollback migration documentation (#15317)
This is an additional PR to fix rollback migration documentation related to #15287

Reviewers: Luke Chen <showuon@gmail.com>
2024-02-21 17:43:05 +08:00
Paolo Patierno ddc5d1dc34
MINOR: Added ACLs authorizer change during migration (#15333)
This trivial PR makes clear when it's the right time to switch from AclAuthorizer to StandardAuthorizer during the migration process.

Reviewers: Luke Chen <showuon@gmail.com>
2024-02-16 18:57:22 +08:00
Luke Chen 501f82b91c
KAFKA-15670: add "inter.broker.listener.name" config in KRaft controller config (#14631)
During ZK migrating to KRaft, before entering dual-write mode, the KRaft controller will send RPCs (i.e. UpdateMetadataRequest, LeaderAndIsrRequest, and StopReplicaRequest) to the brokers. Currently, we use the inter broker listener to send the RPC to brokers from the controller. But in the doc, we didn't provide this info to users because the normal KRaft controller won't use inter.broker.listener.names.

This PR adds the missing config in the ZK migrating to KRaft doc.

Reviewers: Mickael Maison <mickael.maison@gmail.com>, Paolo Patierno <ppatierno@live.com>
2024-02-16 18:56:06 +08:00
Colin P. McCabe b8ad609541 Revert "KAFKA-16101: Additional fixes on KRaft migration documentation (#15287)"
This reverts commit 46d76269fa.
2024-02-01 16:17:18 -08:00
Paolo Patierno 46d76269fa
KAFKA-16101: Additional fixes on KRaft migration documentation (#15287)
This PR fixes a couple of things related to the #15193 PR.

When you complete "Enter Migration Mode on the brokers", we are actually in "Enabling the migration on the brokers" referring to the migration guide and the broker doesn't really have node.id yet but still broker.id, so the PR removes a statement saying to replace the one with the other.

Also, during rollback it's not enough just deleting the /controller znode quickly after shutting down controllers because the controller election doesn't start yet until at least one broker is rolled back with the right configuration. Until the rolling and when controllers are down, the brokers just log something like this even if you deleted the znode "quickly":

[2024-01-30 09:27:52,394] DEBUG [zk-broker-0-to-controller-quorum-channel-manager]: Controller isn't cached, looking for local metadata changes (kafka.server.BrokerToControllerRequestThread)
[2024-01-30 09:27:52,394] INFO [zk-broker-0-to-controller-quorum-channel-manager]: Recorded new controller, from now on will use node localhost:9093 (id: 1 rack: null) (kafka.server.BrokerToControllerRequestThread)

You have to reduce the amount of time between deleting the znode and rolling at least one broker, so that an election can start.

Reviewers: Luke Chen <showuon@gmail.com>
2024-01-31 15:24:47 +08:00
Colin Patrick McCabe 5b422613a6
KAFKA-16101: Fix KRaft migration documentation (#15193)
This PR fixes some bugs in the KRaft migration documentation and reorganizes it to be easier to read. (Specifically, there were some steps that were previously out of order.)

In order to keep it all straight, the revert documentation is now in the form of a table which maps the latest migration state to the actions which the system administrator should perform.

Reviewers: Luke Chen <showuon@gmail.com>, David Arthur <mumrah@gmail.com>, Liu Zeyu <zeyu.luke@gmail.com>, Paolo Patierno <ppatierno@live.com>
2024-01-29 14:34:07 -08:00
Ismael Juma 92a67e8571
Note that Java 11 support for broker and tools is deprecated for removal in 4.0 (#15236)
Reviewers: Divij Vaidya <diviv@amazon.com>
2024-01-19 14:08:07 -08:00
Christo Lolov 71b2cd6173
MINOR: Add public documentation for metrics introduced in KIP-963 (#15138)
Reviewers: Satish Duggana <satishd@apache.org>, Kamal Chandraprakash<kamal.chandraprakash@gmail.com>
2024-01-09 08:47:31 +05:30
Paolo Patierno 137fc18713
KAFKA-16005: Add details about rollback during ZK->KRaft migration in docs (#15012)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Luke Chen <showuon@gmail.com>
2023-12-14 14:59:29 +01:00
Mickael Maison 74be72a559
MINOR: Various fixes in the docs (#14914)
- Only use https links
- Fix broken HTML tags
- Replace usage of <tt> which is deprecated with <code>
- Replace hardcoded version numbers

Reviewers: Chris Egerton <fearthecellos@gmail.com>, Greg Harris <gharris1727@gmail.com>
2023-12-04 22:06:49 +01:00
Colin Patrick McCabe 4874bf818a
KAFKA-15311: Fix docs about reverting to ZooKeeper mode during KRaft migration (#14160)
- Remove the outdated statement that delegation tokens aren't supported by KRaft.

- Add an invitation to report migration bugs on JIRA.

- Define terminology such as "zk migration phases".

- Mention MV can't be changed during migration.

- Explain how to revert to ZK mode.

Reviewers: Ron Dagostino <rndgstn@gmail.com>, David Arthur <mumrah@gmail.com>
2023-11-28 14:03:59 -08:00
Bruno Cadonna 81cceedf7e
MINOR: Delete task-level commit sensor (#14677)
The task-level commit metrics were removed without deprecation in KIP-447 and the corresponding PR #8218. However, we forgot to update the docs and to remove the code that creates the task-level commit sensor.
This PR removes the task-level commit metrics from the docs and removes the code that creates the task-level commit sensor. The code was effectively dead since it was only used in tests.

Reviewers: Guozhang Wang <wangguoz@gmail.com>, Matthias J. Sax <matthias@confluent.io>
2023-11-09 15:37:13 +01:00
Luke Chen 7376d2c5b1
MINOR: add quick start for tiered storage feature (#14528)
Some users complained they don't have a way to determine if there is something wrong in the RSM plug-in they implemented, or there's something wrong in Kafka itself. Also, if there are users who just want to try the tiered storage feature out before implementing anything, it would be good we have an RSM implementation by default.

Per the discussion in the KIP, there will be no default RSM implementation in Kafka, but we can use the LocalTieredStorage implemented for integration test, to resolve the issues above.

Reviewers: Christo Lolov <lolovc@amazon.com>, Divij Vaidya <diviv@amazon.com>, Kamal Chandraprakash <kamal.chandraprakash@gmail.com>, Satish Duggana <satishd@apache.org>
2023-10-17 10:30:11 +08:00
bachmanity1 eb187745cd
MINOR: Fix docs for ReplicationBytes(Out|In)PerSec metrics (#14228)
Reviewers: Mickael Maison <mickael.maison@gmail.com>, Taras Ledkov
2023-10-16 15:12:38 +02:00
Justine Olshan b5d880a707
KAFKA-15330: Add missing documentation of metrics introduced as part of KAFKA-15028 (#14480)
I've added details for VerificationFailureRate and VerificationTimeMs.

I considered adding the documentation for the AddPartitionsToTxnVerification metrics, but I noticed that all the request metrics simply listed Produce|FetchConsumer|FetchFollower. If we don't already report the AddPartitionsToTxn request metrics in this file, it doesn't make sense to add the verification variant. (As well as all the other APIs we report)

Filed a followup jira if we want to redo that whole section.

Reviewers: Reviewers: Divij Vaidya <diviv@amazon.com>
2023-10-04 13:28:30 -07:00
David Arthur 5f676cce7a KAFKA-15483: Add KIP-938 and KIP-866 metrics to bundled docs (#14421)
Reviewers: Divij Vaidya <diviv@amazon.com>, Ron Dagostino <rdagostino@confluent.io>
2023-10-03 13:51:30 +02:00
Luke Chen ac39342d47
KAFKA-15442: add a section in doc for tiered storage (#14382)
Added 6.11: Tiered Storage section and notable changes ini v3.6.0

Reviewers: Satish Duggana <satishd@apache.org>, Gantigmaa Selenge <gselenge@redhat.com>
2023-09-14 20:21:00 +08:00
Federico Valeri 4405f8f956
MINOR: Fix metadata.version reference in "ZooKeeper to KRaft Migration" documentation (#14366)
In "ZooKeeper to KRaft Migration" documentation, we are still reporting 3.4 as metadata version. Reworking that phrase to make it more clear and avoid the need to update it in the future.

Signed-off-by: Federico Valeri <fedevaleri@gmail.com>

Reviewers: Luke Chen <showuon@gmail.com>
2023-09-12 20:44:04 +08:00
atu-sharm 9ecf6f7f1c
KAFKA-15338: The metric group documentation for metrics added in KAFKA-13945 is incorrect (#14221)
Reviewers: Matthias J. Sax <matthias@confluent.io>
2023-09-07 19:05:14 -07:00
Abhijeet Kumar 37a51e286d
KAFKA-15293 Added documentation for tiered storage metrics (#14331)
Reviewers: Divij Vaidya <diviv@amazon.com>, Satish Duggana <satishd@apache.org>
2023-09-05 22:19:10 +05:30
Matthias J. Sax af1f50fc9e
MINOR: fix docs markup (#14085)
Reviewers: Qichao Chu (@ex172000), Mickael Maison <mickael.maison@gmail.com>
2023-07-25 14:56:58 -07:00
Chase Thomas a82df3000a
MINOR: Update docs to include ZK deprecation notice and information (#14031)
Reviewers: Ismael Juma <ismael@confluent.io>, Mickael Maison <mickael.maison@gmail.com>, Divij Vaidya <diviv@amazon.com>, Matthias J. Sax <matthias@confluent.io>
2023-07-18 14:36:12 -07:00
Gantigmaa Selenge 5cb2504c49
KAFKA-14669: Use the generated docs for MirrorMaker configs in the doc (#13658)
Reviewers: Chris Egerton <chrise@aiven.io>
2023-07-18 11:27:19 -04:00
minjian.cai 49c1697ab0
MINOR: fix typos for doc (#13883)
Reviewers: Divij Vaidya <diviv@amazon.com>
2023-06-21 09:57:43 +02:00
David Arthur 66f0cbc424
MINOR: Add ZK migration instructions to the operations documentation (#13257)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2023-06-16 11:03:57 -04:00
Gantigmaa Selenge 930744c3a8
KAFKA-14709: Move content in connect/mirror/README.md to the docs (#13650)
Most of the contents in the README.md was already covered in the docs therefore only had to add the section for Exactly Once support.

Reviewers: Luke Chen <showuon@gmail.com>
2023-06-15 10:16:52 +08:00
Paolo Patierno 571841fed3
KAFKA-14883: Expose `observer` state in KRaft metrics (#13525)
Currently, the current-state KRaft related metric reports follower state for a broker while technically it should be reported as an observer as the kafka-metadata-quorum tool does.

Reviewers: Luke Chen <showuon@gmail.com>, dengziming <dengziming1993@gmail.com>
2023-04-13 12:55:57 +08:00
Anastasia Vela d479d129e0
KAFKA-13999: Add ProducerCount metrics (KIP-847) (#13078)
This is the PR for the implementation of KIP-847: https://cwiki.apache.org/confluence/display/KAFKA/KIP-847%3A+Add+ProducerIdCount+metrics
Add ProducerIdCount metric at the broker level:

kafka.server:type=ReplicaManager,name=ProducerIdCount
Added unit tests below to ensure the metric reported the count correctly.

---------

Co-authored-by: Artem Livshits <84364232+artemlivshits@users.noreply.github.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>, Divij Vaidya <diviv@amazon.com>, Christo Lolov <christo_lolov@yahoo.com>, Alexandre Dupriez <alexandre.dupriez@gmail.com>, Justine Olshan <jolshan@confluent.io>
2023-03-01 14:20:15 -08:00
Paolo Patierno 2603033e35
MINOR: Fixed typos in KRaft related metrics documentation (#13222)
Signed-off-by: Paolo Patierno <ppatierno@live.com>

Reviewers: Mickael Maison <mickael.maison@gmail.com>
2023-02-09 12:07:12 +01:00
Ron Dagostino 66412462c8
MINOR: fix some typos in comments/docs/variable names (#13118)
Reviewers: Colin P. McCabe <cmccabe@apache.org>
2023-01-23 17:04:59 -05:00
Rohan 175d491470
MINOR: add docs table entries for new metrics (#12934)
Adds docs for KIP-761.

Reviewers: Anurag Bandyopadhyay (@Anuragkillswitch), Matthias J. Sax <matthias@confluent.io>
2022-12-09 10:28:31 -08:00
José Armando García Sancio 24cb2d2f95
MINOR; Some sections are missing in the TOC (#12726)
Reviewers: Luke Chen <showuon@gmail.com>
2022-10-11 09:44:39 -07:00
José Armando García Sancio 281e178352
MINOR; Add missing code end tag (#12702)
Reviewers: Ismael Juma <ismael@juma.me.uk>
2022-09-29 15:09:00 -07:00
José Armando García Sancio 4dec656699
KAFKA-14207; KRaft Operations documentation (#12642)
Reviewers: Colin Patrick McCabe <cmccabe@apache.org>, Chase Thomas <forlack@users.noreply.github.com>
2022-09-26 11:19:48 -07:00
Niket eb8f0bd5e4
MINOR: Adding KRaft Monitoring Related Metrics to docs/ops.html (#12679)
This commit adds KRaft monitoring related metrics to the Kafka docs (docs/ops.html).

Reviewers: Jason Gustafson <jason@confluent.io>, Luke Chen <showuon@gmail.com>
2022-09-26 14:25:36 +08:00
José Armando García Sancio bc0b868cd4
KAFKA-14205; Document how to replace the disk for the KRaft Controller (#12597)
Document process for recovering and formatting the metadata log directory for the KRaft controller.

Reviewers: Colin Patrick McCabe <cmccabe@apache.org>, Jason Gustafson <jason@confluent.io>
2022-09-12 16:57:54 -07:00
Christo Lolov 94d4fdeb28
KAFKA-14008: Add docs for Streams throughput metrics introduced in KIP-846 (#12377)
Reviewers: Walker Carlson <wcarlson@confluent.io>, Matthias J. Sax <matthias@confluent.io>
2022-07-13 17:47:34 -07:00
Lee Dongjin 89c057397e
KAFKA-13436: Omitted BrokerTopicMetrics metrics in the documentation (#11473)
Reviewers: Mickael Maison <mickael.maison@gmail.com>
2022-06-13 16:46:19 +02:00
Luke Chen 4f40883d02
MINOR: add java 8/scala 2.12 deprecation info in doc (#12261)
Reviewers: Ismael Juma <mlists@juma.me.uk>
2022-06-09 09:39:23 +08:00
A. Sophie Blee-Goldman a6c5a74fdb
KAFKA-13945: add bytes/records consumed and produced metrics (#12235)
Implementation of KIP-846: Source/sink node metrics for Consumed/Produced throughput in Streams

Adds the following INFO topic-level metrics for the total bytes/records consumed and produced:

    bytes-consumed-total
    records-consumed-total
    bytes-produced-total
    records-produced-total

Reviewers: Kvicii <Karonazaba@gmail.com>, Guozhang Wang <guozhang@apache.org>, Bruno Cadonna <cadonna@apache.org>
2022-06-07 16:02:17 +02:00
RivenSun d8d92f0f80
MINOR: Update the kafka-reassign-partitions script command in documentation (#12237)
Reviewers: Luke Chen <showuon@gmail.com>
2022-06-02 21:30:22 +08:00
Luke Chen ca3271e0f3
MINOR: replace kafka-preferred-replica-election.sh with kafka-leader-election.sh (#11954)
Reviewers: Luke Chen <showuon@gmail.com>
2022-03-27 15:47:24 +08:00
Lee Dongjin 9d305c79d3
KAFKA-13430: Remove broker-wide quota properties from the documentation (#11463)
Reviewers: David Jacot <djacot@confluent.io>
2021-11-04 10:04:02 +01:00
Luizfrf3 252a40ea1f
KAFKA-8941: Add RocksDB Metrics that Could not be Added due to RocksD… (#11441)
This PR adds some RocksDB metrics that could not be added in KIP-471 due to RocksDB version. The new metrics are extracted using Histogram data provided by RocksDB API, and the old ones were extracted using Tickers. The new metrics added are memtable-flush-time-(avg|min|max) and compaction-time-(avg|min|max).

Reviewer: Bruno Cadonnna <cadonna@apache.org>
2021-11-03 12:18:28 +01:00
Josep Prat 286126f9a5
KAFKA-13243: KIP-773 Differentiate metric latency measured in ms and ns (#11302)
KAFKA-13243: KIP-773 Differentiate metric latency measured in ms and ns

Implementation of KIP-773

Deprecates inconsistent metrics bufferpool-wait-time-total,
io-waittime-total, and iotime-total.
Introduces new metrics bufferpool-wait-time-ns-total,
io-wait-time-ns-total, and io-time-ns-total with the same semantics as
before.
Adds metrics (old and new) in ops.html.
Adds upgrade guide for these metrics.

Reviewers: Guozhang Wang <wangguoz@gmail.com>, Tom Bentley <tbentley@redhat.com>
2021-09-08 18:00:58 +01:00
Lee Dongjin 0a1ef2e982
MINOR: Group KafkaController, ReplicaManager metrics in documentation (#7891)
Some minor edits to the docs

Reviewers: Anna Sophie Blee-Goldman <ableegoldman@apache.org>
2021-04-30 12:50:37 -07:00
Lee Dongjin 0b0eaefc60
KAFKA-12408: Document omitted ReplicaManager metrics (#10258)
Reviewers: Tom Bentley <tbentley@redhat.com>
2021-04-12 15:35:15 +01:00
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