This is an automated email from the ASF dual-hosted git repository.
dongjoon-hyun pushed a commit to branch branch-4.x
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-4.x by this push:
new 4c2985040eaf [SPARK-58935][DOC] Document `executorManagement` and
`shared` queue metrics of `LiveListenerBus`
4c2985040eaf is described below
commit 4c2985040eaf6c5e6669e53acae11b4074edcb5f
Author: DongjunHwang <[email protected]>
AuthorDate: Tue Aug 25 11:01:10 2026 -0700
[SPARK-58935][DOC] Document `executorManagement` and `shared` queue metrics
of `LiveListenerBus`
### What changes were proposed in this pull request?
This PR adds the missing `LiveListenerBus` queue metrics to the
`namespace=LiveListenerBus` list in `docs/monitoring.md`:
- `queue.executorManagement.numDroppedEvents.count`
- `queue.executorManagement.size`
- `queue.shared.listenerProcessingTime` (timer)
- `queue.shared.numDroppedEvents.count`
- `queue.shared.size`
### Why are the changes needed?
`AsyncEventQueue` registers `queue.<name>.numDroppedEvents`,
`queue.<name>.listenerProcessingTime`, and `queue.<name>.size` for every
listener bus queue, and the `LiveListenerBus` metrics source is always
registered. The documentation lists all three metrics for the `appStatus` and
`eventLog` queues, but stops at
`queue.executorManagement.listenerProcessingTime` and omits the `shared` queue
entirely.
As a result, an already-exported signal such as
`<app-id>.driver.LiveListenerBus.queue.executorManagement.numDroppedEvents.count`
is not discoverable from the docs, even though it is what an operator needs in
order to tell whether the `executorManagement` queue (which drives
`ExecutorAllocationManager`) has dropped events.
### Does this PR introduce _any_ user-facing change?
No. This is a documentation-only change; no metric is added, removed, or
renamed.
### How was this patch tested?
Documentation-only change. The added entries were verified against the
metric names registered in `AsyncEventQueue`, and follow the existing list's
formatting and ordering.
### Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Sonnet 5
Closes #58216 from
HwangDongJun/fix/spark-58935-executormanagement-drop-metric.
Authored-by: DongjunHwang <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
(cherry picked from commit 841f3a0332dc4a3530bfbf48f0db0137f03774ac)
Signed-off-by: Dongjoon Hyun <[email protected]>
---
docs/monitoring.md | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/monitoring.md b/docs/monitoring.md
index a780701f1b60..c39a140d7990 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -1336,6 +1336,11 @@ This is the component with the largest amount of
instrumented metrics
- queue.eventLog.numDroppedEvents.count
- queue.eventLog.size
- queue.executorManagement.listenerProcessingTime (timer)
+ - queue.executorManagement.numDroppedEvents.count
+ - queue.executorManagement.size
+ - queue.shared.listenerProcessingTime (timer)
+ - queue.shared.numDroppedEvents.count
+ - queue.shared.size
- namespace=appStatus (all metrics of type=counter)
- **note:** Introduced in Spark 3.0. Conditional to a configuration
parameter:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
