Skip to main content

Provides jupyter server proxy endpoints for launching Jaeger.

Project description

jupyter-jaeger
PyPI npm

This adds support for using the Jaeger distributed tracing tool with Jupyter. It facilitates the use case of tracking some process that starts in a kernel and is continued in a mime renderer.

We are using it to profile and debug ibis-vega-transform which goes back and forth between the kernel and the frontend to interactively render charts with Altair.

Installing this adds two Jupyter server extensions that start up the jaeger-all-in-one and jaeger-browser processes when you launch Jupyter. So to use it you must first instrument code in your kernel and/or in the frontend to record traces.

It also provis a NPM Typescript plugin you can use to access the client from inside a JupyterLab extension.

Usage

# Install jaeger-all-in-one binary
conda install -c conda-forge jaeger

# Install this package
pip install jupyter-jaeger

# Optional, to see Jaeger icon in JupyterLab launcherr
jupyter labextension install jupyterlab-server-proxy-saulshanabrook

# Launch a Jupyter server
jupyter lab

# Open the jaeger UI
open http://localhost:8080/jaeger

Example

This repo also includes an example of starting a trace from a kernel and continueing it in a mimeredenr jupyterlab extension, in ./example. You can try this example by:

  1. Launching the Binder for this repo.
  2. Create a launcher and launch the Jaeger UI
  3. Run the notebook.
  4. Inspect the trace created by the notebook execution.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jupyter_jaeger, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size jupyter_jaeger-1.0.3-py3-none-any.whl (51.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size jupyter_jaeger-1.0.3.tar.gz (55.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page