Jupyter Enhancement Proposal(JEP) document

[jaipreet-s]

Hi all,

In the interest of working backwards from the JEP process, I've started the final JEP proposal documentation. This encapsulates the design and discussions done here and offline.

I've attempted to layout the components of the telemetry system and each of their sub-components

A few sections are TBD and still work-in-progress. I am hoping someone who is more familiar with JupyterHub can pick up the that section.

(This is a carry-over from jupyterlab/jupyterlab-telemetry#4)

[Zsailer]

@jaipreet-s This is awesome. Thank you for putting this JEP together. I'm really happy with it.

I've left some comments inline.

[Zsailer]

One big design decision I'd like to discuss is: should telemetry be a jupyter server extension or core jupyter "service"?

Jupyter "services" are REST APIs that are native to jupyter_server. Every running jupyter server promises to expose all services' endpoints.

Server Extensions are loaded dynamically after server initialization. They exist separately from the server, and the server must be configured to expose their endpoints.

Should we require that every jupyter_server expose the telemetry endpoints?

[yuvipanda]

Thanks for getting this going, @jaipreet-s. I've left some comments, will do another round soon.

I'm trying to understand the relationship between:

1. This repo and jupyterlab/jupyterlab-telemetry
2. This document and https://github.com/jupyterlab/jupyterlab-telemetry/blob/master/design.md

What are your thoughts on this?

[Zsailer]

I'm thinking we should merge this and open PRs to iterate?

[jaipreet-s]

I'm thinking we should merge this and open PRs to iterate?

I'm going to respond/incorporate the comments soon and then we can merge and iterate. There's some TBD sections , especially for JHub. (I've been occupied these past few days)

[Zsailer]

Great. Let me know when you're ready.

There's some TBD sections, especially for JHub

Yeah, I think we can fill those sections in separate PRs.

[jaipreet-s]

Thanks for getting this going, @jaipreet-s. I've left some comments, will do another round soon.

I'm trying to understand the relationship between:

1. This repo and jupyterlab/jupyterlab-telemetry

2. This document and https://github.com/jupyterlab/jupyterlab-telemetry/blob/master/design.md

What are your thoughts on this?

1. This was a new repo created to contain the Jupyter telemetry system parts that are not specific to any component like JupyterLab. I didn't create it but looks like this is where most of the stuff will reside.
2. This is the formal proposal for the Jupyter Enhancement Proposal format. I've definitely used bits from that doc ;-) and added more stuff around concrete design recommentations for components lik JupyterLab. We should get this doc to a state where we feel comfortable publishing as a JEP

[jaipreet-s]

@Zsailer @yuvipanda

I've incorporated most feedback and also added y'all as authors. This is ready to merge from my perspective.

Can someone volunteer to fill out the JHub section?

[jaipreet-s]

One big design decision I'd like to discuss is: should telemetry be a jupyter server extension or core jupyter "service"?

Jupyter "services" are REST APIs that are native to jupyter_server. Every running jupyter server promises to expose all services' endpoints.

Server Extensions are loaded dynamically after server initialization. They exist separately from the server, and the server must be configured to expose their endpoints.

Should we require that every jupyter_server expose the telemetry endpoints?

We'll likely have to support the Jupyter Notebook (Classic) server since the jupyter_server is very new , so a server extension helps in that way. Thoughts?

[yuvipanda]

Thanks, @jaipreet-s! Let's merge this and collaborate in PRs.

I'll fill out the hub section!