[ARROW-15958] [Java][Docs] Document HistoricalLog for debugging

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.0.0
• Component/s: Documentation, Java
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/31384
• Assignee: David Li
• Reporter: David Li
• Created: 17/Mar/22 12:35
• Updated: 11/Jan/23 11:40
• Resolved: 06/Jul/22 13:37

Description

BufferLedger has a HistoricalLog which records stack traces at various events in the buffer's life, such as when it was first allocated and upon incrementing/decrementing reference counts. While somewhat of an implementation detail, this information is useful for debugging, especially for tracking down memory leaks. We could document it (with a suitable warning).

However, the stack trace is less useful than it first appears because it accidentally truncates the log. We should fix that too.

Issue Links

• links to: GitHub Pull Request #12656