Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(logs): improve signed URL data metrics log by adding client_id … #1130

Merged
merged 5 commits into from
Jan 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions fence/blueprints/data/indexd.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def get_signed_url_for_file(
r_pays_project = flask.request.args.get("userProject", None)
db_session = db_session or current_app.scoped_session()

# default to signing the url
# default to signing the URL
force_signed_url = True
no_force_sign_param = flask.request.args.get("no_force_sign")
if no_force_sign_param and no_force_sign_param.lower() == "true":
Expand Down Expand Up @@ -162,13 +162,14 @@ def get_signed_url_for_file(
_log_signed_url_data_info(
indexed_file=indexed_file,
user_sub=flask.g.audit_data.get("sub", ""),
client_id=_get_client_id(),
requested_protocol=requested_protocol,
)

return {"url": signed_url}


def _log_signed_url_data_info(indexed_file, user_sub, requested_protocol):
def _log_signed_url_data_info(indexed_file, user_sub, client_id, requested_protocol):
size_in_kibibytes = (indexed_file.index_document.get("size") or 0) / 1024
acl = indexed_file.index_document.get("acl")
authz = indexed_file.index_document.get("authz")
Expand All @@ -192,10 +193,21 @@ def _log_signed_url_data_info(indexed_file, user_sub, requested_protocol):
break

logger.info(
f"Signed URL Generated. size_in_kibibytes={size_in_kibibytes} acl={acl} authz={authz} bucket={bucket} user_sub={user_sub}"
f"Signed URL Generated. size_in_kibibytes={size_in_kibibytes} "
f"acl={acl} authz={authz} bucket={bucket} user_sub={user_sub} client_id={client_id}"
k-burt-uch marked this conversation as resolved.
Show resolved Hide resolved
)


def _get_client_id():
client_id = "Unknown Client"

try:
client_id = current_token.get("azp") or "Unknown Client"
except Exception as exc:
pass

return client_id

def prepare_presigned_url_audit_log(protocol, indexed_file):
"""
Store in `flask.g.audit_data` the data needed to record an audit log.
Expand Down Expand Up @@ -423,7 +435,7 @@ class IndexedFile(object):
also be cleaner).

Args:
file_id (str): GUID for the file.
file_id (str): GUID for the file
"""

def __init__(self, file_id):
Expand Down
Loading