esp-idf icon indicating copy to clipboard operation
esp-idf copied to clipboard

feat(espcoredump): Include boot time and unix time in header (IDFGH-12792)

Open nebkat opened this issue 1 year ago • 2 comments

Unfinished and untested but creating draft to gather feedback. Will create corresponding patch for esp-coredump python.

Core dumps do not contain any form of timestamp to help identify when a crash occurred.

This patch adds two new fields to the core dump header - boot time and unix time:

  • Boot time (microseconds since boot) is useful in determining whether a crash occurred immediately after boot or many hours in, which can aid in debugging. Observing the core dump data can indirectly provide this information but requires additional steps. In applications with known bugs (e.g. memory leaks) knowing this in advance can save time by reducing unnecessary debugging.
  • Unix time (microseconds since epoch) may provide hints as to why the crash occurred in applications that depend on external inputs, and is useful when organizing files, both on local and remote storage. In my application we copy core dumps to an SD card, but we have no way of knowing whether a particular core dump occurred 1 week or 1 year ago.

nebkat avatar May 09 '24 23:05 nebkat

Messages
:book: 🎉 Good Job! All checks are passing!

👋 Hello nebkat, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by :no_entry_sign: dangerJS against 523d526ebee2631a45d99955c91e830ddc95c062

github-actions[bot] avatar May 09 '24 23:05 github-actions[bot]

Thanks for the nice improvement idea @nebkat, I left some comments...

cc @erhankur

igrr avatar May 10 '24 13:05 igrr