DomGarguilo commented on PR #4850:
URL: https://github.com/apache/accumulo/pull/4850#issuecomment-2318378055
Opening this PR as draft to hopefully get some feedback on this approach to
documenting the metrics. This code is largely modeled after and works the same
as the `Property` and `ConfigurationDocGen` classes. If this approach looks
good I suspect we could probably refactor some shared logic into a parent class
but wanted to make sure things look good before spending more time on it.
Here is an example of the output from the few example metrics I added to
`Metrics` in 880411b:
<details>
<summary><strong>Click to expand</strong></summary>
<!-- WARNING: Do not edit this file. It is a generated file that is copied
from Accumulo build (from core/target/generated-docs) -->
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
## Scan Server Metrics
### accumulo.scan.busy.timeout.count
**Type:** COUNTER
**Description:** Count of the scans where a busy timeout happened
## Fate Metrics
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
