Welcome to the Open edX Aspects documentation!#
Aspects is an analytics system for Open edX, bringing actionable data about course and learner performance to instructors and site operators. It is primarily a Tutor plugin that ties together data from the Open edX learning management system and Studio using open source tools to aggregate and transform learning traces into data visualizations.
As of September 2023 it is in beta and seeking testers, which you can learn about at the beta wiki page.
Installation instructions are available on the plugin site: openedx/tutor-contrib-aspects
You can get started reading about the project in the Aspects Overview, or look through the various pages below for more details!
- Concepts
- Decisions
- 1. Open Analytics
- 2. xAPI for Default Data Transfer and Storage
- 3. Superset as Data Visualizer
- 4. ClickHouse as Analytic Database
- 5. Ralph as Learning Record Store
- 6. Areas of Responsibility
- 7. Alembic migrations
- 8. Project Structure
- 9. Personally-identifying information (PII)
- 10. Localization of user-facing content
- 11. Course and block data
- 12. Clickhouse vs dbt
- 13. Clickhouse experimental and beta features
- 14. dbt State Management
- How-Tos
- Upgrade Aspects
- Changing the xAPI actor identifier
- Backfill old or missing data
- Superset extra assets
- Superset language settings
- Superset extra row level security
- Superset extra jinja filters
- Superset custom roles
- Clickhouse extra SQL
- Connect to external Clickhouse database
- Extending dbt
- Run Aspects in a ClickHouse cluster
- xAPI Transforms
- Quickstarts
- Reference