mirror of
https://github.com/GSA/notifications-admin.git
synced 2025-12-12 08:03:20 -05:00
9a83ba7475
This changeset pulls in all of the notification_utils code directly into the admin and removes it as an external dependency. We are doing this to cut down on operational maintenance of the project and will begin removing parts of it no longer needed for the admin. Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
134 lines
4.1 KiB
Python
134 lines
4.1 KiB
Python
import logging
|
|
import logging.handlers
|
|
import sys
|
|
from itertools import product
|
|
|
|
from flask import g, request
|
|
from flask.ctx import has_app_context, has_request_context
|
|
from flask.logging import default_handler
|
|
from pythonjsonlogger.jsonlogger import JsonFormatter as BaseJSONFormatter
|
|
|
|
LOG_FORMAT = (
|
|
"%(asctime)s %(app_name)s %(name)s %(levelname)s "
|
|
'%(request_id)s %(service_id)s "%(message)s" [in %(pathname)s:%(lineno)d]'
|
|
)
|
|
TIME_FORMAT = "%Y-%m-%dT%H:%M:%S"
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def init_app(app):
|
|
app.config.setdefault("NOTIFY_LOG_LEVEL", "INFO")
|
|
app.config.setdefault("NOTIFY_APP_NAME", "none")
|
|
|
|
app.logger.removeHandler(default_handler)
|
|
|
|
handlers = get_handlers(app)
|
|
loglevel = logging.getLevelName(app.config["NOTIFY_LOG_LEVEL"])
|
|
loggers = [
|
|
app.logger,
|
|
logging.getLogger("utils"),
|
|
logging.getLogger("notifications_python_client"),
|
|
logging.getLogger("werkzeug"),
|
|
]
|
|
for logger_instance, handler in product(loggers, handlers):
|
|
logger_instance.addHandler(handler)
|
|
logger_instance.setLevel(loglevel)
|
|
warning_loggers = [logging.getLogger("boto3"), logging.getLogger("s3transfer")]
|
|
for logger_instance, handler in product(warning_loggers, handlers):
|
|
logger_instance.addHandler(handler)
|
|
logger_instance.setLevel(logging.WARNING)
|
|
app.logger.info("Logging configured")
|
|
|
|
|
|
def get_handlers(app):
|
|
handlers = []
|
|
standard_formatter = logging.Formatter(LOG_FORMAT, TIME_FORMAT)
|
|
json_formatter = JSONFormatter(LOG_FORMAT, TIME_FORMAT)
|
|
|
|
stream_handler = logging.StreamHandler(sys.stdout)
|
|
if not app.debug:
|
|
handlers.append(configure_handler(stream_handler, app, json_formatter))
|
|
else:
|
|
# turn off 200 OK static logs in development
|
|
def is_200_static_log(log):
|
|
msg = log.getMessage()
|
|
return not ("GET /static/" in msg and " 200 " in msg)
|
|
|
|
logging.getLogger("werkzeug").addFilter(is_200_static_log)
|
|
|
|
# human readable stdout logs
|
|
handlers.append(configure_handler(stream_handler, app, standard_formatter))
|
|
|
|
return handlers
|
|
|
|
|
|
def configure_handler(handler, app, formatter):
|
|
handler.setLevel(logging.getLevelName(app.config["NOTIFY_LOG_LEVEL"]))
|
|
handler.setFormatter(formatter)
|
|
handler.addFilter(AppNameFilter(app.config["NOTIFY_APP_NAME"]))
|
|
handler.addFilter(RequestIdFilter())
|
|
handler.addFilter(ServiceIdFilter())
|
|
|
|
return handler
|
|
|
|
|
|
class AppNameFilter(logging.Filter):
|
|
def __init__(self, app_name):
|
|
self.app_name = app_name
|
|
|
|
def filter(self, record):
|
|
record.app_name = self.app_name
|
|
|
|
return record
|
|
|
|
|
|
class RequestIdFilter(logging.Filter):
|
|
@property
|
|
def request_id(self):
|
|
default = "no-request-id"
|
|
if has_request_context() and hasattr(request, "request_id"):
|
|
return request.request_id or default
|
|
elif has_app_context() and "request_id" in g:
|
|
return g.request_id or default
|
|
else:
|
|
return default
|
|
|
|
def filter(self, record):
|
|
record.request_id = self.request_id
|
|
|
|
return record
|
|
|
|
|
|
class ServiceIdFilter(logging.Filter):
|
|
@property
|
|
def service_id(self):
|
|
default = "no-service-id"
|
|
if has_app_context() and "service_id" in g:
|
|
return g.service_id or default
|
|
else:
|
|
return default
|
|
|
|
def filter(self, record):
|
|
record.service_id = self.service_id
|
|
|
|
return record
|
|
|
|
|
|
class JSONFormatter(BaseJSONFormatter):
|
|
def process_log_record(self, log_record):
|
|
rename_map = {
|
|
"asctime": "time",
|
|
"request_id": "requestId",
|
|
"app_name": "application",
|
|
"service_id": "service_id",
|
|
}
|
|
for key, newkey in rename_map.items():
|
|
log_record[newkey] = log_record.pop(key)
|
|
log_record["logType"] = "application"
|
|
try:
|
|
log_record["message"] = log_record["message"].format(**log_record)
|
|
except (KeyError, IndexError) as e:
|
|
logger.exception("failed to format log message: {} not found".format(e))
|
|
return log_record
|