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:
- Launching the Binder for this repo.
- Run the notebook.
- Create a launcher and launch the Jaeger UI
- 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
Built Distribution
Hashes for jupyter_jaeger-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfe67704836aa6e0d133d6c477be1333ee2cf43cef08f7656c3861a4c4c5fbd4 |
|
MD5 | 9d43433f3689a5e93d4dc30f4c4c90a1 |
|
BLAKE2b-256 | 312de70e83af00a6133b8a268814bde17fe54a043db1758db4d1342a3dad5aee |