Opened 4 years ago

Closed 9 months ago

#15019 closed defect (fixed)

Most FooStatistics entries in the man page don't mention ExtraInfo descriptors

Reported by: arma Owned by:
Priority: Medium Milestone: Tor: 0.3.4.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: tor-relay, doc, easy, review-group-32
Cc: Actual Points:
Parent ID: Points: .2
Reviewer: teor Sponsor:

Description

       ConnDirectionStatistics 0|1
           When this option is enabled, Tor writes statistics on the
           bidirectional use of connections to disk every 24 hours. (Default:
           0)

       HiddenServiceStatistics 0|1
           When this option is enabled, a Tor relay writes obfuscated
           statistics on its role as hidden-service directory, introduction
           point, or rendezvous point to disk every 24 hours. If
           ExtraInfoStatistics is also enabled, these statistics are further
           published to the directory authorities. (Default: 0)

       ExtraInfoStatistics 0|1
           When this option is enabled, Tor includes previously gathered
           statistics in its extra-info documents that it uploads to the
           directory authorities. (Default: 1)

Most of the man page entries for FooStatistics are like ConnDirectionStatistics -- they just talk about writing to disk. Then tucked away elsewhere is this ExtraInfoStatistics thing that says "previously gathered statistics".

It sounds like we should make much clearer that some of these go into the extrainfo descriptor and get published to the outside world?

And are there some of them that *don't* get published to the outside world? It's not immediately obvious from looking at the code.

Child Tickets

Attachments (2)

0004-PaddingStatistics-documented-properly.patch (1.0 KB) - added by aruna1234 10 months ago.
0005-Revised-patch-with-78-characters-per-line.patch (1.0 KB) - added by aruna1234 10 months ago.

Download all attachments as: .zip

Change History (22)

comment:1 Changed 4 years ago by nickm

Status: newassigned

comment:2 Changed 4 years ago by rl1987

I have a patch for #15550 that (hopefully) fixes this issue.

comment:3 Changed 4 years ago by nickm

Keywords: 027-triaged-1-out added

Marking triaged-out items from first round of 0.2.7 triage.

comment:4 Changed 4 years ago by nickm

Milestone: Tor: 0.2.7.x-finalTor: 0.2.???

Make all non-needs_review, non-needs_revision, 027-triaged-1-out items belong to 0.2.???

comment:5 Changed 2 years ago by teor

Milestone: Tor: 0.2.???Tor: 0.3.???

Milestone renamed

comment:6 Changed 2 years ago by nickm

Keywords: tor-03-unspecified-201612 added
Milestone: Tor: 0.3.???Tor: unspecified

Finally admitting that 0.3.??? was a euphemism for Tor: unspecified all along.

comment:7 Changed 19 months ago by nickm

Keywords: tor-03-unspecified-201612 removed

Remove an old triaging keyword.

comment:8 Changed 19 months ago by nickm

Keywords: 027-triaged-in added

comment:9 Changed 19 months ago by nickm

Keywords: 027-triaged-in removed

comment:10 Changed 19 months ago by nickm

Keywords: 027-triaged-1-out removed

comment:11 Changed 19 months ago by nickm

Status: assignednew

Change the status of all assigned/accepted Tor tickets with owner="" to "new".

comment:12 Changed 18 months ago by nickm

Keywords: doc easy added
Points: .2
Severity: Normal

comment:13 Changed 10 months ago by aruna1234

Which one of them exactly go to the extrainfo descriptor and get published to the outside world?

comment:14 Changed 10 months ago by teor

Most of the statistics were properly documented in #15550.
Only PaddingStatistics has been added since then, it goes in the extra info descriptor.

Edit tor/doc/tor.1.txt to change the generated man page.

comment:15 Changed 10 months ago by aruna1234

Adding -"If ExtraInfoStatistics is also enabled, these statistics are further published to the directory authorities. (Default: 0)" in the Padding Statistics would be correct, I guess?

comment:16 Changed 10 months ago by nickm

Milestone: Tor: unspecifiedTor: 0.3.4.x-final
Status: newneeds_review

comment:17 Changed 10 months ago by nickm

Keywords: review-group-32 added

comment:18 Changed 10 months ago by teor

Reviewer: teor
Status: needs_reviewneeds_revision

Hi, please revise the patch so the lines are about 78 characters wide. Use the existing lines as a guide.

comment:19 Changed 10 months ago by teor

Status: needs_revisionmerge_ready

Looks good to me, let's merge it in 0.3.4, 0.3.3 if you'd like.

comment:20 Changed 9 months ago by nickm

Resolution: fixed
Status: merge_readyclosed

ok, merged to 0.3.4!

Note: See TracTickets for help on using tickets.