chainhook icon indicating copy to clipboard operation
chainhook copied to clipboard

Improve `Interrupted` status messages

Open sabbyanandan opened this issue 11 months ago • 4 comments

Context:

need to see a log feed of webhook calls to see which one failed so one can act upon it.

Similar to the line item at https://github.com/hirosystems/chainhook/issues/324#issuecomment-1677597568, it'd be helpful for developers to know what is the cause/reason for the failure in its raw log format, including the timestamp.

Additionally, today, we show high-level information when the developer hovers over, but when we have the raw log content, we can revisit the display of it from the DX perspective.

sabbyanandan avatar Mar 18 '24 15:03 sabbyanandan

To flesh this out some more, I think the steps would be:

  • Improve Interrupted status messages to be clear and actionable.
  • Consider adding more raw error data to the status, maybe in another field on the below object
  • Add context fields to erroring chainhooks:
{
  "error_msg": "...",
  "error_timestamp": "...",
  "last_evaluated_block_height": "...",
  "number_of_blocks_evaluated": "...",
  "number_of_times_triggered": "...",
  "last_occurrence": "..."
}

MicaiahReid avatar Mar 18 '24 16:03 MicaiahReid

@sabbyanandan It may be helpful to release some sort of FAQ or doc for the users on how to resolve or act upon some the more common errors.

MicaiahReid avatar Mar 18 '24 16:03 MicaiahReid

@MicaiahReid to fill in details for implementation.

smcclellan avatar May 29 '24 18:05 smcclellan

I think the details I provided here should cover it! https://github.com/hirosystems/chainhook/issues/528#issuecomment-2004395894

MicaiahReid avatar May 29 '24 19:05 MicaiahReid