[SPARK-27324] document configurations related to executor metrics

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.0.0
• Fix Version/s: 3.0.0
• Component/s: Documentation
• Assignee: Wing Yew Poon
• Reporter: Wing Yew Poon
• Created: 30/Mar/19 01:42
• Updated: 31/Jan/20 21:55
• Resolved: 31/Jan/20 20:30

Description

SPARK-23429 introduced executor memory metrics, and the configuration, spark.eventLog.logStageExecutorMetrics.enabled, that determines if per-stage per-executor metric peaks get written to the event log. (The metrics are polled and sent in the heartbeat, and this is always done; the configuration is only to determine if aggregated metric peaks are written to the event log.)
SPARK-24958 added proc fs based metrics to the executor memory metrics, and the configuration, spark.eventLog.logStageExecutorProcessTreeMetrics.enabled, to determine if these additional (more expensive) metrics are collected when metrics are polled.
SPARK-26329 will introduce a configuration, spark.executor.metrics.pollingInterval, to allow polling at more frequent intervals than the executor heartbeat.
These configurations and how they relate to each other should be documented in the Configuration page.

 

Issue Links

• links to: GitHub Pull Request #27329