[MESOS-3772] Consistency of quoted strings in error messages

• Type: Bug
• Status: Accepted
• Priority: Major
• Resolution: Unresolved
• Labels: mesosphere newbie tech-debt
• Story Points: 3
• Assignee: Unassigned
• Reporter: Neil Conway
• Shepherd: Till Toenshoff
• Created: 20/Oct/15 19:50
• Updated: 26/Nov/18 13:36

Description

Example log output:

I1020 18:56:02.933956 1790 slave.cpp:1270] Got assigned task 13 for framework 496620b9-4368-4a71-b741-68216f3d909f-0000
I1020 18:56:02.934185 1790 slave.cpp:1386] Launching task 13 for framework 496620b9-4368-4a71-b741-68216f3d909f-0000
I1020 18:56:02.934408 1790 slave.cpp:1618] Queuing task '13' for executor default of framework '496620b9-4368-4a71-b741-68216f3d909f-0000
I1020 18:56:02.935417 1790 slave.cpp:1760] Sending queued task '13' to executor 'default' of framework 496620b9-4368-4a71-b741-68216f3d909f-0000

Aside from the typo (unmatched quote) in the third line, these log messages using quoting inconsistently: sometimes task, executor, and framework IDs are quoted, other times they are not.

We should probably adopt a general rule, a la http://www.postgresql.org/docs/9.4/static/error-style-guide.html . My proposal: when interpolating a variable, only use quotes if it is possible that the value might contain whitespace or punctuation (in the latter case, the punctuation should probably be escaped).

Issue Links

• relates to: MESOS-4600 Use `std::quoted` for strings in error messages