Enhance reporting of coin selections in the log. #2668
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The primary use of this instance is to provide information in the log that's useful for debugging coin selections. However, the existing instance doesn't provide much of a summary, which makes it hard at a glance to understand the important properties of a selection. This change enhances the `Buildable` instance, giving the output a fixed-length prefix that has several data points useful for debugging. Example output: ``` computed fee: 0.999345 total ada balance in: 2322.500607 total ada balance out: 2321.501262 ada balance of selected inputs: 2322.500607 ada balance of extra input: 0.000000 ada balance of requested outputs: 2164.303103 ada balance of generated change outputs: 157.198159 number of selected inputs: 13 number of requested outputs: 1 number of generated change outputs: 2 number of unique non-ada assets in selected inputs: 323 number of unique non-ada assets in requested outputs: 0 number of unique non-ada assets in generated change outputs: 323 size of remaining utxo: 34 ```
This allows the multi-line output of a serialized selection result to start on a separate line.
|
bors r+ |
|
Canceled. |
jonathanknowles
changed the title
Buildable instance for SelectionResult.The `Fmt.genericF` function provides neatly-formatted output for record types, where each record field is rendered as `name: value` pair on a separate line.
…eports. This makes it possible to turn on the reporting of summarized coin selection reports (which are short, and fixed-length) without turning on the reporting of detailed coin selection reports (which can be extremely long).
jonathanknowles
force-pushed
the
jonathanknowles/enhance-buildable-instance-for-selection-result
branch
from
b669f0c
to
61acff3
Compare
rvl
approved these changes
May 26, 2021
| (view #txOutputMinimumAdaQuantity $ constraints tl pp) | ||
| (calcMinimumCost tl pp tx) | ||
| (tokenBundleSizeAssessor tl) | ||
| (selectionCriteria) | ||
| liftIO $ traceWith tr $ MsgSelectionDone sel | ||
| case mSel of |
There was a problem hiding this comment.
It is possible to just trace Either e SelectionResult and perform the reporting at the time of log formatting, and/or do further tracer transforms. That way, your functions aren't cluttered up with logging code.
|
bors r+ |
|
bors cancel |
|
(Will try to merge this again after the release is done.) |
|
bors cancel |
|
Build succeeded: |
iohk-bors
bot
deleted the
jonathanknowles/enhance-buildable-instance-for-selection-result
branch
|
I think the command is |
Weird! I checked the bors reference, and it claims that these are equivalent:
I guess it's a bug in the reference guide, or the command no longer exists (if it once did).
Sure! 👍🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue Number
ADP-890
Overview
This PR enhances the reporting of successful coin selection attempts in the log.
It creates two types of reports:
This makes it possible to turn on the reporting of summarized coin selection reports (which are short, and fixed-length) without turning on the reporting of detailed coin selection reports (which can be extremely lengthy).
Example output of a summarized report: