Skip to content

Add plugins for logging results #877

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

Merged
merged 27 commits into from
Jul 2, 2025
Merged

Add plugins for logging results #877

merged 27 commits into from
Jul 2, 2025

Conversation

hwikle-lanl
Copy link
Collaborator

Code review checklist:

  • Code is generally sensical and well commented
  • Variable/function names all telegraph their purpose and contents
  • Functions/classes have useful doc strings
  • Function arguments are typed
  • Added/modified unit tests to cover changes.
  • New features have documentation added to the docs.
  • New features and backwards compatibility breaks are noted in the RELEASE.md

@hwikle-lanl hwikle-lanl requested a review from Paul-Ferrell June 13, 2025 21:47
@hwikle-lanl hwikle-lanl self-assigned this Jun 13, 2025
@hwikle-lanl hwikle-lanl marked this pull request as ready for review June 24, 2025 16:19
@hwikle-lanl hwikle-lanl force-pushed the fix-results-locking branch from 5cc7735 to a0328ff Compare June 24, 2025 16:21
Paul-Ferrell
Paul-Ferrell previously approved these changes Jun 24, 2025
Comment on lines 22 to 30
The common file logger is the simplest possible result logger. It logs all test results to a single
log file, located in a specified location. The format for configuring a common file logger consists
of the plugin type (``common_file``) and the destination of the log file:

.. code-block:: yaml
result_loggers:
- plugin: common_file
dest: /path/to/results.log

Copy link
Collaborator

Choose a reason for hiding this comment

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

You should have a comment in here about the locking requirements.

Comment on lines 475 to 481
ExPathElem(
"result_log",
# Derive the default from the working directory, if a value isn't
# given.
help_text="Results are put in both the general log and a specific "
"results log. This defaults to 'results.log' in the default "
"working directory."),
Copy link
Collaborator

Choose a reason for hiding this comment

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

You should have Pavilion print a deprecation warning and configure a common logger for this.

@Paul-Ferrell Paul-Ferrell merged commit 2a62aed into develop Jul 2, 2025
7 checks passed
hwikle-lanl added a commit that referenced this pull request Jul 15, 2025
* Initial logging plugin

* Progress towards result output plugins

* Fix some things

* Foo

* Fix some errors

* Foo

* Progress

* Foo

* Foo

* Fix flatten_results test

* Fix flatten results test

* Fix setup_logger unit test

* Add common file logger plugin

* --ammend

* Remove maint command

* Attempt to fix module tests

* Fix series init test

* Fix some module tests

* Fix log cmd tests

* Add unit test for series file logger

* Improve flatten_results unit test

* Fix style issues

* Add unit test for common file logger

* Fix _log_results command

* Add documentation for result loggers

* Restore result_log key

* Add note about locking
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants