https://github.com/openedx/tutor-contrib-aspects

The Open Analytics Reference System - Tutor plugin
https://github.com/openedx/tutor-contrib-aspects

Last synced: about 1 month ago
JSON representation

The Open Analytics Reference System - Tutor plugin

• Host: GitHub
• URL: https://github.com/openedx/tutor-contrib-aspects
• Owner: openedx
• License: agpl-3.0
• Created: 2023-02-07T05:22:39.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T15:25:26.000Z (9 months ago)
• Last Synced: 2024-04-13T02:41:11.004Z (9 months ago)
• Language: Python
• Size: 1.81 MB
• Stars: 8
• Watchers: 4
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
The Aspects plugin for Tutor

============================

Aspects Learner Analytics combines several free, open source, tools to add analytics and reporting capabilities to the Open edX platform. This plugin offers easy installation, configuration, and deployment of these tools using `Tutor `__. The tools Aspects uses are:

- `ClickHouse `__, a fast, scalable analytics database that can be run anywhere

- `Apache Superset `__, a data visualization platform and data API

- `OpenFUN Ralph `__, a Learning Record store (and more) that can validate and store xAPI statements in ClickHouse

- `Vector `__, a log forwarding tool that can be used to forward tracking log and xAPI data to ClickHouse

- `event-routing-backends `__, an Open edX plugin that transforms tracking logs into xAPI and optionally forwards them to one or more Learning Record Stores in near real time

- `event-sink-clickhouse `__, an Open edX plugin that exports course structure and high level data to ClickHouse at publish time

- `dbt `__, a tool to build data pipelines from SQL queries. The dbt project used by this plugin is `aspects-dbt `__.

See https://github.com/openedx/openedx-aspects for more details about the Aspects architecture and high level documentation.

Aspects is a community developed effort combining the Cairn project by Overhang.io and the OARS project by EduNEXT, OpenCraft, and Axim Collaborative.

Note: Aspects is beta and not yet production ready! Please feel free to experiment with the system and offer feedback about what you'd like to see by adding Issues in this repository. Current details on the beta progress can be found here: https://openedx.atlassian.net/wiki/spaces/COMM/pages/3861512203/Aspects+Beta

Compatibility

-------------

This plugin is compatible with Tutor 15.0.0 and later and is expected to be compatible with Open edX releases from Nutmeg forward.

Installation

------------

Aspects is implemented as a Tutor plugin. Documentation will be coming soon to cover how to install Aspects in non-Tutor environments, but by far the easiest way to try and install it is via Tutor. These instructions assume you are running a `tutor local` install, which is the fastest and easiest way to get started.

#. Install Tutor: https://docs.tutor.overhang.io/install.html#install

#. Create an admin user on the LMS: https://docs.tutor.overhang.io/whatnext.html#logging-in-as-administrator

#. Install the Aspects plugin (in your Tutor Python environment)::

    pip install tutor-contrib-aspects

#. Enable the plugins::

    tutor plugins enable aspects

#. Save the changes to the environment::

    tutor config save

#. Because we're installing new applications in LMS (event-routing-backends, event-sink-clickhouse) you will need to rebuild your openedx Docker image::

    tutor images build openedx --no-cache

#. Build the Aspects-flavored Superset image to bake your settings (such as database passwords) into the Superset assets::

    tutor images build aspects-superset

#. Run the initialization scripts::

    tutor local do init

At this point you should have a working Tutor / Aspects environment, but with no way to create data! There are a few options for how to proceed.

#. If you would just like to see some data populated in the charts without loading a real course in the LMS you can create test data in the database (use ``--help`` for usage)::

        tutor local do load-xapi-test-data

#. OR Load the test course and generate real data from the LMS:

   #. https://docs.tutor.overhang.io/whatnext.html#importing-a-demo-course

   #. Log into the LMS with your admin user and enroll / proceed through the demo course

#. OR If you are adding Aspects to an existing LMS that already has data

   #. Sink course data from the LMS to clickhouse (see https://github.com/openedx/openedx-event-sink-clickhouse for more information)::

       tutor local do dump-data-to-clickhouse --options "--object course_overviews"

   #. Sink Historical event data to ClickHouse::

       tutor [dev|local] do transform-tracking-logs \

         --source_provider LOCAL --source_config '{"key": "/openedx/data", "container":

            "logs", "prefix": "tracking.log"}' \

         --transformer_type xapi

       # Note that this will work only for default tutor installation. If you store your tracking logs any other way, you need to change the source_config option accordingly.

       # See https://event-routing-backends.readthedocs.io/en/latest/howto/how_to_bulk_transform.html#sources-and-destinations for details on how to change the source_config option.

#. If your assets have changed since the last time you ran init, you will need to rebuild the aspects-superset image and re-import the assets::

    tutor images build aspects-superset --no-cache

    tutor local do import-assets

#. Make sure to build and push your Superset image in the following cases:

   #. If you have made changes to the Superset assets.

   #. If you have made changes to the Clickhouse/DBT schema.

   #. If you are using custom translations.

You should now have data to look at in Superset! Log in to https://superset.local.overhang.io/ with your admin account and you should see charts with your data.

Aspects Autoscaling

-------------------

Aspects adds default autoscaling values for `Ralph`, `Superset` and the `Superset Worker` deployments via

`tutor-contrib-pod-autoscaling `_. To apply the

autoscaling settings make sure to install the plugin and enable it. To modify the autoscaling values

see the `Configuration `_ section.

Superset Assets

---------------

Aspects maintains the Superset assets in this repository, specifically the dashboards,

