This is an automated email from the ASF dual-hosted git repository.
smiklosovic pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/cassandra.git
The following commit(s) were added to refs/heads/trunk by this push:
new 83b6f04496 Fix formatting of metrics documentation
83b6f04496 is described below
commit 83b6f04496afb70f033685239be0dd4838f8aa77
Author: Jérôme Barotin <[email protected]>
AuthorDate: Fri Sep 23 14:26:04 2022 +0200
Fix formatting of metrics documentation
patch by Jérôme Barotin; reviewed by Stefan Miklosovic for CASSANDRA-17961
---
CHANGES.txt | 1 +
doc/modules/cassandra/pages/operating/metrics.adoc | 152 ++++++++++-----------
2 files changed, 77 insertions(+), 76 deletions(-)
diff --git a/CHANGES.txt b/CHANGES.txt
index b2a7ae0d05..5a6e4a4d51 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,4 +1,5 @@
4.2
+ * Fix formatting of metrics documentation (CASSANDRA-17961)
* Keep sstable level when streaming for decommission and move
(CASSANDRA-17969)
* Add Unavailables metric for CASWrite in the docs (CASSANDRA-16357)
* Make Cassandra logs able to be viewed in the virtual table
system_views.system_logs (CASSANDRA-17946)
diff --git a/doc/modules/cassandra/pages/operating/metrics.adoc
b/doc/modules/cassandra/pages/operating/metrics.adoc
index 6ba2b8ae8d..c650ec1c32 100644
--- a/doc/modules/cassandra/pages/operating/metrics.adoc
+++ b/doc/modules/cassandra/pages/operating/metrics.adoc
@@ -55,12 +55,12 @@ Reported name format:
`org.apache.cassandra.metrics:type=Table keyspace=<Keyspace> scope=<Table>
name=<MetricName>`
[NOTE]
-.Note
====
There is a special table called '`all`' without a keyspace. This
represents the aggregation of metrics across *all* tables and keyspaces
on the node.
-====[cols=",,",options="header",]
+====
+[cols=",,",options="header",]
|===
|Name |Type |Description
|MemtableOnHeapSize |Gauge<Long> |Total amount of data stored in the
@@ -409,124 +409,124 @@ RequestType::
Description::
Metrics related to transactional read requests.
Metrics::
- [cols=",,",options="header",]
- |===
- |Name |Type |Description
- |Timeouts |Counter |Number of timeouts encountered.
+[cols=",,",options="header",]
+|===
+|Name |Type |Description
+|Timeouts |Counter |Number of timeouts encountered.
- |Failures |Counter |Number of transaction failures encountered.
+|Failures |Counter |Number of transaction failures encountered.
- | |Latency |Transaction read latency.
+| |Latency |Transaction read latency.
- |Unavailables |Counter |Number of unavailable exceptions encountered.
+|Unavailables |Counter |Number of unavailable exceptions encountered.
- |UnfinishedCommit |Counter |Number of transactions that were committed
- on read.
+|UnfinishedCommit |Counter |Number of transactions that were committed
+on read.
- |ConditionNotMet |Counter |Number of transaction preconditions did not
- match current values.
+|ConditionNotMet |Counter |Number of transaction preconditions did not
+match current values.
- |ContentionHistogram |Histogram |How many contended reads were
- encountered
- |===
+|ContentionHistogram |Histogram |How many contended reads were
+encountered
+|===
RequestType::
CASWrite
Description::
Metrics related to transactional write requests.
Metrics::
- [cols=",,",options="header",]
- |===
- |Name |Type |Description
- |Timeouts |Counter |Number of timeouts encountered.
+[cols=",,",options="header",]
+|===
+|Name |Type |Description
+|Timeouts |Counter |Number of timeouts encountered.
- |Failures |Counter |Number of transaction failures encountered.
+|Failures |Counter |Number of transaction failures encountered.
- | |Latency |Transaction write latency.
+| |Latency |Transaction write latency.
- |Unavailables |Counter |Number of unavailable exceptions encountered.
+|Unavailables |Counter |Number of unavailable exceptions encountered.
- |UnfinishedCommit |Counter |Number of transactions that were committed
- on write.
+|UnfinishedCommit |Counter |Number of transactions that were committed
+on write.
- |ConditionNotMet |Counter |Number of transaction preconditions did not
- match current values.
+|ConditionNotMet |Counter |Number of transaction preconditions did not
+match current values.
- |ContentionHistogram |Histogram |How many contended writes were
- encountered
+|ContentionHistogram |Histogram |How many contended writes were
+encountered
- |MutationSizeHistogram |Histogram |Total size in bytes of the requests
- mutations.
- |===
+|MutationSizeHistogram |Histogram |Total size in bytes of the requests
+mutations.
+|===
RequestType::
Read
Description::
Metrics related to standard read requests.
Metrics::
- [cols=",,",options="header",]
- |===
- |Name |Type |Description
- |Timeouts |Counter |Number of timeouts encountered.
- |Failures |Counter |Number of read failures encountered.
- | |Latency |Read latency.
- |Unavailables |Counter |Number of unavailable exceptions encountered.
- |===
+[cols=",,",options="header",]
+|===
+|Name |Type |Description
+|Timeouts |Counter |Number of timeouts encountered.
+|Failures |Counter |Number of read failures encountered.
+| |Latency |Read latency.
+|Unavailables |Counter |Number of unavailable exceptions encountered.
+|===
RequestType::
RangeSlice
Description::
Metrics related to token range read requests.
Metrics::
- [cols=",,",options="header",]
- |===
- |Name |Type |Description
- |Timeouts |Counter |Number of timeouts encountered.
- |Failures |Counter |Number of range query failures encountered.
- | |Latency |Range query latency.
- |Unavailables |Counter |Number of unavailable exceptions encountered.
- |===
+[cols=",,",options="header",]
+|===
+|Name |Type |Description
+|Timeouts |Counter |Number of timeouts encountered.
+|Failures |Counter |Number of range query failures encountered.
+| |Latency |Range query latency.
+|Unavailables |Counter |Number of unavailable exceptions encountered.
+|===
RequestType::
Write
Description::
Metrics related to regular write requests.
Metrics::
- [cols=",,",options="header",]
- |===
- |Name |Type |Description
- |Timeouts |Counter |Number of timeouts encountered.
+[cols=",,",options="header",]
+|===
+|Name |Type |Description
+|Timeouts |Counter |Number of timeouts encountered.
- |Failures |Counter |Number of write failures encountered.
+|Failures |Counter |Number of write failures encountered.
- | |Latency |Write latency.
+| |Latency |Write latency.
- |Unavailables |Counter |Number of unavailable exceptions encountered.
+|Unavailables |Counter |Number of unavailable exceptions encountered.
- |MutationSizeHistogram |Histogram |Total size in bytes of the requests
- mutations.
- |===
+|MutationSizeHistogram |Histogram |Total size in bytes of the requests
+mutations.
+|===
RequestType::
ViewWrite
Description::
Metrics related to materialized view write wrtes.
Metrics::
- [cols=",,",]
- |===
- |Timeouts |Counter |Number of timeouts encountered.
+[cols=",,",]
+|===
+|Timeouts |Counter |Number of timeouts encountered.
- |Failures |Counter |Number of transaction failures encountered.
+|Failures |Counter |Number of transaction failures encountered.
- |Unavailables |Counter |Number of unavailable exceptions encountered.
+|Unavailables |Counter |Number of unavailable exceptions encountered.
- |ViewReplicasAttempted |Counter |Total number of attempted view
- replica writes.
+|ViewReplicasAttempted |Counter |Total number of attempted view
+replica writes.
- |ViewReplicasSuccess |Counter |Total number of succeded view replica
- writes.
+|ViewReplicasSuccess |Counter |Total number of succeded view replica
+writes.
- |ViewPendingMutations |Gauge<Long> |ViewReplicasAttempted -
- ViewReplicasSuccess.
+|ViewPendingMutations |Gauge<Long> |ViewReplicasAttempted -
+ViewReplicasSuccess.
- |ViewWriteLatency |Timer |Time between when mutation is applied to
- base table and when CL.ONE is achieved on view.
- |===
+|ViewWriteLatency |Timer |Time between when mutation is applied to
+base table and when CL.ONE is achieved on view.
+|===
== Cache Metrics
@@ -568,10 +568,10 @@ The following caches are covered:
|===
[NOTE]
-.Note
====
Misses and MissLatency are only defined for the ChunkCache
-====== CQL Metrics
+====
+== CQL Metrics
Metrics specific to CQL prepared statement caching.
@@ -951,7 +951,7 @@ partitions processed per unlogged batch
JVM metrics such as memory and garbage collection statistics can either
be accessed by connecting to the JVM using JMX or can be exported using
-link:#metric-reporters[Metric Reporters].
+<<metric_reporters>>.
=== BufferPool
@@ -1071,7 +1071,7 @@ uncomment:
#MX4J_PORT="-Dmx4jport=8081"
----
-== Metric Reporters
+== Metric Reporters [[metric_reporters]]
As mentioned at the top of this section on monitoring the Cassandra
metrics can be exported to a number of monitoring system a number of
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
