1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
# ============LICENSE_START=======================================================
# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
from logging import getLogger, Formatter
from logging.handlers import RotatingFileHandler
from os import makedirs
import datetime
LOGGER = getLogger("defaultlogger")
_AUDIT_LOGGER = getLogger("defaultlogger")
_ERROR_LOGGER = getLogger("defaultlogger")
def _create_logger(name, logfile):
"""
Create a RotatingFileHandler and a streamhandler for stdout
https://docs.python.org/3/library/logging.handlers.html
what's with the non-pythonic naming in these stdlib methods? Shameful.
"""
logger = getLogger(name)
file_handler = RotatingFileHandler(logfile,
maxBytes=10000000, backupCount=2) # 10 meg with one backup..
formatter = Formatter('%(message)s')
file_handler.setFormatter(formatter)
logger.setLevel("DEBUG")
logger.addHandler(file_handler)
return logger
def create_loggers():
"""
Public method to set the global logger, launched from Run
"""
makedirs("/opt/logs", exist_ok=True)
# create the audit log
aud_file = "/opt/logs/audit.log"
open(aud_file, 'a').close() # this is like "touch"
global _AUDIT_LOGGER
_AUDIT_LOGGER = _create_logger("config_binding_service_audit", aud_file)
# create the error log
err_file = "/opt/logs/error.log"
open(err_file, 'a').close() # this is like "touch"
global _ERROR_LOGGER
_ERROR_LOGGER = _create_logger("config_binding_service_error", err_file)
def utc():
"""gets current time in utc"""
return datetime.datetime.utcnow()
def audit(raw_request, bts, xer, rcode, calling_mod, msg="n/a"):
"""
write an EELF audit record per https://wiki.onap.org/download/attachments/1015849/ONAP%20application%20logging%20guidelines.pdf?api=v2
%The audit fields implemented:
1 BeginTimestamp Implemented (bts)
2 EndTimestamp Auto Injected when this is called
3 RequestID Implemented (xer)
7 serviceName Implemented (from Req)
9 StatusCode Auto injected based on rcode
10 ResponseCode Implemented (rcode)
15 Server IP address Implemented (from Req)
16 ElapsedTime Auto Injected (milliseconds)
18 ClientIPaddress Implemented (from Req)
19 class name Implemented (mod), though docs say OOP, I am using the python module here
20 Unused ...implemented....
21-25 Custom n/a
26 detailMessage Implemented (msg)
"""
ets = utc()
_AUDIT_LOGGER.info("{bts}|{ets}|{xer}||||{path}||{status}|{rcode}|||||{servip}|{et}||{clientip}|{calling_mod}|||||||{msg}".format(
bts=bts.isoformat(),
ets=ets.isoformat(),
xer=xer, rcode=rcode,
path=raw_request.path.split("/")[1],
status="COMPLETE" if rcode == 200 else "ERROR",
servip=raw_request.host.split(":")[0],
et=int((ets - bts).microseconds / 1000), # supposed to be in milleseconds
clientip=raw_request.remote_addr,
calling_mod=calling_mod, msg=msg
))
def error(raw_request, xer, severity, ecode, tgt_entity="n/a", tgt_path="n/a", msg="n/a", adv_msg="n/a"):
"""
write an EELF error record per
the error fields implemented:
1 Timestamp Auto Injected when this is called
2 RequestID Implemented (xer)
4 ServiceName Implemented (from Req)
6 TargetEntity Implemented (tgt_entity)
7 TargetServiceName Implemented (tgt_path)/
8 ErrorCategory Implemented (severity)
9. ErrorCode Implemented (ecode)
10 ErrorDescription Implemented (msg)
11. detailMessage Implemented (adv_msg)
Not implemented:
3 ThreadID - n/a
5 PartnerName - nothing in the request tells me this
"""
ets = utc()
_ERROR_LOGGER.error("{ets}|{xer}||{path}||{tge}|{tgp}|{sev}|{ecode}|{msg}|{amsg}".format(
ets=ets,
xer=xer,
path=raw_request.path.split("/")[1],
tge=tgt_entity,
tgp=tgt_path,
sev=severity,
ecode=ecode,
msg=msg,
amsg=adv_msg))
|