charts, datasets, and databases. That means that any updates made here will be reflected

on your Superset instance when you update your deployment.

But it also means that any local changes you make to these assets will be overwritten

when you update your deployment. To prevent your local changes from being overwritten,

please create new assets and make your changes there instead. You can copy an existing

asset by editing the asset in Superset and selecting "Save As" to save it to a new name.

# Note: If you are using custom assets you will need to rebuild your aspects-superset

# image on your local machine with `tutor images build aspects-superset --no-cache`.

Assets (charts/datasets) created for Aspects that are no longer used can be listed in 

`aspects_asset_list.yaml`. These assets & any translated assets created from them, 

are deleted from Superset during `init` (specifically `import-assets`). The corresponding 

YAML files are deleted during `import_superset_zip` or and `check_superset_assets`.

Sharing Charts and Dashboards

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To share your charts with others in the community, use Superset's "Export" button to

save a zip file of your charts and related datasets.

.. warning::

    The exported datasets will contain hard-coded references to your particular

    databases, including your database hostname, port, and username, in some cases

    it may also contain database passwords. It is vital that you review the

    database and dataset files before sharing them.

To import charts or dashboards shared by someone in the community:

#. Expand the zip file and look for any files added under ``databases``.

   Update the ``sqlalchemy_uri`` to match your database's connection details.

#. Compress the files back into a ``.zip`` file.

#. On the Charts or Dashboards page, use the "Import" button to upload your ``.zip`` file.

Contributing Charts and Dashboards to Aspects

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Superset assets provided by Aspects can be found in the templated

`tutoraspects/templates/aspects/build/aspects-superset/openedx-assets/assets/` directory. For the most part,

these files are what Superset exports, but with some crucial differences

which make these assets usable across all Tutor deployments.

To contribute assets to Aspects:

#. Fork this repository and have a locally running Tutor set up with this plugin

   installed.

#. Export the assets you want to contribute as described in `Sharing Charts and Dashboards`

#. Run the command:

   `tutor aspects import_superset_zip ~/Downloads/your_file.zip`

#. This command will copy the files from your zip to the assets directory and

   attempt to warn you if there are hard coded connection settings where it expects

   template variables. These are usually in database and dataset assets, and those are

   often assets that already exist. The warnings look like:

   `WARN: fact_enrollments.yaml has schema set to reporting instead of a setting.`

#. Check the diff of files and update any database connection strings or table names

   to use Tutor configuration template variables instead of hard-coded strings, e.g.

   replace ``clickhouse`` with ``{{CLICKHOUSE_HOST}}``. Passwords can be left as

   ``{{CLICKHOUSE_PASSWORD}}``, though be aware that if you are adding new

   databases, you'll need to update ``SUPERSET_DB_PASSWORDS`` in the init scripts.

   Here is the default connection string for reference::

   ``clickhousedb+connect://{{CLICKHOUSE_REPORT_URL}}``

#. You will likely also run into issues where our SQL templates have been expanded into

   their actual SQL. If you haven't changed the SQL of these queries (stored in

   `tutoraspects/templates/openedx-assets/queries` you can just revert that change back

   to their `include` values such as:

   `sql: "{% include 'openedx-assets/queries/fact_enrollments_by_day.sql' %}"`

#. The script will also warn about missing `_roles` in dashboards. Superset does not export

   these, so you will need to manually add this key with the roles that are necessary to

   view the dashboard. See the existing dashboards for how this is done.

#. Re-build your ``aspects-superset`` image with `tutor images build aspects-superset --no-cache`

#. Run the command `tutor aspects check_superset_assets` to confirm there are no

   duplicate assets, which can happen when you rename an asset, and will cause import

   to fail. The command will automatically delete the older file if it finds a duplicate.

#. Check that everything imports correctly by running `tutor local do import-assets`

   and confirming there are no errors.

#. Double check that your database password did not get exported before committing!

#. Commit and submit a PR with screenshots of your new chart or dashboards, along with an

   explanation of what data question they answer.

Virtual datasets in Superset

^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Superset supports creating virtual datasets, which are datasets defined using a SQL query instead of mapping directly to an underlying database object. Aspects leverages virtual datasets, along with `SQL templating `_, to make better use of table indexes.

To make it easier for developers to manage virtual datasets, there is an extra step that can be done on the output of ``tutor aspects serialize``. The ``sql`` section of the dataset yaml can be moved to its own file in the `queries`_ directory and included in the yaml like so:

.. code-block:: yaml

   sql: "{% include 'openedx-assets/queries/query.sql' %}"

However, please keep in mind that the assets declaration is itself a jinja template. That means that any jinja used in the dataset definition should be escaped. There are examples of how to handle this in the existing queries, such as `dim_courses.sql`_.

.. _queries: tutoraspects/templates/openedx-assets/queries/

.. _dim_courses.sql: tutoraspects/templates/openedx-assets/queries/dim_courses.sql

Releasing tutor-contrib-aspects

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Changelog, package version, PyPI release, and image building are all handled via manually triggered Githib Actions.

To trigger a build you must have access to manually trigger the "Bump version and changelog" action. This will update the version and changelog in a new PR. If the PR looks good, you can approve and merge it. Merging this PR will:

- Trigger the "release" workflow which will tag a Github release with the new version number, and then push the release to PyPI

- Trigger the "build-image" workflow, which builds our images for aspects, aspects-superset, and openedx to the EduNEXT DockerHub repositories

When the workflows are finished you should confirm that you see the new version on PyPI and images in DockerHub.