jupyterlab-telemetry-router 0.1.26

A JupyterLab extension.

JupyterLab Telemetry Router

A JupyterLab extension for routing JupyterLab telemetry data.

Options to export JupyterLab telemetry data to console, local file, AWS Storage Services, AWS Lambda functions, and more!

The jupyterlab-telemetry-router extension needs to be used with extensions that can generates telemetry data, called telemetry producer.

There is an example telemetry producer here that could generate telemetry data of some basic JupyterLab events.

There is also a tutorial with a simple demo here for learning how to develop a custom telemetry producer.

Get started

Requirements

• JupyterLab >= 4.0.0

Install

Generally, for deployment, jupyterlab-telemetry-router should not be installed separately from the telemetry producer extensions, as it is a dependency of the telemetry producer extensions and would be installed automatically when installing the producer extensions. See details here.

Configurations

Overview

By editing the configuration file, users could define exporters easily without touching the code. Users could use multiple exporters at the same time.

The jupyterlab-telemetry-router extension provides 3 types of default exporters, console exporter, file exporter and remote exporter.

console exporter logs data in the console.

file exporter logs data into the local file indicated by path.

remote exporter posts data to the remote endpoint indicated by url.

The extension would extract the environment variable for each of the keys presented in env, and add the result to the data when exporting.

The extension would add params directly to data when exporting. This feature is useful when users want to post data to lambda functions and wants to have additional parameters.

The configuration file accepts customized exporter functions. To do so, developers need to assign a callable exporter function to the type. See examples here.

Syntax

type and id are required for all exporters.

path is required for file exporters only.

url is required for remote exporters only.

env and params are optional.

When the extension is being activated, a syntax check will be done first. Missing required fields would prevent Jupyter Lab from starting.

Configuration file name & path

Jupyter Server expects the configuration file to be named after the extension’s name like so: jupyter_{extension name defined in application.py}_config.py. In our case, the extension name is defined here. So, the configuration file name is jupyter_jupyterlab_telemetry_router_config.py.

Jupyter Server looks for an extension’s config file in a set of specific paths. The configuration file should be saved into one of the config directories provided by jupyter --path.

For more details, see https://jupyter-server.readthedocs.io/en/latest/operators/configuring-extensions.html.

Example

# This file should be saved into one of the config directories provided by `jupyter --path`.
def customized_exporter(data):
    print(data) # or do more here

c.JupyterLabTelemetryRouterApp.exporters = [
    {
        'type': 'console',
        'id': 'ConsoleExporter',
    },
    {
        'type': 'file',
        'id': 'FileExporter',
        'path': 'log',
    },
    {
        'type': 'remote',
        'id': 'S3Exporter',
        'url': 'https://telemetry.mentoracademy.org/telemetry-edtech-labs-si-umich-edu/dev/test-telemetry',
        'env': ['WORKSPACE_ID']
    },
    {
        'type': 'remote',
        'id': 'InfluxDBLambdaExporter',
        'url': 'https://68ltdi5iij.execute-api.us-east-1.amazonaws.com/influx',
        'params': {
            'influx_bucket': 'telemetry_dev',
            'influx_measurement': 'si101_fa24'
        }
    },
    {
        'type': 'remote',
        'id': 'MongoDBLambdaExporter',
        'url': 'https://68ltdi5iij.execute-api.us-east-1.amazonaws.com/mongo',
        'params': {
            'mongo_cluster': 'mengyanclustertest.6b83fsy.mongodb.net',
            'mongo_db': 'telemetry',
            'mongo_collection': 'dev'
        }
    },
    {
        'type': customized_exporter,
        'id': 'CustomizedExporter'
    }
]

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-telemetry-router directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab-telemetry-router
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab-telemetry-router
pip uninstall jupyterlab-telemetry-router

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyterlab-telemetry-router within that folder.

Packaging the extension

See RELEASE