jupyterlab-js-logs 1.3.0

JupyterLab extension to show the js logs from the browser dev tools console

jupyterlab-js-logs

JupyterLab extension to show the console logs from the browser dev tools console.

https://github.com/user-attachments/assets/8d907bf6-8363-4b67-8431-22fca19f7d1e

Requirements

• JupyterLab >= 2.0

Motivation

The main purpose for this extension is to provide a way to surface the console logs from the browser dev tools console in the JupyterLab interface. Especially for users that are not familiar with the browser dev tools, this extension can be very useful to debug and understand the logs generated by the JavaScript code running in the browser.

Settings

The extension exposes two settings in JupyterLab Settings Editor (JS Logs):

• defaultLevel: default log level when opening the JS Logs panel. Default: info.
• showLevelChangeMessages: whether to show metadata messages when log level changes. Default: false.

Extension point: log entry actions

This package provides an ILogEntryActionRegistry token for adding user-triggered actions to log rows in the JS Logs panel.

Actions are only executed when a user clicks a button. The extension does not automatically send log data anywhere.

Notes:

• Action id must be unique across all registered actions.
• register(...) returns a disposable you can call to remove the action.
• Buttons are rendered inline in each matching log row (at the right side of the row content).
• Actions can optionally provide an icon (for example from @jupyterlab/ui-components).
• execute(message) receives { source, entryIndex, level, timestamp, output }.
• This extension ships with a default Copy action on log rows as an example consumer of this API.

import {
  JupyterFrontEnd,
  JupyterFrontEndPlugin
} from '@jupyterlab/application';
import { ILogEntryActionRegistry } from 'jupyterlab-js-logs';

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my-log-actions',
  autoStart: true,
  requires: [ILogEntryActionRegistry],
  activate: (_app: JupyterFrontEnd, actions: ILogEntryActionRegistry) => {
    actions.register({
      id: 'my-actions:copy-log-context',
      label: 'Copy Context',
      caption: 'Run a custom action with this log entry',
      isVisible: message => ['error', 'critical'].includes(message.level),
      execute: message => {
        // Use the selected row context in your integration.
        console.log('Selected log entry:', message);
      }
    });
  }
};

Install

jupyter labextension install jupyterlab-js-logs

Contributing

This extension was bootstrapped from the custom-log-console example contributed by Carlos Herrero, from the jupyterlab-extension-examples repository.

Install

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
# Move to jupyterlab-js-logs directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

Uninstall

jupyter labextension uninstall jupyterlab-js-logs