...
| Order | Field Name | Property Name | Description | EELF Field | Log Spec Field | Reference | CPS Logging Field POC |
|---|---|---|---|---|---|---|---|
| GREEN FIELDS: Best Practice for Jakarta: Existing Fields Recommended | |||||||
| 1 | Timestamp | logTimeStamp | The container and container application MUST log the field “date/time” in the security audit logs. 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”. | BeginTimestamp Timestamp | LogTimeStamp |  | |
| 2 | Log Type Name | logTypeName | The container and container application MAY log the field "Log type" in security audit logs. This field will adhere to the following ENUM ::= "AUDIT" | "METRICS" | "ERROR" | "DEBUG" | "" This is here for legacy purposes. Older projects used to generate 4 separate log files. However since projects now will output all logs to STDOUT and STDERR this field is here to give projects adhering to the old standard a way to specify those log file types. NOTE: This field is optional but a placeholder is still required to be outputted. That is why the "" is included in the ENUM. | N/A | p_marker | (4) |  |
| 3 | Log Level | logLevel | The container and container application MUST use an appropriately configured logging level that can be changed dynamically. The intention of this field is to not cause performance degradation via excessive logging. This field will adhere to the following ENUM ::= "FATAL" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE" The verbosity of the logging increases from left to right. | Category Log Level | Level | (4) | |
| 4 | Trace ID | traceId | The container and container application MUST log Trace ID A trace ID is a universally unique value that identifies a single transaction request or a series of related log events within the ONAP platform. Its value is conformant to RFC4122 UUID. This value is readily and easily obtained in most programming environments. | Request ID | Transaction ID | (4) | |
| 5 | Status Code | statusCode | The container and container application MUST log a "status code" in the security audit logs. This field indicates the high level status for transactional, APIs calls, or sub operational events. This field will adhere to the following ENUM ::= "SUCCESS" | "INPROGRESS" |"FAIL_WARN" | "FAIL_ERROR" | "FAIL_FATAL"
From an end user perspective these categories should not be considered strict due to the absence of contextual information of holistic operations. There may be some circumstances where FAIL_WARN may be more serious than FAIL_ERROR. Regardless, from a developer view, FAIL_WARN, FAIL_ERROR, and FAIL_FATAL should be viewed as increasing importance and understand that the end user will need to provide additional context for their comprehension and execute and potential action from the particular failure. | Status Code | Status Code | (4) | |
| 6 | Principal ID | principalId | The container and container application MUST log the Principal identity of a requestor in the security audit logs. This field should contain the identification of the entity (user agent, client id, user, user id, login ID, non-person entity (NPE), Token, etc.) that made the request of the service or API indicated in the Service/Program Name field. For a serving API that is authenticating the request, this should be the authenticated username or equivalent. NOTE: The CPS project uses a framework that provides this field. | N/A | User | R-89474 | |
| 7 | Service / Program Name | serviceName | The container and container application MUST log the field “service or program used for access” in the security audit logs. This intention is to capture the service name endpoint or an externally advertised API invoked, e.g., where are you connecting to. This is represented as a URI or URL. NOTE: The CPS project uses a framework that provides this field. | ServiceName | ServiceName | (4) | |
| 8 | Log Message | message | The free text payload of a log event. | detailMessage | p_message | | |
...