case-study send function bugs and log format changes

[SimonSK]

• [x] send function bug fixes
  • The Send function is removed to avoid confusion. All codes, including tests, should use either SendDEVp2p or SendEthSubProto.
  • Any part of p2p package that previously used Send now use SendDEVp2p
  • Any part of eth package that previously used Send now use SendEthSubproto
  • Any part of all other packages that previously used Send now use SendDEVp2p (as logging is the only difference between the two).
  • SendItems should call SendDEVp2p. It is used by only p2p. Anywhere that previously used SendItems should continue to use it, not the other functions.
• [x] bring all original log messages back
• [x] include peer specific info (id, address, connection type) in every custom log message
  • [x] pass additional information to the send functions
• [x] log to file(s) at datadir/geth-case-study/logs. if not set, no logs are written to files, and only the ones with log-level <= verbosity are sent to stderr
  • geth-case-study.log: all log messages with log-level <= verbosity go here.
  • rlpx-received.log: RLPXRX - log level 6
  • rlpx-sent.log: RLPXTX - log level 7
  • devp2p-received.log: DEVP2PRX - log level 8
  • devp2p-sent.log: DEVP2PTX - log level 9
  • eth-received.log: ETHRX - log level 10
  • eth-sent.log: ETHTX - log level 11
  • daofork.log: DAOFORK - log level 12
• [x] add logrotate
  • use case: re-open/create the log files, after logrotate occurred (eg log filenames changed).
  • ex) geth --exec 'admin.logrotate()' attach [/path/to/ipc]

Log message formats:

• Prefix for all messages (both default and ours): loglevel|log timestamp in unix time
• Dao fork messages: prefix|received timestamp|support=bool|id=nodeid|addr=ip:port|conn=connection type
• All other custom messages: prefix|sent/received timestamp|message type|size=int|data=...|err=...|id=nodeid|addr=ip:port[|conn=connection type]
  • RLPX messages don't have conn

[sid1602]

For the DAO fork messages, I assume the log will contain the nodeid as well?

[SimonSK]

good catch. i totally screwed up the dao fork message. will push the change soon.

[SimonSK]

@sid1602 @zzma another logging format issue that's not too concerning. ETH_NEW_BLOCK_HASHES data is being logged like this: data=["{\"Hash\":\"0x4a2b1434bdbfae... With this PR, certain characters---including backslash but not quotes---are escaped, so the message now looks like: data=["{\\"Hash\\":\\"0x4a2b1434bdbfae... The first backslash comes from the following line escaping the double quote: https://github.com/teamnsrg/go-ethereum/blob/85a1acbfd70a50d81fe6aba073689b6bbf912e06/eth/protocol.go#L150-L152 I think removing ~the inner MarshalObj~ the for loop should fix this problem.