Uploaded image for project: 'Cassandra'
  1. Cassandra
  2. CASSANDRA-16602

Revise the metrics docs in the website

Agile BoardAttach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskConvert to sub-taskMoveLinkCloneLabelsUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

    Details

      Description

      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.

        Attachments

          Activity

            People

            • Assignee:
              yifanc Yifan Cai Assign to me
              Reporter:
              yifanc Yifan Cai
              Authors:
              Yifan Cai
              Reviewers:
              Brandon Williams

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 10m
                10m

                  Issue deployment