...
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
...
List of Reports
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. Searchable field. | |
validationTimestamp | UTC timestamp for the validation event in the format:
| transaction-Searchable and Aggregatable field. |
| _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. In the case of POMBA, this is X-ONAP-RequestID from the REST header. | |
| _type | Searchable and Aggregatable field. | |
| _score | Score of the validation. Optional field. | |
| _index | Index of the report. Searchable and Aggregatable field. | |
| client | client information from X-FromAppId | |
| model-version-idmodelVersionId | The model-version-id field provided to initiate the auditmodel-invariant-id. Searchable field. | |
| modelInvariantId | The model-invariant-id field provided to initiate the audit. service-instance-id Searchable field. | |
| serviceInstanceId | Identifier of this service instance, which was provided to initiate the audit. Searchable field. | |
| statusresult | "Pass" or "Fail", depending on whether any violations were found. Searchable field. | |
| 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. | |
| requestId | request Id from X-ONAP-RequestID | |
| modelName | The detailed model Name. Searchable field. | |
| violations | Array of violations. See below. |
Example Reports
Pass - validations piece
| Code Block | ||
|---|---|---|
| ||
{ "_index": "service-validations", "_type": "default", "_id": "f9537694-2ca6-4839-8f54-a3452d08814a", "_version": 1, "_score": null, "_source": { "violations": [], "validationId": "f9537694-2ca6-4839-8f54-a3452d08814a", "validationTimestamp": "20190131T190301Z", "modelVersionId": "pomba-demo-sdc-model-001-version-001", "modelInvariantId": "pomba-demo-sdc-model-001", "serviceInstanceId": "PombaDemoCust_001-SerivceInst-001", "requestId": "1502bfa4-0216-418a-a582-b18c79afd7c3", "client": "postman", "result": "Pass", "modelName": "" }, "fields": { "validationTimestamp": [ "2019-01-31T19:03:01.000Z" ] }, "sort": [ 1548961381000 ] } |
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 |
| modelName | The detailed model name |
violationDetails | For each data source triggered as part of this rule
|
An example of the Kibana validation report is as follows:
The attached report file contains an example of rule violations.
| View file | ||||
|---|---|---|---|---|
|
DMaaP
Each audit report, in addition to being viewable via Kabana, can be consumed in real-time via a DMaaP message. See POMBA DMaaP
...
POMBA audit result is reported via Kibana tool based on the data stored in ElasticSearch.
Deployment
Kibana and Elasticsearch are deployable via OOM by enabling pomba in the values.yaml file. Kibana is running on port 30234.