From 11797ff12115172547d4605fe1bdf6915187c3db Mon Sep 17 00:00:00 2001 From: Dom Garguilo Date: Wed, 11 Sep 2024 13:43:52 -0400 Subject: [PATCH] Add Metrics doc to User Manual configuration tab --- README.md | 2 +- _docs-2/configuration/metrics3.md | 529 ++++++++++++++++++++++++++++++ 2 files changed, 530 insertions(+), 1 deletion(-) create mode 100644 _docs-2/configuration/metrics3.md diff --git a/README.md b/README.md index 13c68bbd4..264848490 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ The source for these tags is at [\_plugins/links.rb](_plugins/links.rb). ### Updating Property Documentation for Releases -Building Accumulo generates `server-properties*.md` and `client-properties*.md`. +Building Accumulo generates `server-properties*.md`, `client-properties*.md` and `metrics*.md`. To regenerate these, do the following. ```bash diff --git a/_docs-2/configuration/metrics3.md b/_docs-2/configuration/metrics3.md new file mode 100644 index 000000000..71d73545c --- /dev/null +++ b/_docs-2/configuration/metrics3.md @@ -0,0 +1,529 @@ +--- +title: Metrics Documentation (3.x) +category: configuration +order: 7 +--- + + + +Below are the metrics used to monitor various components of Accumulo. + + +## General Server Metrics + +### accumulo.detected.low.memory + +**Type:** GAUGE + +**Description:** Reports 1 when process memory usage is above threshold, 0 when memory is okay. + +### accumulo.server.idle + +**Type:** GAUGE + +**Description:** Indicates if the server is idle or not. The value will be 1 when idle and 0 when not idle. + + +## Compactor Metrics + +### accumulo.compactor.entries.read + +**Type:** FUNCTION_COUNTER + +**Description:** Number of entries read by all threads performing compactions. + +### accumulo.compactor.entries.written + +**Type:** FUNCTION_COUNTER + +**Description:** Number of entries written by all threads performing compactions. + +### accumulo.compactor.majc.stuck + +**Type:** LONG_TASK_TIMER + +**Description:** + + +## Fate Metrics + +### accumulo.fate.errors + +**Type:** GAUGE + +**Description:** + +### accumulo.fate.ops + +**Type:** GAUGE + +**Description:** Tracks all the current FATE ops in any state. + +### accumulo.fate.ops.activity + +**Type:** GAUGE + +**Description:** + +### accumulo.fate.ops.in.progress.by.type + +**Type:** GAUGE + +**Description:** Number of FATE operations in progress. The type is designated by the `op.type` tag. + +### accumulo.fate.tx + +**Type:** GAUGE + +**Description:** The state is now in a tag (e.g., state=new, state=in.progress, state=failed, etc.). + + +## Garbage Collection Metrics + +### accumulo.gc.candidates + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.deleted + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.errors + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.finished + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.in.use + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.post.op.duration + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.run.cycle + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.started + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.wal.candidates + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.wal.deleted + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.wal.errors + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.wal.finished + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.wal.in.use + +**Type:** GAUGE + +**Description:** + +### accumulo.gc.wal.started + +**Type:** GAUGE + +**Description:** + + +## Tablet Server Metrics + +### accumulo.tserver.compactions.majc.paused + +**Type:** COUNTER + +**Description:** + +### accumulo.tserver.compactions.majc.queued + +**Type:** GAUGE + +**Description:** The compaction service information is in a tag: `id={i|e}_{compactionServiceName}_{executor_name}`. + +### accumulo.tserver.compactions.majc.running + +**Type:** GAUGE + +**Description:** The compaction service information is in a tag: `id={i|e}_{compactionServiceName}_{executor_name}`. + +### accumulo.tserver.compactions.minc.paused + +**Type:** COUNTER + +**Description:** + +### accumulo.tserver.compactions.minc.queued + +**Type:** TIMER + +**Description:** + +### accumulo.tserver.compactions.minc.running + +**Type:** TIMER + +**Description:** + +### accumulo.tserver.entries + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.entries.mem + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.hold + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.ingest.bytes + +**Type:** GAUGE + +**Description:** Prior to 2.1.0 this metric was reported as a rate, it is now the count and the rate can be derived. + +### accumulo.tserver.ingest.mutations + +**Type:** GAUGE + +**Description:** Prior to 2.1.0 this metric was reported as a rate, it is now the count and the rate can be derived. + +### accumulo.tserver.majc.queued + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.majc.running + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.majc.stuck + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.minc.queued + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.minc.running + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.minc.total + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.tablets.assignments.warning + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.tablets.files + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.tablets.online + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.tablets.opening + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.tablets.unopened + +**Type:** GAUGE + +**Description:** + +### accumulo.tserver.updates.commit + +**Type:** TIMER + +**Description:** + +### accumulo.tserver.updates.commit.prep + +**Type:** TIMER + +**Description:** + +### accumulo.tserver.updates.error + +**Type:** GAUGE + +**Description:** Type is stored in a tag (e.g., type=permission, type=unknown.tablet, type=constraint.violation). + +### accumulo.tserver.updates.mutation.arrays.size + +**Type:** DISTRIBUTION_SUMMARY + +**Description:** + +### accumulo.tserver.updates.walog.write + +**Type:** TIMER + +**Description:** + + +## Scan Server Metrics + +### accumulo.scan.busy.timeout.count + +**Type:** COUNTER + +**Description:** Count of the scans where a busy timeout happened. + +### accumulo.scan.close + +**Type:** COUNTER + +**Description:** + +### accumulo.scan.continue + +**Type:** COUNTER + +**Description:** + +### accumulo.scan.files.open + +**Type:** GAUGE + +**Description:** + +### accumulo.scan.paused.for.memory + +**Type:** COUNTER + +**Description:** + +### accumulo.scan.queries + +**Type:** GAUGE + +**Description:** + +### accumulo.scan.query.results + +**Type:** GAUGE + +**Description:** Prior to 2.1.0 this metric was reported as a rate, it is now the count and the rate can be derived. + +### accumulo.scan.query.results.bytes + +**Type:** GAUGE + +**Description:** Prior to 2.1.0 this metric was reported as a rate, it is now the count and the rate can be derived. + +### accumulo.scan.query.scanned.entries + +**Type:** GAUGE + +**Description:** Prior to 2.1.0 this metric was reported as a rate, it is now the count and the rate can be derived. + +### accumulo.scan.reservation.conflict.count + +**Type:** COUNTER + +**Description:** + +### accumulo.scan.reservation.total.timer + +**Type:** TIMER + +**Description:** Time to reserve a tablet's files for scan. + +### accumulo.scan.reservation.writeout.timer + +**Type:** TIMER + +**Description:** Time to write out a tablets file reservations for scan + +### accumulo.scan.result + +**Type:** GAUGE + +**Description:** + +### accumulo.scan.return.early.for.memory + +**Type:** COUNTER + +**Description:** + +### accumulo.scan.start + +**Type:** COUNTER + +**Description:** + +### accumulo.scan.tablet.metadata.cache + +**Type:** CACHE + +**Description:** Scan server tablet cache metrics. + +### accumulo.scan.times + +**Type:** TIMER + +**Description:** + +### accumulo.scan.yields + +**Type:** GAUGE + +**Description:** + +### accumulo.scan.zombie.threads + +**Type:** GAUGE + +**Description:** + + +## Thrift Metrics + +### accumulo.thrift.execute + +**Type:** DISTRIBUTION_SUMMARY + +**Description:** + +### accumulo.thrift.idle + +**Type:** DISTRIBUTION_SUMMARY + +**Description:** + + +## Block Cache Metrics + +### accumulo.blockcache.data.evictioncount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.data.hitcount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.data.requestcount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.index.evictioncount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.index.hitcount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.index.requestcount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.summary.evictioncount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.summary.hitcount + +**Type:** FUNCTION_COUNTER + +**Description:** + +### accumulo.blockcache.summary.requestcount + +**Type:** FUNCTION_COUNTER + +**Description:** + + +## Manager Metrics + +### accumulo.manager.balancer.migrations.needed + +**Type:** GAUGE + +**Description:** The number of migrations that need to complete before the system is balanced. +