Adding logs to batch submitters #73

annieke · 2021-04-07T00:58:38Z

Description

Doing a pass of logs to make sure we have more context while debugging. Let me know if there are other key areas that need more logs!

Additional context

Improve observability!

Metadata
https://github.com/ethereum-optimism/roadmap/issues/860

src/batch-submitter/state-batch-submitter.ts

snario · 2021-04-07T19:24:34Z

src/batch-submitter/tx-batch-submitter.ts

@@ -166,6 +175,7 @@ export class TransactionBatchSubmitter extends BatchSubmitter {

  // TODO: Remove this function and use geth for lastL1BlockNumber!
  private async _updateLastL1BlockNumber() {
+    this.log.warn('Calling _updateLastL1BlockNumber...')


Why is this a warning?

^oo this is another spot i wanted an opinion on, i thought of putting warnings for all the functions we want to deprecate cc @karlfloersch @tynes whether we'll do that for this soon?

@annieke shoot this function should be removed entirely — it was only used when Geth did not return an L1BlockNumber field. At this point this ( updateLastL1BlockNumber() ) is dead code

@karlfloersch it's called in _generateSequencerBatchParams, should the line that calls it be removed? bc it still seems like it's doing something

src/batch-submitter/tx-batch-submitter.ts

snario · 2021-04-08T17:40:00Z

Things I feel like are INFO level logs...

Beginning batch submission process (w/ chainId and batch submitter public key)
Querying L2 sequencer for transactions to fit in block (w/ starting block number)
Determined set of transactions to batch submit (w/ list of transaction IDs)
Submitting batch submission to chain (w/ transaction data (to, data))
Transaction successfully submitted to chain (w/ transaction hash)
Transaction successfully confirmed on-chain (w/ # confirmations)

annieke · 2021-04-08T22:59:49Z

@snario just did another pass adding those logs!

snario · 2021-04-09T02:06:05Z

src/batch-submitter/tx-batch-submitter.ts

@@ -310,6 +349,12 @@ export class TransactionBatchSubmitter extends BatchSubmitter {
      //  In this case, we want to submit regardless of the batch's size.
      wasBatchTruncated = true
    }
+
+    this.log.info('Generated sequencer batch params', {
+      contexts: sequencerBatchParams.contexts,


How large is this?

the contexts is quite small (in the test with 6 transactions), the transactions are actually the longer parts of this log here. i'll keep it and de-bloat if this ends up being too large?

snario · 2021-04-09T02:08:04Z

src/batch-submitter/tx-batch-submitter.ts

+    this.log.info('Retrieved start block number from CTC', {
+      startBlock,
+    })


Might be useful to log both before and after this asynchronous network call for debugging purposes

annieke added 2 commits April 6, 2021 17:36

Add logs to tx batch submitter

1211449

improve state batch submitter logs and fix bug

46b3a8c

annieke commented Apr 7, 2021

View reviewed changes