You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cassandra.apache.org by "Brandon Williams (Jira)" <ji...@apache.org> on 2021/04/14 19:28:00 UTC

[jira] [Commented] (CASSANDRA-16602) Revise the metrics docs in the website

    [ https://issues.apache.org/jira/browse/CASSANDRA-16602?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17321277#comment-17321277 ] 

Brandon Williams commented on CASSANDRA-16602:
----------------------------------------------

/cc [~lorina@datastax.com]

> 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
>
>
> 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: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org