JupyterLab Monitor

JupyterLab Monitor is a fork of the original JupyterLab Pioneer extension for generating and exporting JupyterLab event telemetry data.

Getting Started

Installing the Extension

To install the extension, execute:

pip install jupyterlab-monitor

Running the Extension with Docker Compose

# Enter the configuration_examples directory and run
docker compose -p jupyterlab_monitor up --build

A JupyterLab application with the extension installed and configured will run on localhost:8888.

(To experiment with different exporter configurations, edit Dockerfile and run docker compose again)

Manual Configuration

Before starting Jupyter Lab, users need to write their own configuration files (or use the provided configuration examples) and place them in the correct directory.

Examples of configurations are here.

Configurations

Overview

The configuration file controls the activated events and data exporters.

To add a data exporter, users should assign a callable function along with function arguments when configuring exporters.

This extension provides 5 default exporters:

• console_exporter, which sends telemetry data to the browser console
• command_line_exporter, which sends telemetry data to the Python console Jupyter is running on
• file_exporter, which saves telemetry data to a local file
• remote_exporter, which sends telemetry data to a remote HTTP endpoint
• opentelemetry_exporter, which sends telemetry data via OTLP

Additionally, users can write custom exporters in the configuration file.

[The rest of the README remains unchanged, but all references to 'jupyterlab-pioneer' should be replaced with 'jupyterlab-monitor']

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-monitor

Contributors

Main contributor of this fork: p0rt

Link to the Original Project

This project is a fork of the original JupyterLab Pioneer.