...
Official R1 documentation snapshot in https://onap.readthedocs.io/en/latest/submodules/logging-analytics.git/docs/
THIS IS A DRAFT WIP for R2 - ONAP Beijing Release
This document specifies logging conventions to be followed by ONAP component applications.
...
- It's only a few calls.
- It can be largely abstracted in the case of EELF logging.
TODO: code.
MDCs - the Rest
Other MDCs are logged in a wide range of contexts.
Certain MDCs and their semantics may be specific to EELF log types.
TODO: cross-reference EELF output to v1 doc.
MDC - PartnerName
This field should contain the name of the client application user agent or user invoking the API.
This is often used for heuristic analysis to identify invocations between ONAP individual ONAP components. Its value has never been clearly stipulated, so a common problem has been a lack of consistency.
There is no clear consensus, but:
- Use the short name of your component, e.g. xyzdriver.
- Values should be human-readable.
- Values should be fine-grained enough to disambiguate subcomponents where it's likely to matter. This is subjective.
- Be consistent: your component should ALWAYS report same value.
Real-life examples include MSO, bpmnclient, BPELClient, (all of which are reported by SO), openECOMP (SDNC), vid (VID!) etc. (See the problem?)
Usage overlaps with InvocationID, which doesn't mean PartnerName gets retired, but which might mean it serves a more descriptive purpose. (Since it hasn't proven to be a great way of generating a call graph).
MDC - ServiceName
For EELF Audit log records that capture API requests, this field contains the name of the API invoked at the component creating the record (e.g., Layer3ServiceActivateRequest).
For EELF Audit log records that capture processing as a result of receipt of a message, this field should contain the name of the module that processes the message.
Usage is the same for indexable logs.
MDCs - the Rest
Other MDCs are logged in a wide range of contexts.
Certain MDCs and their semantics may be specific to EELF log types.
TODO: cross-reference EELF output to v1 doc.
ID | MDC | Description | Required | EELF Audit | EELF Metric | EELF Error | EELF Debug | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RequestID | See above. | Y | ||||||||||||||
InvocationID | See above. | Y | ||||||||||||||
ServiceName | See above. | Y | ||||||||||||||
PartnerName | See above. | Y | ||||||||||||||
1 | BeginTimestamp | Date-time that processing activities being logged begins. The value should be represented in UTC and formatted per ISO 8601, such | ||||||||||||||
ID | MDC | Description | Required | EELF Audit | EELF Metric | EELF Error | EELF Debug | |||||||||
1 | BeginTimestamp | Date-time that processing activities being logged begins. The value should be represented in UTC and formatted per ISO 8601, such as “2015-06-03T13:21:58+00:00”. The time should be shown with the maximum resolution available to the logging component (e.g., milliseconds, microseconds) by including the appropriate number of decimal digits. For example, when millisecond precision is available, the date-time value would be presented as, as “2015-06-03T13:21:58.340+00:00”. | Y | 2 | EndTimestamp | Date-time that processing for the request or event being logged ends. Formatting rules are the same as for the BeginTimestamp field above. In the case of a request that merely logs an event and has not subsequent processing, the EndTimestamp value may equal the BeginTimestamp value. | Y | 3 | ElapsedTime | This field contains the elapsed time to complete processing of an API call or transaction request. The time should be shown with the maximum resolution available to the logging component (e.g., | processing of a message that was received). This value should be the difference between. EndTimestamp and BeginTimestamp fields and must be expressed in millisecondsmilliseconds, microseconds) by including the appropriate number of decimal digits. For example, when millisecond precision is available, the date-time value would be presented as, as “2015-06-03T13:21:58.340+00:00”. | Y | ||||
42 | ServiceInstanceID | EndTimestamp | Date-time that processing for the request or event being logged ends. Formatting rules are the same as for the BeginTimestamp field above. This field is optional and should only be included if the information is readily available to the logging component. Transaction requests that create or operate on a particular instance of a service/resource can In the case of processing/logginga transaction request for creating a new service instance, the serviceInstanceID value is determined by either a) the MSO client and passed to MSO or b) by MSO itself upon receipt of a such a request.
NOTE: AAI won’t have a serviceInstanceUUID for every service instance. For example, no serviceInstanceUUID is available when the request is coming from an application that may import inventory data. | 5 | VirtualServerName | Physical/virtual server name. Optional: empty if determined that its value can be added by the agent that collects the log files collecting. | request that merely logs an event and has not subsequent processing, the EndTimestamp value may equal the BeginTimestamp value. | Y | ||||||||
3 | ElapsedTime | This field contains the elapsed time to complete processing of an API call or transaction request (e.g., processing of a message that was received). This value should be the difference between. EndTimestamp and BeginTimestamp fields and must be expressed in milliseconds. | Y | |||||||||||||
4 | ServiceInstanceID | This field is optional and should only be included if the information is readily available to the logging component. Transaction requests that create or operate on a particular instance of a service/resource can
NOTE: AAI won’t have a serviceInstanceUUID for every service instance. For example, no serviceInstanceUUID is available when the request is coming from an application that may import inventory data. | ||||||||||||||
5 | VirtualServerName | Physical/virtual server name. Optional: empty if determined that its value can be added by the agent that collects the log files collecting. | ||||||||||||||
6 | 6 | ServiceName | For Audit log records that capture API requests, this field contains the name of the API invoked at the component creating the record (e.g., Layer3ServiceActivateRequest). For Audit log records that capture processing as a result of receipt of a message, this field should contain the name of the module that processes the message. | Y | 7 | PartnerName | This field contains the name of the client application user agent or user invoking the API if known. | Y | 8 | StatusCode | This field indicates the high level status of the request. It must have the value COMPLETE when the request is successful and ERROR when there is a failure. | Y | ||||
97 | ResponseCode | This field contains application-specific error codes. For consistency, common error categorizations should be used. | ||||||||||||||
108 | ResponseDescription | This field contains a human readable description of the ResponseCode. | 1111 | |||||||||||||
9 | InstanceUUID | If known, this field contains a universally unique identifier used to differentiate between multiple instances of the same (named) log writing service/application. Its value is set at instance creation time (and read by it, e.g., at start/initialization time from the environment). This value should be picked up by the component instance from its configuration file and subsequently used to enable differentiation of log records created by multiple, locally load balanced ONAP component or subcomponent instances that are otherwise identically configured. | ||||||||||||||
1210 | Severity | Optional: 0, 1, 2, 3 see Nagios monitoring/alerting for specifics/details. | ||||||||||||||
1311 | TargetEntity | It contains the name of the ONAP component or sub-component, or external entity, at which the operation activities captured in this metrics log record is invoked. | Y | |||||||||||||
1412 | TargetServiceName | It contains the name of the API or operation activities invoked at the TargetEntity. | Y | |||||||||||||
1513 | Server | This field contains the Virtual Machine (VM) Fully Qualified Domain Name (FQDN) if the server is virtualized. Otherwise, it contains the host name of the logging component. | Y | |||||||||||||
1614 | ServerIPAddress | This field contains the logging component host server’s IP address if known (e.g. Jetty container’s listening IP address). Otherwise it is empty. | ||||||||||||||
1715 | ServerFQDN | Unclear, but possibly duplicating one or both of Server and ServerIPAddress. | ||||||||||||||
1816 | ClientIPAddress | This field contains the requesting remote client application’s IP address if known. Otherwise this field can be empty. | ||||||||||||||
1917 | ProcessKey | This field can be used to capture the flow of a transaction through the system by indicating the components and operations involved in processing. If present, it can be denoted by a comma separated list of components and applications. | ||||||||||||||
2018 | RemoteHost | Unknown. | ||||||||||||||
2119 | AlertSeverity | Unknown. | ||||||||||||||
2220 | TargetVirtualEntity | Unknown | ||||||||||||||
2321 | ClassName | Defunct. Doesn't require an MDC. | ||||||||||||||
2422 | ThreadID | Defunct. Doesn't require an MDC. | ||||||||||||||
2523 | CustomField1 | (Defunct now that MDCs are serialized as NVPs.) | ||||||||||||||
2624 | CustomField2 | (Defunct now that MDCs are serialized as NVPs.) | ||||||||||||||
2725 | CustomField3 | (Defunct now that MDCs are serialized as NVPs.) | ||||||||||||||
2826 | CustomField4 | (Defunct now that MDCs are serialized as NVPs.) |
Examples
SDC-BE
20170907: audit.log
...
Audit log records are intended to capture the high level view of activity within an ONAP component. Specifically, an API request handled by an ONAP component is reflected in a single Audit log record that captures the time the request was received, the time that processing was completed, as well as other information about the API request (e.g., API name, on whose behalf it was invoked, etc).
...
Metrics Log
A metric metrics log is required for EELF-enabled components, and provides a more detailed view into the processing of a transaction within an application. It captures the beginning and ending of activities needed to complete it. These can include calls to or interactions with other ONAP or non-ONAP entities.
...