optionally record removed entity attributes in EntityAttributeFilteringStage

Description

It would be useful to be able to enable logging of entity attribute values removed by EntityAttributeFilteringStage. This event is actually logged in the existing code, but at debug level only.

We should extend the API with a property called (e.g.) loggingFilteredValues and change that level to INFO.

Environment

None

Activity

Show:

Ian Young June 29, 2017 at 9:50 AM

Commit 037062a2eceddc52d95742e5883a136a6e4ca67d implements this as a new property recordingRemovals (defaulting to false) which if set causes a WarningStatus to be added for each entity attribute removed.

Ian Young June 28, 2017 at 4:48 PM

The use case for this (including notice of filtered entity attributes in a report along with, for example, entities failing other checks) doesn't fit very well with logging as such. It makes more sense to optionally add an appropriate StatusMetadata and leave turning that into a logged message to a later StatusMetadataLoggingStage.

Another issue is whether it makes more sense to add a WarningStatus or an InfoStatus. The only similar case to date has used WarningStatus, and that's probably what we'd want for the specific use case, but it would probably be nice to have the ability to select between these options. Two boolean properties? A three-way private enum?

Fixed

Details

Assignee

Reporter

Components

Fix versions

Affects versions

Created February 5, 2016 at 7:58 AM
Updated May 16, 2024 at 12:23 PM
Resolved June 29, 2017 at 10:39 AM