[tor-bugs] #28731 [Core Tor/Tor]: log bootstrap tag name for easier troubleshooting

[Tor Bug Tracker & Wiki]

#28731: log bootstrap tag name for easier troubleshooting
-------------------------------------------------+-------------------------
 Reporter:  catalyst                             |          Owner:
                                                 |  catalyst
     Type:  defect                               |         Status:
                                                 |  merge_ready
 Priority:  Medium                               |      Milestone:  Tor:
                                                 |  0.3.5.x-final
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  s8-bootstrap, 033-backport-maybe,    |  Actual Points:
  034-backport-maybe, 035-backport-maybe         |
Parent ID:  #28018                               |         Points:  0.1
 Reviewer:                                       |        Sponsor:
                                                 |  Sponsor8-can
-------------------------------------------------+-------------------------
Changes (by dgoulet):

 * status:  needs_review => merge_ready


Comment:

 Replying to [comment:4 atagar]:
 > Honestly this feels like a lateral move to me so I'd lean against, but
 again I don't have much of a dog in this. Happy to defer to the network
 team.

 My two cents. In my opinion, no third part application should consider tor
 logging as an "ABI" that is parsing a stream of text to learn the running
 status of tor. Tor has the control port for that.

 *HOWEVER*, I wouldn't be surprised that some application do it for the
 `NOTICE` level logs (at least) since not all tor operators/clients want
 their control port open so I understand the decision to look for
 `Bootstrapped [...]` lines. There is literally a security argument that
 could be made to do that instead of requiring to open the control port.

 We've never spec that out nor made it a stable ABI for the log notice.
 We've modified notice lines many times over the years and I think, at this
 point in time, it is still fine. It is really more flexible  for the
 network team and allows us to improve over time the notice logs that can
 change due to new subsystems or changes of behaviors that require
 reporting new/modified values.

 Ultimately, final decision comes down to our great maintainer, nickm :).

 Code lgtm;

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/28731#comment:5>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online