Site wide audit log better formatting when updates object is to be displayed #4315
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.
closes #4071
Description
As discussed in the issue, there are several places where audit log can be a bit too verbose. Rather than handling idividual cases it was suggested that details should be hidden by default and a "better default formatter" should be employed.
From this, the following has been implemented:
AuditEntryUpdates
component and places it at the endname
,type
,enabled
,version
) the OLD and NEW values are NOT shown.AuditEntryUpdates
component as it now receives the full audit entry (e.g. there are now possibilities of inspecting the audit event name and explicitly hiding update details.)Additionally, a monospaced font has been set and
whitespace-pre
on the details for updates AND errors has been further improve readability.I have been through a whole bunch of audit log entries with updates and this PR provides a good balance of detail and readability. Future iterations can expand or reduce further based on explicit criteria.
Screenshots of before and after
As I cannot expect the reviewer to perform every action and check formatting I will update this PR with screenshots before witching out of draft.Errors before and after
Overview before & after
Related Issue(s)
Checklist
flowforge.yml
?FlowFuse/helm
to update ConfigMap TemplateFlowFuse/CloudProject
to update values for Staging/ProductionLabels
area:migration
label