[tor-bugs] #28565 [Core Tor/sbws]: Report excluded results in a relay's bandwidth line

[Tor Bug Tracker & Wiki]

#28565: Report excluded results in a relay's bandwidth line
-------------------------------------------------+-------------------------
 Reporter:  teor                                 |          Owner:  juga
     Type:  defect                               |         Status:
                                                 |  needs_revision
 Priority:  Medium                               |      Milestone:  sbws:
                                                 |  1.1.0
Component:  Core Tor/sbws                        |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  tor-bwauth, sbws-1.0-must-           |  Actual Points:
  moved-20181128, sbws-11x-final-                |
  removed-20190312, sbws-110-proposed, changes-  |
  version-minor                                  |
Parent ID:  #28547                               |         Points:  1
 Reviewer:  teor                                 |        Sponsor:
-------------------------------------------------+-------------------------

Comment (by teor):

 Replying to [comment:12 juga]:
 > Replying to [comment:11 teor]:
 > > I will do a much better review after this change has documentation:
 > > https://trac.torproject.org/projects/tor/ticket/28567#comment:13
 >
 > do you mean this PR or the PR in #28567?.

 I wanted documentation for this pull request, similar to what nick wanted:

 I think this is okay, but PLEASE document all new functions, fields,
 errors, etc. Right now I can only check that the code looks at least sort
 of reasonable -- not that it does what you want it to do. Documentation
 would let me know what you want the code to do, so I can check that it
 does that.

 Here are some specific things to fix:

 * You made the bandwidth file header count relay exclusions, not result
 exclusions. That is a good choice: anyone who wants to know result totals
 can just add all the relay-level results. But the key names, key
 documentation, and comments need to say what you are counting.

 * It's not clear to me what each key is meant to be counting. Please
 update the spec in #29775, or write comments that define each kind of
 failure and each key (or both).

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