Xue,
Hi, I (we) greatly appreciate your review of the spec as we try to make it
clearer and finalized.
I have added some initial answers inline.
I expect to have more detailed answers in the next 48 hours - as we prepare
for a demo of the RI library, the aop wrapper and some use cases. In prep of
working to get the renewed Casablanca spec implemented starting with a couple
components.
Thank you
/michael
From: Gao, Xue <[email protected]>
Sent: Monday, July 9, 2018 9:29 AM
To: [email protected]; Michael O'Brien <[email protected]>
Subject: [onap-discuss] [CLAMP] Onap Application Logging Specification v1.2
Hello Obrien,
I am checking the requirement of Onap application logging specification v1.2
for Clamp. Some of the requirement is not very clear to me, could you please
explain in a bit more in detail regarding to the following items?
1. For MDC parameters, the parameters shall be set at the beginning of the
API call and cleared at the end of the call, right?
Mike: Most MDCs are passed around between calls like the requestID via the
HttpServletRequest, some are created per call like the invocationID - I will
add a column for lifecycle - as this is a good question.
Mike: the goal is to impact the code/teams as little as possible - an AOP
example wrapper around Luke's Log4j library is being reviewed right now - in
this case more geared to automatically handling ENTRY/EXIT markers using
aspects.
1. Some MDC parameters are mandatory, but is that apply to all logs? I
understand those parameters are valuable for transactions among ONAP
components, but we also have logs which is internal for Clamp, for example, we
have logs indicating initialization of Clamp is successful at the starting up
time. These types of logs does not involve any API triggering, in that case,
what value should be set for parameters such as StatusCode, ResponseCode,
ClientIPAddress etc..
Mike: There will be 2 levels to MDC's - some like IP addresses that do not
change inside a cluster will be set once and referenced - the library and it's
AOP wrapper will attempt to handle these global values. Other internal logs
specific to CLAMP or Acumos for example can be in custom fields.
1. For clamp, we use EELF and we have different types of logs: debug.log,
error.log, audit.log and metric.log. I wonder, is the log output pattern
applied for all these logs? Plus, is the retention requirement meant for
individual type of log, which means, each log file should be <=50MB before
rollover and total log files of that particular type capped at 10GB?
Mike: logback.xml can be fine tuned for each log file currently - however the
goal is to use one single log specification (and one log file) - and
differentiate debug/error/audit using MARKERS.
1. For MDC parameter StatusCode, does it with type Enum? I have seen you
mention "COMPLETE" and "ERROR" as example, any other values we could use for
it? What about ResponseCode, is that with type Enum or each App can define
their own type of ResponseCode?
Mike: I would expect that the enum can be extended - I will verify this and
update the spec when I code up an example
1. Will the Marker logs all be written into the audit log? In some of your
example, marker log is in audit log for EELF example, some in metrics log. I
wonder, is there a rule where will all marker logs be?
Mike: Right: not clear - will fix - marker logs should be the same across all
the log files - in prep of being log-file-agnostic for Dublin.
https://wiki.onap.org/pages/viewpage.action?pageId=28378955#ONAPApplicationLoggingSpecificationv1.2(Casablanca)-LoggingResults
An example ENTRY (entering) log
2018-07-09T14:48:01.014Z http-nio-8080-exec-8 INFO
org.onap.demo.logging.ApplicationService
InstanceUUID=67bc4b12-56a1-4b62-ab78-0c8ca8834383,
RequestID=023af35a-b281-49c4-bf13-5167b1453780,
ServiceName=/logging-demo/rest/health/health,
InvocationID=94dc9e24-3722-43e5-8995-12f95e153ca3,
InvokeTimestamp=2018-07-09T14:48:01.008Z,
PartnerName=,
ClientIPAddress=0:0:0:0:0:0:0:1,
ServerFQDN=localhost ENTRY
[cid:[email protected]]
[cid:[email protected]]
Thanks for your reply in advance!
Kind regards,
Xue
This message and the information contained herein is proprietary and
confidential and subject to the Amdocs policy statement,
you may review at https://www.amdocs.com/about/email-disclaimer
<https://www.amdocs.com/about/email-disclaimer>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#10983): https://lists.onap.org/g/onap-discuss/message/10983
Mute This Topic: https://lists.onap.org/mt/23205745/21656
Group Owner: [email protected]
Unsubscribe: https://lists.onap.org/g/onap-discuss/unsub
[[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
