[DRILL-5056] UserException does not write full message to log

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.8.0
• Fix Version/s: 1.11.0
• Labels: ready-to-commit
• Assignee: Paul Rogers
• Reporter: Paul Rogers
• Reviewer: Boaz Ben-Zvi
• Created: 21/Nov/16 17:12
• Updated: 28/Mar/17 18:27
• Resolved: 13/Dec/16 00:46

Description

A case occurred in which the External Sort failed during spilling. All that was written to the log was:

2016-11-18 ... INFO  o.a.d.e.p.i.xsort.ExternalSortBatch - User Error Occurred

As it turns out, there are two places in external sort that can throw a user exception. But, because the log contains neither line numbers nor detailed messages, it is not obvious which one was the cause.

When logging a user error, include the text provided when building the error. For example, consider the following external sort code:

      throw UserException.resourceError(e)
        .message("External Sort encountered an error while spilling to disk")
              .addContext(e.getMessage() /* more detail */)
        .build(logger);

The expected message is:

2016-11-18 ... INFO  o.a.d.e.p.i.xsort.ExternalSortBatch - User Error Occurred: External Sort encountered an error while spilling to disk (Disk write failed) 

The part in parens is the cause of the error: the e.getMessage( ) in the above code.

Issue Links

• links to: GitHub Pull Request #665