Opened 16 months ago

Closed 5 weeks ago

#25632 closed enhancement (implemented)

Improve stem torrc logging options for integration testing

Reported by: dmr Owned by: atagar
Priority: Medium Milestone:
Component: Core Tor/Stem Version:
Severity: Normal Keywords: testing easy
Cc: dmr Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

As suggested by teor in #25631, utilizing the following options in torrc will improve logging for the purpose of integration testing in stem:

  • ProtocolWarnings 1
  • SafeLogging 0
  • LogTimeGranularity 1

The former (ProtocolWarnings 1) should be used in general with a local test relay (i.e. during development, independent of integration testing), and the log [warn]ings surfaced automatically in integration tests, which I believe currently isn't the case. The [warn]ings should potentially be treated as test failures when emitted (with exception of tests that directly try to violate the protocol, and check that Tor responds as such).

The latter two will help with debugging when a problem is encountered.

Child Tickets

Change History (4)

comment:1 Changed 14 months ago by atagar

Keywords: testing easy added

comment:2 Changed 5 weeks ago by atagar

Resolution: worksforme
Status: newclosed

teor has been working with me on Tor/Stem CI and hasn't mentioned this of late so gonna guess this is no longer needed. If so, it's a trivial tweak to make.

comment:3 Changed 5 weeks ago by teor

Resolution: worksforme
Status: closedreopened

No, these changes are still useful.

I'm not sure what we want to do about ProtocolWarnings, but having them in the logs or console output would be helpful.

comment:4 Changed 5 weeks ago by atagar

Resolution: implemented
Status: reopenedclosed

Sounds good! Done...

https://gitweb.torproject.org/stem.git/commit/?id=3efc9c5

Feel free to reopen if you need anything else.

Note: See TracTickets for help on using tickets.