[HADOOP-18567] LogThrottlingHelper: the dependent recorder is not triggered correctly

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.3.4
• Fix Version/s: 3.4.0, 3.3.6
• Component/s: common
• Labels: pull-request-available
• Target Version/s: 3.4.0, 3.3.6
• Hadoop Flags: Reviewed
• Assignee: Chengbing Liu
• Reporter: Chengbing Liu
• Created: 12/Dec/22 06:46
• Updated: 27/Jan/24 09:01
• Resolved: 16/Dec/22 17:26

Description

The current implementation of LogThrottlingHelper works well most of the time, but it missed out one case, which appears quite common in the production codes:

• if the dependent recorder was not suppressed before the primary one is triggered on the next period, then the next logging of the dependent recorder will be unexpectedly suppressed.

    helper = new LogThrottlingHelper(LOG_PERIOD, "foo", timer);

    assertTrue(helper.record("foo", 0).shouldLog());
    assertTrue(helper.record("bar", 0).shouldLog());

    // Both should log once the period has elapsed
    // <pos1>
    assertTrue(helper.record("foo", LOG_PERIOD).shouldLog());
    assertTrue(helper.record("bar", LOG_PERIOD).shouldLog()); <--- This assertion will now fail

Note if we call helper.record("bar", LOG_PERIOD * 2) in <pos1>, as the existing test cases do, it will work as expected.

Issue Links

• is related to: HADOOP-15726 Create utility to limit frequency of log statements
• links to: GitHub Pull Request #5215