[jira] [Created] (CASSANDRA-11404) Document metrics mbeans org.apache.cassandra.metrics

["Michael Schurter (JIRA)" <ji...@apache.org>]

Michael Schurter created CASSANDRA-11404:
--------------------------------------------

             Summary: Document metrics mbeans org.apache.cassandra.metrics
                 Key: CASSANDRA-11404
                 URL: https://issues.apache.org/jira/browse/CASSANDRA-11404
             Project: Cassandra
          Issue Type: Improvement
          Components: Documentation and Website
            Reporter: Michael Schurter


Was bemoaning the lack of documentation for Cassandra's extensive metrics in IRC and [~thobbs] told me to file a ticket: 

I started stealing comments from {{src/java/org/apache/cassandra/metrics/TableMetrics.java}}:

||mbean||description||
| {{ColumnFamily.$keyspace.$table.MemtableOnHeapSize}} | Total amount of data stored in the memtable that resides on-heap, including column related overhead and partitions overwritten.
|
| {{ColumnFamily.$keyspace.$table.MemtableOffHeapSize}} | Total amount of data stored in the memtable that resides off-heap, including column related overhead and partitions overwritten. |
| {{ColumnFamily.$keyspace.$table.CompressionRatio}} | Current compression ratio for all SSTables |
| {{ColumnFamily.$keyspace.$table.Estimated{Partition,Row}SizeHistogram}} | Histogram of estimated partition size (in bytes). |
| {{ColumnFamily.$keyspace.$table.ReadLatency}} | Local read metrics. |
| {{ColumnFamily.$keyspace.$table.WriteLatency}} | Local Write metrics. |

| {{ColumnFamily.$keyspace.$table.MemstableLiveDataSize}} | Total amount of live data stored in the memtable, excluding any data structure overhead. |
| {{ColumnFamily.$keyspace.$table.CoordinatorReadLatency}} | Read request latency from the perspective of the coordinating node |
| {{ColumnFamily.$keyspace.$table.CoordinatorScanLatency}} | ??? |



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)