The POMBA report is generated every time the POMBA audit is run. Each report has a result field that indicates "Pass" or Fail", to indicate whether any violations were found. If the result is "Pass", then no violations were found. If the result is "Fail" then one or more violations were found and will be available within the report.
These reports can be viewed on the time series dashboard. The view can be filtered by specifying time slot or by any attribute which appears in the audit result . Each audit result can be expanded for more information
Report Content
To generate the report, POMBA uses the A&AI Validation microservice, so inherits a number of fields from there. For each report, the following information shall be available. For some fields, the valid set of values are defined as part of the POMBA Rules.
See also POMBA Initiating Audit to see how some of these parameters were input parameters into the audit.
TODO: Confirm final names (lowerCamel versus dashed-form etc)
| Field Name | Description |
|---|---|
| validationId | A unique identifier for the validation. Each validation has a non-deterministic UUID. Consequently, each validationId is different even if the contents of the validation are the same. |
validationTimestamp | UTC timestamp for the validation event in the format:
|
| entity Id | The identifier of the entity that was validated. |
| entity type | The type of the entity being validated. |
| transaction-id | A user provided transaction id. This will allow for tracing of the audit through its various operations. If the same transaction id is used as the operation that is being audited related to this service instance id, then this provides even greater traceability |
| model-version-id | The model-version-id field provided to initiate the audit |
| model-invariant-id | The model-invariant-id field provided to initiate the audit. |
| service-instance-id | Identifier of this service instance, which was provided to initiate the audit. |
| category | TBD |
| status | "Pass" or "Fail", depending on whether any violations were found |
| dataQuality | A field that reports any issues found during the audit that prevented the audit from fully being successfully run. status = "ok" or "error"; error = error message related to specific data quality issues encountered. |
| violations | Array of violations. See below. |
Violations
If rule violations are found, then for each violation, the following will be reported
| Field | Description |
|---|---|
| severity | Critical, Major, Minor, Warning |
| violationTimestamp | Time of violation |
| violationType | Type of violation - ?? |
| validationRule | Rule that was violated - See POMBA Rules |
| category | Category as defined in the rule definition. See POMBA Rules |
| errorMessage | An error message describing the validation failure. For POMBA, this is a simple string, with the violation details providing specifics of the violation |
| violationId | Globally unique identifier for this violation |
violationDetails | For each data source triggered as part of this rule
|
DMaaP
Each audit report, in addition to being viewable via Kabana, can be consumed in real-time via a DMaaP message. See POMBA DMaaP
Implementation Details
POMBA audit result is reported via Kibana tool based on the data stored in ElasticSearch.