Purpose

With the validate and select command newly implemented, it is now possible to implement edx tracking logs events pydantic models to validate incoming events in ralph.

Proposal

The first events implemented are the easiest (navigation).

• [x] event models
• [x] event fixtures
• [x] event tests

Purpose

Add WebSocket to Backends documentation

Proposal

WebSocket

The webSocket backend is read-only and can be used to get real-time events.

If you use OVH's Logs Data Platform (LDP), you can retrieve a WebSocket URI to test your data stream by following instructions from the official documentation.

Backend parameters

• ws_uri: the WebSocket uri (e.g. wss://example.com/websocket)

Purpose

The edx server events are the most simple and common events in the edx tracking logs. They are logged at almost all requests made to the edx lms. We want to convert them into xAPI format.

Proposal

ServerEventSchema validates the edx server event.

ServerEventToXapi uses the ServerEventSchema to validate the edx server event and then converts it to xAPI format.

XapiConverterSelector deserializes the edx events and tries to match a known converter for the event conversion.

Purpose

Add Helm chart for Ralph

Description

Created the chart under src/helm I tried to migrate the logic from the .j2 tray files. The version label was replaced as the helm convention for app.kubernetes.io/version The checksum from the secret name was deleted. The annotation checksum/config: was used instead on the secret, the checksum is automatically generated from vault.yaml it help to update the secret object every time a value is updated. Note that the .Chart.AppVersion is better used to track the version deployed and it should reflect the image.tag There is only one vars files values.yaml the vault is under specific file vault.yaml used only for generating the secrets.

Questions

• Why do you have two service with the same config? the only difference is the label static
• What is deployment_stamp ?
• What is the purpose of prefix ?
• How would you like to manage env.?

ToDo

• [ ] Add README.md

You can use helm template . under ./src/helm/ralph to check the output of the chart, it will show you the final manifest that will be deployed.

Purpose

MongoDB is a classical database for LRSs such as LearningLocker or Apereo Learning Analytics Initiative. Supporting this backend seems a must-have for Ralph.

Proposal

• [x] add LearningLocker parser
• [x] add MongoDB backend
• [x] ~add learning locker parser~ edit: postponed to a new PR

Purpose

edX video events can be converted to xAPI for most of them. The interaction events can still not be converted.

Proposal

• [x] load_video to initialized
• [x] play_video to played
• [x] pause_video to paused
• [x] stop_video to terminated
• [x] seek_video to seeked

Purpose

These pydantic models can be used for xAPI format validation.

Proposal

The page_viewed pydantic model correspond to the edX simple server event. The page_terminated pydantic model correspond to the edX page_close browser event.

• [X] page_viewed pydantic model
• [X] page_terminated pydantic model
• [x] tests

Purpose

The edx server events are the most simple and common events in the edx tracking logs. They are logged at almost all requests made to the edx lms. We want to validate them.

Proposal

• [x] ServerEventModel
• [x] ServerEventFactory
• [x] Tests

Purpose

• A event test fixture factory could help to test the function of the GELFParser

Proposal

• [ ] Implementation of the event test fixture factory

Purpose

• Document the different events that are logged as "tracking logs" in the LMS to understand how, were and when things get logged
• A event test fixture factory could help to test the function of the GELFParser

Proposal

• [ ] Implementation of the event test fixture factory
• [ ] Events documentation

Purpose

Generating credentials to authenticate to our LRS should be smooth and painless for our users.

Proposal

• [x] add a new auth command to ease new user credentials generation
• [x] add pydantic models for user credentials checking and credentials file validation
• [x] track authentication issues to the LRS server

Bug Report

Hi all, I'm excited to get started developing with Ralph. Getting set up I ran into an issue, however. On the master branch make bootstrap errors out pip installing psutil due to gcc not being available.

Expected behavior/code make bootstrap builds the docker images cleanly.

Actual Behavior An error occurs:

#0 22.22       creating build/temp.linux-aarch64-cpython-39/psutil
#0 22.22       gcc -pthread -Wno-unused-result -Wsign-compare -DNDEBUG -g -fwrapv -O3 -Wall -fPIC -DPSUTIL_POSIX=1 -DPSUTIL_SIZEOF_PID_T=4 -DPSUTIL_VERSION=594 -DPy_LIMITED_API=0x03060000 -DPSUTIL_LINUX=1 -DPSUTIL_ETHTOOL_MISSING_TYPES=1 -I/usr/local/include/python3.9 -c psutil/_psutil_common.c -o build/temp.linux-aarch64-cpython-39/psutil/_psutil_common.o
#0 22.22       C compiler or Python headers are not installed on this system. Try to run:
#0 22.22       sudo apt-get install gcc python3-dev
#0 22.22       error: command 'gcc' failed: No such file or directory

Steps to Reproduce

1. Sync the Ralph master branch
2. run make bootstrap
3. The above error occurs

Environment

• Ralph version: master branch
• Platform: Docker Desktop on Mac OS 13.0.1

Possible Solution I was able to get a successful build by adding the required development tools, see the PR here: https://github.com/bmtcril/ralph/pull/1

Purpose

Ralph can be deployed to a Kubernetes cluster using its official Helm Chart. We need a step-by-steph guide to use it.

Proposal

This tutorial guides you to the deployment of a complete learning analytics stack to Kubernetes using Helm.

Purpose

xAPI forum used in ashley models have to be described in ralph for validation purpose and usage of ralph as a library

Proposal

• [ ] Define pydantic models associated to each forum learning statement templates
• [ ] Define selector for each model
• [ ] Write model and selector tests

Purpose

It has been decided that we use typing in all ralph project. We have to integrate a static type checker in our linting toolbox.

Proposal

• Integrate mypy in the project (local tooling for development + CI)

Purpose

Storage and Database backends have similar interfaces and usage.

Proposal

Unify the interfaces of database and storage backends into a single DataBackend interface.

• [x] add Data and LRS Backend interfaces
• [x] add FileSystemDataBackend

Purpose

ORA2 events describe the activity for assessments pair reviewing. Edx defined models and their selectors are described with Pydantic.

Proposal

Define Pydantic model for:

• openassessmentblock.create_submission,
• openassessmentblock.get_peer_submission,
• openassessmentblock.get_submission_for_staff_grading,
• openassessmentblock.peer_assess,
• openassessmentblock.save_submission,
• openassessmentblock.self_assess,
• openassessmentblock.staff_assess,
• openassessmentblock.student_training_assess_example,
• openassessment.submit_feedback_on_assessments,
• openassessment.upload_file,