Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add mdc/attribute type column

...

  • Must be set as early in invocation as possible. 
  • Must be unset on exit. 
MDCNameGroupDescription

Applicable

(per log file)

Marker Associations

Moved

MDC

to


standard

attribute


Removed

(was in

older

spec)

Required?

Y/N/C

(C= context dependent)

N = not required


DerivedAcumos
ref
Use Cases

Code References

RequestID


UUID to track the processing of each client request across all the ONAP components involved in its processing





Y


In general

https://git.onap.org/logging-analytics/tree/reference/logging-slf4j-demo/src/test/java/org/onap/logging/ref/slf4j/demo/component/AbstractComponentTest.java

InvocationID

UUID correlates log entries relating to a single invocation of a single component





Y



InstanceUUID

UUID to differentiate between multiple instances of the same (named) log writing service/application





Y



ServiceName

The service inside the partner doing the call - includes API name





Y



PartnerName

unauthenticated = The part of the URI specifying the agent that the caller used to make the call to the component that is logging the message.

authenticated = userid





Y
user

StatusCode

This field indicates the high level status of the request - one of (COMPLETE, ERROR, INPROGRESS)






Y


20180807: expand from 2 fields to add "INPROGRESS"

addresses Chris Lott question on https://wiki.acumos.org/display/OAM/Log+Standards

ResponseCode
This field contains application-specific error codes.



Y





ResponseDescription
This field contains a human readable description of the ResponseCode



Y





Severity

Logging level by default aligned with the reported log level - one of INFO/TRACE/DEBUG/WARN/ERROR/FATAL





Y
level (but numbers)

ServerFQDN

The VM FQDN if the server is virtualized. Otherwise the host name of the logging component.





Y





ClientIPAddress

This field contains the requesting remote client application’s IP address if known. Otherwise empty.





Y





Message
Freeform text (optional)



C


Notes: re-added 20180807 - aligns with Acumos

Add specifically for debug/error but other audit/metrics are not required

EntryTimestamp


UTC Date-time that processing activities being logged begins - if part of an ENTRY marker





C
see calc of ElapsedTime

InvokeTimestamp


Timestamp on invocation start - if part of an INVOKE marker





C



TargetEntity

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.





C



TargetServiceName

The name  of the API or operation activities invoked (name on the remote/target application) at the TargetEntity.  





C



TargetElement

VNF/PNF context dependent - on CRUD operations of VNF/PNFs

The IDs that need to be covered with the above Attributes are

       -        VNF_ID OR VNFC_ID : (Unique identifier for a VNF asset that is being instantiated or that would generate an alarms)

       -        VSERVER_ID OR VM_ID (or vmid): (Unique identified for a virtual server or virtual machine on which a Control Loop action is usually taken on, or that is installed  as part of instantiation flow)

       -        PNF : (What is the Unique identifier used within ONAP)





C



...