Skip to main content

Provides jupyter server proxy endpoints for launching Jaeger.

Project description

jupyter-jaeger

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. Run the notebook.
  3. Create a launcher and launch the Jaeger UI
  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.

Source Distribution

jupyter_jaeger-1.0.1.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

jupyter_jaeger-1.0.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_jaeger-1.0.1.tar.gz.

File metadata

  • Download URL: jupyter_jaeger-1.0.1.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.21.0

File hashes

Hashes for jupyter_jaeger-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f7e8408ad0b11d823517bf21fc6d52ccaa74179d10d48ed8f99081ac06c9da0d
MD5 d3d95aeb9d0ac5b863ade0f279dc780f
BLAKE2b-256 d5e2704f5496961c4e3b95de0247df1fb2c477a08de63511e0f2badaa63d5c2e

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_jaeger-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_jaeger-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bfe67704836aa6e0d133d6c477be1333ee2cf43cef08f7656c3861a4c4c5fbd4
MD5 9d43433f3689a5e93d4dc30f4c4c90a1
BLAKE2b-256 312de70e83af00a6133b8a268814bde17fe54a043db1758db4d1342a3dad5aee

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page