Commit Graph

139 Commits

Author SHA1 Message Date
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