[
https://issues.apache.org/jira/browse/CASSANDRA-16602?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yifan Cai updated CASSANDRA-16602:
----------------------------------
Test and Documentation Plan: build the docs and inspect
Status: Patch Available (was: Open)
PR: https://github.com/apache/cassandra/pull/968
* Fixed the MBean name format.
* Fixed the outdated metrics names in TableMetrics
* Fixed the KeyspaceMetrics MBean name
* Added missing metrics, including ReadRepairMetrics, MessagingMeetrics,
InternodeOutboundConnectionMetrics, InternodeInboundConnectionMetrics.
* Sorted the metrics rows in the tables alphabetically (for readability).
> Revise the metrics docs in the website
> --------------------------------------
>
> Key: CASSANDRA-16602
> URL: https://issues.apache.org/jira/browse/CASSANDRA-16602
> Project: Cassandra
> Issue Type: Bug
> Components: Legacy/Documentation and Website
> Reporter: Yifan Cai
> Assignee: Yifan Cai
> Priority: Normal
> Fix For: 4.0-rc
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> While inspecting the metrics code, I realized that the metrics docs (at
> https://cassandra.apache.org/doc/latest/operating/metrics.html) has several
> errors, e.g.
> 1. JMX MBean names have incorrect format. They should be separated with
> commas, but the doc has space separated values. Cassandra users referring to
> this docs will not get it working.
> 2. The MBean name for Keyspace metrics is wrong. In the code, we have
> `keyspace=<Keyspace>`, instead of `scope=<Keyspace>`, which is listed in the
> docs page.
> 3. There are outdated fields. For instance, the `SyncTime` has been
> renamed to `RepairSyncTime` under the TableMetrics.
> To avoid frustrating and confusing the users that refer to the metrics page,
> the docs need to be revised.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
