Catch interpolation exceptions (OTP2)

[gmellemstrand]

Summary

This is an OTP2 rebase of #3078 with no changes.

Changelog

Changelog entry updated

[gmellemstrand]

We agreed in today's OTP meeting to increase the log levels to warn, but accept the PR.

[evansiroky]

I believe that I set the log levels to debug since there could be thousands of these in certain cases where not enough elevation tiles are available for the full extent of the street network. The logs will be a lot noisier with this change.

[landonreed]

Maybe a good compromise would be to count the exceptions and log a single message (with this count) at the end of processing (potentially with some other helpful identifying information like a bounding box)?

[t2gran]

I agree will @landonreed, I would implement this with a LogThrottle class like this:

// Example use
LoggerThrottle logThrottle = new LoggerThrottle();
:
logThrottle.throttle("Bla bla bal, edge {}", msg -> log.warn(msg, edge));

// Trottle class
package org.opentripplanner.util;

public class LoggerThrottle  {
    private final Map<String, Integer> msgCounts = new HashMap<>();

    public void throttle(String message, Consumer<String> logOp) {
        Integer counter = msgCounts.get(message);
        if(counter == null) {
            msgCounts.put(message, 1);
            logOp.accept(message);
        }
        else {
            msgCounts.put(message, counter+1);
        }
    }

    public List<String> summary() {
        var list = new ArrayList<String>();
        for (Entry<String, Integer> e : msgCounts.entrySet()) {
            list.add(String.format("LOG THROTTLE - %d events: %s", e.getValue(), e.getKey()));
        }
        return list;
    }
}

One little remark: do not use logThrottle.throttle("...", log::warn);, this will cause the log event to happen inside the lambda and the link to the code will be invalid (We want be able to navigate to the code line).

[t2gran]

LogThrottling is useful in many places in the graph builder process - hence the trouble to make a LoggerThrottle class. We do not care about the details missed. The data details should be logged to the issue report instead. For this particular case, we can wait until someone request it to be logged in the data issue report.