[FLINK-17677] FLINK_LOG_PREFIX recommended in docs is not always available

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Not A Bug
• Affects Version/s: 1.9.3, 1.10.1, 1.11.0
• Fix Version/s: 1.12.0, 1.10.3, 1.11.3
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Xintong Song
• Created: 14/May/20 02:55
• Updated: 18/Nov/20 03:14
• Resolved: 18/Nov/20 03:14

Description

The Application Profiling & Debugging documentation recommend to use the script variable FLINK_LOG_PREFIX for defining log file paths. However, this variable is only available in standalone mode. This is a bit misleading for users of other deployments (see this thread).

I propose to replace FLINK_LOG_PREFIX with a general representation <your-log-path>, and add a separate section to discuss how to set the log path (e.g., use FLINK_LOG_PREFIX with standalone deployments and <LOG_DIR> with Yarn deployments).