Add hang time override option to external definition

[gold2718]

Summary of Issue:

Currently, there is a global 300 second 'hang' timer which, when exceeded, generates a warning. In some situations, this timer may be too short or too long.

Expected behavior and actual behavior:

Expect to be able to configure hang timeout warning on a per-external basis

Steps to reproduce the problem (should include model description file(s) or link to publi c repository):

Try adding a hang_warning = 20 to any externals entry

What is the changeset ID of the code, and the machine you are using:

a48558d

have you modified the code? If so, it must be committed and available for testing:

No

Screen output or log file showing the error message and context:

ERROR:root:Invalid input: "cime" contains unknown item "hang_warning".

This feature was requested by @KateFriedman-NOAA

[gold2718]

@jedwards4b, @billsacks, any thoughts on this feature request? On the proposed attribute name (hang_warning)? Maybe hang_warn_time?
If you like this, should there also be a global option (for the externals_description section)?

[jedwards4b]

I think hang is the wrong word - how about connection_timeout ?

[gold2718]

I do not like timeout because the code does not time out. It prints a warning and keeps trying.

[ekluzek]

In general I agree with @jedwards4b on the name, but it looks like the code is using the name hanging_timer. So it seems to me you want something consistent with that, unless you are going to change the name in the code as well.

With keeping with hanging_timer, I think hang_warn_time seems the best name I've heard so far.

[billsacks]

I wouldn't feel tied to the name in the code: I think it's more important to come up with a clear name for users. (The code can always be refactored now or later to bring it into sync with the new name.)

What about something like time_until_warning or connection_time_until_warn? I don't absolutely love either of those, but just throwing out a couple of other options.

If you like this, should there also be a global option (for the externals_description section)?

I'm not sure if we need a global option: it seems like the current hard-coded default could suffice. But I don't mind having a global option if others feel it would be valuable.

[gold2718]

Of everything suggested so far, I think time_until_warning is best because it is clear and representative of how the system uses the value (IMHO).