Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debug: Add option for microsecond precision in debug.log #6881

Merged
merged 1 commit into from Oct 26, 2015

Conversation

sdaftuar
Copy link
Member

@sdaftuar sdaftuar commented Oct 23, 2015

(Inspired by #6880)

@btcdrak
Copy link
Contributor

btcdrak commented Oct 23, 2015

Thanks for picking it up, not sure why the other got closed.

@morcos
Copy link
Member

morcos commented Oct 24, 2015

Concept ACK. I'd really like the higher precision.

/** Return a time useful for the debug log */
int64_t GetLogTimeMicros()
{
if (nMockTime) return nMockTime*1000000;
Copy link
Contributor

@TheBlueMatt TheBlueMatt Oct 24, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really care about mock times for debug log entires?

Copy link
Contributor

@petertodd petertodd Oct 24, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should, as if we ever give a way to change the mocktime via RPC it'd be useful to be able to correlate the log files to what time we set.

Copy link
Member Author

@sdaftuar sdaftuar Oct 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I have some code I use to test that plays back historical data to a node and uses mocktime, and having the debug log have (mostly) consistent timestamps is helpful to me, so I figured I'd preserve the existing behavior.

@laanwj
Copy link
Member

laanwj commented Oct 24, 2015

Concept ACK - can be useful. Do keep it disabled by default, high-precision time makes correlation/side channel attacks easier, better to not make the logs more valuable.

@@ -726,6 +727,7 @@ bool AppInit2(boost::thread_group& threadGroup, CScheduler& scheduler)
// Set this early so that parameter interactions go to console
fPrintToConsole = GetBoolArg("-printtoconsole", false);
fLogTimestamps = GetBoolArg("-logtimestamps", true);
fLogTimeMicros = GetBoolArg("-logtimemicros", false);
Copy link
Member

@MarcoFalke MarcoFalke Oct 24, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Can you use the already present fLogTimeMicros which defaults to false instead of hardcoding it twice? (c.f. #6349)

Copy link
Member Author

@sdaftuar sdaftuar Oct 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea; fixed.

@petertodd
Copy link
Contributor

petertodd commented Oct 24, 2015

Concept ACK

@laanwj laanwj added the Feature label Oct 26, 2015
@sdaftuar sdaftuar force-pushed the add-microsecond-timestamps branch from a606db3 to fc099a3 Compare Oct 26, 2015
@instagibbs
Copy link
Member

instagibbs commented Oct 26, 2015

ACK, works as advertised

@gmaxwell
Copy link
Contributor

gmaxwell commented Oct 26, 2015

GetTimeMicros() is not a monotone clock. Will doom befall our users when the log entry timestamps sometimes go backwards?

@@ -726,6 +727,7 @@ bool AppInit2(boost::thread_group& threadGroup, CScheduler& scheduler)
// Set this early so that parameter interactions go to console
fPrintToConsole = GetBoolArg("-printtoconsole", false);
fLogTimestamps = GetBoolArg("-logtimestamps", true);
fLogTimeMicros = GetBoolArg("-logtimemicros", fLogTimeMicros);
Copy link
Member

@laanwj laanwj Oct 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of passing fLogTimeMicros both as input and output I'd prefer the default to be handled like the others, e.g. in the header,

static const bool DEFAULT_LOGTIMEMICROS = false;

Then

strUsage += HelpMessageOpt("-logtimemicros", strprintf("Add microsecond precision to debug timestamps (default: %u)", DEFAULT_LOGTIMEMICROS));
...
LogTimeMicros = GetBoolArg("-logtimemicros", DEFAULT_LOGTIMEMICROS);

Copy link
Member Author

@sdaftuar sdaftuar Oct 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do -- is that fine to put in util.h, since the global is declared in util.cpp? (I don't see anything else like that in util.h, so just want to double-check.)

Copy link
Member

@laanwj laanwj Oct 26, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, sounds good to me. You're right that the other options in util.h don't stick to this either, but it's the sane thing to do for new options :)

@laanwj
Copy link
Member

laanwj commented Oct 26, 2015

@gmaxwell
I don't think potential jumps in time will have apocalyptic effect for users. The debug log is meant for reporting to humans, which can generally cope. Using monotone time for log timestamps is not very usual - as it counts since some unspecified starting point, it is only useful for deltas.

@sdaftuar sdaftuar force-pushed the add-microsecond-timestamps branch from fc099a3 to 7bbc7c3 Compare Oct 26, 2015
@jgarzik
Copy link
Contributor

jgarzik commented Oct 26, 2015

ut ACK - though I do not see value in making this yet another option

IMO just add micros to the log and be done with it.

@gmaxwell
Copy link
Contributor

gmaxwell commented Oct 26, 2015

@laanwj There are other ways to make the time monotone-- apply max with the last priinted time. (OS returned monotone time can also be adjusted to whatever timebase by finding the initial offset; but that goes down a rabbit hole).

WRT Jeff's comment. I too would rather have them on all the time, and any message where we're worried about creating privacy violating logs, we should just stop logging them by default-- they're probably already problematic with 1 second times. (I'm not sure which messages these would be as I don't currently have any nodes without debugging turned up!)

@laanwj laanwj merged commit 7bbc7c3 into bitcoin:master Oct 26, 2015
laanwj added a commit that referenced this pull request Oct 26, 2015
7bbc7c3 Add option for microsecond precision in debug.log (Suhas Daftuar)
@laanwj
Copy link
Member

laanwj commented Oct 26, 2015

Would really like to keep this an option, so will merge as-is.

@jgarzik
Copy link
Contributor

jgarzik commented Oct 26, 2015

@laanwj Justification?

More options = more work. Where is the value in yet another default-off option that few users will ever know about, much less use?

Default-off this is basically dead code we must maintain.

@laanwj
Copy link
Member

laanwj commented Oct 26, 2015

See my post above.
Also there is no need for microsecond timestamps for most people. It will just take up more horizontal space. If you need them ,you can enable them.

@jgarzik
Copy link
Contributor

jgarzik commented Oct 26, 2015

@laanwj "no need for microsecond timestamps for most people" Citation needed?

Apache, MySQL, Linux kernel, several sys-loggers and other major servers/services moved to sub-second timestamps a while ago.

@petertodd
Copy link
Contributor

petertodd commented Oct 26, 2015

FWIW I've never even needed second-precision timestamps myself. Equally, dmesg for example gives me "seconds since boot" or something, rather than what I usually am more interested in, the date - wouldn't use that as an example of user friendly for general debugging.

luke-jr pushed a commit to luke-jr/bitcoin that referenced this pull request Nov 27, 2015
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants