Ralph

Installation instructions for Aspects are available on the plugin site: openedx/tutor-contrib-aspects

Ralph is an alternative option to send xAPI events to Clickhouse, providing full xAPI learning record store (LRS) statement support and deduplication (prior to Aspects version 5.0, Ralph was the default). To use Ralph as your xAPI pipeline, you need to enable it and set it as the source in your config.yml file.

RUN_RALPH: True
ASPECTS_XAPI_SOURCE: ralph

# We recommend only running one transport for performance reasons, so
# suggest turning off Vector if you are using Ralph for xAPI
RUN_VECTOR: False

When ASPECTS_XAPI_SOURCE is set to ralph, the xAPI data will be stored in the database defined by RALPH_DATABASE (defaults to xapi).

Aspects provides the following configuration options:

# If True, the public URL ralph.{{LMS_HOST}} will be made publicly
# available, otherwise Ralph will only be available on local Docker network.
RALPH_ENABLE_PUBLIC_URL: False
RALPH_PORT: 8100

# If you are running Sentry for service monitoring, you can configure it
# here to expose Ralph information.
RALPH_SENTRY_DSN: ""
RALPH_EXECUTION_ENVIRONMENT: "production"
RALPH_SENTRY_CLI_TRACES_SAMPLE_RATE: 1.0
RALPH_SENTRY_LRS_TRACES_SAMPLE_RATE: 0.1
RALPH_SENTRY_IGNORE_HEALTH_CHECKS: True

# Any extra setting for Ralph such backends or cache settings can be added
# here
RALPH_EXTRA_SETTINGS: {}

# These will be generated by Tutor automatically, but can be overridden
RALPH_ADMIN_USERNAME: "admin"
RALPH_ADMIN_PASSWORD: "secure-password"
RALPH_LMS_USERNAME: "lms"
RALPH_LMS_PASSWORD: "secure-password"

To connect an external Ralph instance, you can use the following configuration:

# Turns off running Ralph in the Tutor environment
RUN_RALPH: False

# The hostname of your existing Ralph installation
RALPH_HOST: "ralph.example.com"

# If True, Aspects will connect to Ralph via HTTPS instead of HTTP
RALPH_RUN_HTTPS: False