Improve `Interrupted` status messages

hirosystems / chainhook

Extract transactions from Stacks and Bitcoin and build event driven re-org resistant indexers and databases.

GNU General Public License v3.0

147 stars 60 forks source link

Improve `Interrupted` status messages #528

Open sabbyanandan opened 7 months ago

sabbyanandan commented 7 months ago

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.

MicaiahReid commented 7 months ago

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 commented 7 months ago

@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.

smcclellan commented 5 months ago

@MicaiahReid to fill in details for implementation.

MicaiahReid commented 5 months ago

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