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

Add filename, linenumber and function name to log statements (IDFGH-12023) #13088

Conversation

0xFEEDC0DE64
Copy link
Contributor

@0xFEEDC0DE64 0xFEEDC0DE64 commented Feb 1, 2024

This merge request adds filenames, linenumbers and function names to all log statements.

Very often I am in a situation where a esp component logs some sort of warning or error and I need to check the exact conditions how they can appear, and I would like to jump to that exact code line, where this log statement occurs.
The old if logging style only contains the tag and the message, which is just not enough to pinpoint the log line for me.

In the past I have gotten the feedback that the binary size might increase significantly. If you want I will provide another commit that only turns on this additional log functionality when its not inside the bootloader + a Kconfig parameter. Let me know what you think.

Copy link

github-actions bot commented Feb 1, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello 0xFEEDC0DE64, 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 🚫 dangerJS against 04c462f

@espressif-bot espressif-bot added the Status: Opened Issue is new label Feb 1, 2024
@github-actions github-actions bot changed the title Add filename, linenumber and function name to log statements Add filename, linenumber and function name to log statements (IDFGH-12023) Feb 1, 2024
@0xFEEDC0DE64 0xFEEDC0DE64 force-pushed the log-statements-with-filename branch from 51628c6 to 52cc87b Compare February 1, 2024 12:38
@jrahlf
Copy link

jrahlf commented Feb 1, 2024

It is not just binary size. Currently all logging is synchronous which means the extra information makes logging slower and in turn has performance impacts on all firmwares.

@0xFEEDC0DE64 0xFEEDC0DE64 force-pushed the log-statements-with-filename branch from 52cc87b to 04c462f Compare February 1, 2024 14:58
@KaeLL
Copy link
Contributor

KaeLL commented Feb 1, 2024

I wrote a variant of this for a project at work, but didn't even consider upstreaming because @jrahlf is right.
Edit: logs are already slow as it is, which is a problem, so I don't think they need help getting even slower.

@KonstantinKondrashov
Copy link
Collaborator

Hi! I am working on esp log v2 which will make the log more flexible and functional.
This particular feature I already implemented and will be available under a Kconfig option, keeping the general use case the same.
We gathered all requests for log features, and this log v2 improvement will cover all or at least most of them.
I have it in our internal repo, and this Q1 it will be gradually merged.

Sorry, we will not merge this PR, thank you for your contribution.

@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: Won't Do This will not be worked on and removed Status: Opened Issue is new labels Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: Won't Do This will not be worked on Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants