Package: jupyterlab-telemetry-router
JupyterLab Telemetry RouterA 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!Thejupyterlab-telemetry-routerextension needs to be used with extensions that can generates telemetry data, called telemetry producer.There is an example telemetry producerherethat could generate telemetry data of some basic JupyterLab events.There is also a tutorial with a simple demoherefor learning how to develop a custom telemetry producer.Get startedRequirementsJupyterLab >= 4.0.0InstallGenerally, for deployment,jupyterlab-telemetry-routershould notbe 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 detailshere.ConfigurationsOverviewThejupyterlab-telemetry-routerextension provides 4 default exporters,command_line_exporter,console_exporter,file_exporterandremote_exporter.
Users could add these exporters by editing the configuration file.Developers could also use customized exporters. To do so, developers need to write a callable exporter function and assign it to theexporterfield when writing the configuration file.Configuration file name & pathJupyter 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 definedhere. So, the configuration file name isjupyter_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 byjupyter --path.For more details, seehttps://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`.fromjupyterlab_telemetry_routerimporthandlersdefcustomized_exporter(args):pass# do more herereturn({'exporter':'CustomizedCommandLineExporter',})c.JupyterLabTelemetryRouterApp.exporters=[{'exporter':handlers.console_exporter,},{'exporter':handlers.command_line_exporter,},{'exporter':handlers.file_exporter,'args':{'path':'log'}},{'exporter':handlers.remote_exporter,'args':{'id':'S3Exporter','url':'https://telemetry.mentoracademy.org/telemetry-edtech-labs-si-umich-edu/dev/test-telemetry','env':['WORKSPACE_ID'],}},{'exporter':handlers.remote_exporter,'args':{'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'},'env':['WORKSPACE_ID'],}},{'exporter':handlers.remote_exporter,'args':{'id':'InfluxDBLambdaExporter','url':'https://68ltdi5iij.execute-api.us-east-1.amazonaws.com/influx','params':{'influx_bucket':'telemetry_dev','influx_measurement':'si101_fa24'}}},{'exporter':customized_exporter,'args':{# do more here}},]TroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab-telemetry-router directory# Install package in development modepipinstall-e"."# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyterlab-telemetry-router# Rebuild extension Typescript source after making changesjlpmbuildYou 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 neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith 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, thejlpm buildcommand 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:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyterlab-telemetry-router
pipuninstalljupyterlab-telemetry-routerIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyterlab-telemetry-routerwithin that folder.Packaging the extensionSeeRELEASE