Skip to content
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.0+2026.01.15T15.07.43.223Z.b5e4caee.berickson.20260113.comm.protocol.scope
0.1.0+2026.01.20T19.54.05.825Z.d2a08f21.berickson.20260120.integration.logging
6 changes: 6 additions & 0 deletions docs/reference/system_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ runtime.
| --- | --- | --- | --- |
| `dashboard_settings.logging_enabled` | Determine if we should log dashboard sessions. | `false` | [`learning_observer/learning_observer/dashboard.py`](../../learning_observer/learning_observer/dashboard.py) |

### LMS Integration (`lms_integration` namespace)

| YAML path | Description | Default | Used in |
| --- | --- | --- | --- |
| `lms_integration.logging_enabled` | Determine if we should log lms integration calls. | `false` | [`learning_observer/learning_observer/log_event.py`](../../learning_observer/learning_observer/log_event.py) |

### Redis connection (`redis_connection` namespace)

| YAML path | Description | Default | Used in |
Expand Down
2 changes: 1 addition & 1 deletion learning_observer/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.0+2026.01.15T15.07.43.223Z.b5e4caee.berickson.20260113.comm.protocol.scope
0.1.0+2026.01.20T19.54.05.825Z.d2a08f21.berickson.20260120.integration.logging
3 changes: 2 additions & 1 deletion learning_observer/learning_observer/dashboard.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@
pmss.register_field(
name='logging_enabled',
type=pmss.pmsstypes.TYPES.boolean,
description='Log dashboard sessions to .dashboard.log files',
description='Allow data to be logged or not. Used in within namespaces '\
'such as `dashboard_settings` or `lms_integration`.',
default=False
)

Expand Down
38 changes: 36 additions & 2 deletions learning_observer/learning_observer/integrations/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ async def raw_api_ajax(
method='get',
json_body=None,
data=None,
api_name=None,
endpoint_name=None,
**kwargs
):
'''
Expand Down Expand Up @@ -139,6 +141,24 @@ async def raw_api_ajax(
else:
response = await resp.text()
learning_observer.log_event.log_ajax(target_url, response, request)
lms_payload = {
'event': 'lms_integration',
'api_name': api_name,
'endpoint': endpoint_name,
'method': method.upper(),
'url': url,
'params': kwargs,
'response': response
}
if json_body is not None:
lms_payload['request_json'] = json_body
if data is not None:
lms_payload['request_data'] = data
try:
lms_payload[learning_observer.constants.USER] = request[learning_observer.constants.USER]
except KeyError:
lms_payload[learning_observer.constants.USER] = None
learning_observer.log_event.log_lms_integration(lms_payload)

if cache_available:
if settings.feature_flag('use_clean_ajax') is not None:
Expand All @@ -149,7 +169,17 @@ async def raw_api_ajax(
return response


def raw_access_partial(remote_url, key_translator=None, cache=None, cache_key_prefix=None, name=None, headers=None, method='get'):
def raw_access_partial(
remote_url,
key_translator=None,
cache=None,
cache_key_prefix=None,
name=None,
headers=None,
method='get',
api_name=None,
endpoint_name=None
):
'''
This is a helper which allows us to create a function which calls specific
API endpoints.
Expand All @@ -170,6 +200,8 @@ async def caller(runtime, **kwargs):
method,
json_body=json_body,
data=data,
api_name=api_name,
endpoint_name=endpoint_name,
**kwargs
)

Expand Down Expand Up @@ -278,7 +310,9 @@ async def cleaner_local(runtime, **kwargs):
cache_key_prefix=cache_key_prefix,
name=e.name,
headers=e.headers,
method=e.method
method=e.method,
api_name=api_name,
endpoint_name=e.name
)
result_functions[function_name] = raw_function
cleaners = e._cleaners()
Expand Down
21 changes: 21 additions & 0 deletions learning_observer/learning_observer/log_event.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,27 @@ def log_ajax(url, resp_json, request):
with open(filename, "w") as ajax_log_fp:
ajax_log_fp.write(encoded_payload)


def log_lms_integration(payload):
'''
Log LMS integration payloads for long-term analysis.

Captures LMS data like rosters, courses, and grades so we can
review historical context beyond immediate runtime.
'''
user = payload.get(learning_observer.constants.USER, {}) or {}
user_domain = learning_observer.util.get_domain_from_email(user.get('email'))
should_log = settings.pmss_settings.logging_enabled(
types=['lms_integration'],
attributes={'domain': user_domain}
)
if not should_log:
return
payload.setdefault('timestamp', datetime.datetime.utcnow().isoformat())
encoded_payload = json.dumps(payload, sort_keys=True, default=str)
log_event(encoded_payload, filename="lms_integration", preencoded=True)


def close_logfile(filename):
# remove the file from the dict storing open log files and close it
if filename not in files:
Expand Down
Loading