Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Expand Hexdump Logging Capabilities #20

Closed
ZackeryRSmith opened this issue Jul 24, 2023 · 2 comments
Closed

[Feature] Expand Hexdump Logging Capabilities #20

ZackeryRSmith opened this issue Jul 24, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@ZackeryRSmith
Copy link
Contributor

[Feature]

Feature Suggestion

Please consider adding the following things to the logging system

Basic Execution Logs

  • command arguments passed
  • file being read:
    • size in bytes
    • file basename
    • file path (absolute)

Error Logs

  • where in the file the error occurred
  • the error type (which should show if the issue is due to the file or the program itself)
  • error message (should give a small description, and possibly a potential fix?)

Info Logs

  • milestones in the file (halfway, every n bytes)
    i. helps keep track of where hexdump is looking and how close it is to finishing
  • system resource usage (every so often)

Warning Logs

  • (if support for large files gets added): File size (may take long to finish if it's over a certain size)
  • if system resources are getting bogged down past a certain point mention that

After Execution Logs

  • Total time took
  • Peak of ram usage
  • Number of warnings (if applicable)

Use Case

When bugs occur, or working to optimize Hexdump logs can be used to help find where things are slow.

TLDR;

Added more logging ability to Hexdump for debugging errors, and to understand what Hexdump is doing better. I only listed a few things to add, but many more should come as Hexdump expands.

@ZackeryRSmith ZackeryRSmith added bug Something isn't working enhancement New feature or request labels Jul 24, 2023
@KeithBrown39423 KeithBrown39423 removed the bug Something isn't working label Jul 24, 2023
@KeithBrown39423 KeithBrown39423 pinned this issue Jul 27, 2023
@KeithBrown39423
Copy link
Owner

KeithBrown39423 commented Jul 28, 2023

Here's a checklist so that you can see which things have been added so far:

Note: Anything that is struck out won't be added

  • Command Arguments Passed
  • File Name
  • File Size
  • File Path (Absolute)
  • Error Type
  • Error Message
  • Milestones
  • Warnings for Large Files
  • Total Execution Time
    Error Location
    System Resource Usage (at Certain Intervals)
    Heavy System Resource Usage
    Peak Ram Usage
    Number of Warnings

@KeithBrown39423 KeithBrown39423 unpinned this issue Jul 28, 2023
@KeithBrown39423
Copy link
Owner

Added in 18238d1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants