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

Added LineFileTagCombiner #1512

Merged
merged 8 commits into from
Mar 6, 2025
Merged

Conversation

gberg617
Copy link
Contributor

@gberg617 gberg617 commented Mar 4, 2025

Summary

  • This PR is a feature
  • Adds a Lumberjack combiner that combines messages only when the line number, file name, and tag are equal. If texts are not equal, only one text message will remain after being combined. This can be useful in some circumstances where we have a similar message that is emitted many times from the same source code location, but may be slightly different in its text content (e.g. if it includes the rank in the message). In some of these cases, the user may want to just see one message, even if the content is slightly different.

*
*******************************************************************************
*/
class LineFileTagCombiner : public axom::lumberjack::Combiner
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This class is nearly identical to the TextTagCombiner, with the exception of the criteria used to determine whether the message should be combined.

@bmhan12
Copy link
Contributor

bmhan12 commented Mar 4, 2025

Thanks @gberg617!

Be sure to update the ReadTheDocs documentation for the Combiner class to include LineFileTagCombiner, the .rst file is located at src/axom/lumberjack/docs/sphinx/combiner_class.rst.

@bmhan12
Copy link
Contributor

bmhan12 commented Mar 4, 2025

@gberg617 gberg617 self-assigned this Mar 5, 2025
Copy link
Member

@kennyweiss kennyweiss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gberg617 !

Please also update the RELEASE_NOTES

@gberg617
Copy link
Contributor Author

gberg617 commented Mar 5, 2025

Thanks @gberg617 !

Please also update the RELEASE_NOTES

I added a bullet under the "unreleased" section.

@gberg617 gberg617 merged commit a7de5db into develop Mar 6, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants