Added telemetry support.

[3coins]

Description

This PR adds support for telemetry and emits data for different events in the Scheduler components. A new plugin is provided that receives the event data. Implementors can disable the default plugin and provide their own implementation that will pass the telemetry data to their handler.

Event log examples

Advanced options expanded

{
    "body": {
        "name": "org.jupyter.jupyter-scheduler.create-job.advanced-options.expand"
    },
    "timestamp": "2023-10-26T17:17:44.350Z"
}

Create job cancel button clicked

{
    "body": {
        "name": "org.jupyter.jupyter-scheduler.create-job.cancel"
    },
    "timestamp": "2023-10-26T17:18:53.323Z"
}

Create job run on schedule option selected

{
    "body": {
        "name": "org.jupyter.jupyter-scheduler.create-job.job-type.run-on-schedule"
    },
    "timestamp": "2023-10-26T17:19:28.917Z"
}

Providing your implementation to process telemetry events

Create a new handler and a plugin that provides the handler.

const myTelemetryHandler: async (eventLog: Scheduler.IEventLog): Promise<void> => {
    // process the eventLog 
}

const myTelemetryPlugin: JupyterFrontEndPlugin<Scheduler.TelemetryHandler> = {
  id: '@jupyterlab/scheduler:MyTelemetryHandler',
  autoStart: true,
  provides: Scheduler.TelemetryHandler,
  activate: (app: JupyterFrontEnd) => {
    return myTelemetryHandler;
  }
};

Disable the default plugin in the package.json file of your extension package.

"jupyterlab": {
    "extension": true,
    "disabledExtensions": [
      "@jupyterlab/scheduler:TelemetryHandler"
    ]
  }

Attaching new events to telemetry handler

A new hook useLogger is available that could be accessed in any component.

const log = useLogger();

Any event handler can then call the log to pass in the event name.

log("job-detail.<my-event>")

[JasonWeill]

General comment: I was confused by the use of log and GetLogger for telemetry events. We use very similar names for functions that log things to stdout/stderr, for example. Could we use something like logTelemetryEvent or telemetryEvent to be more noticeably different?

[3coins]

@JasonWeill

I was confused by the use of log and GetLogger for telemetry events.

See the comments from David's review explaining the rationale behind this.

[JasonWeill]

While I agree that "telemetry" isn't a verb, the verb shouldn't just be "log" for telemetry events; that's ambiguous. I'd prefer that log be kept for stdout/stderr logging, and logTelemetryEvent or logEvent be used for telemetry event logging.

[3coins]

@JasonWeill @dlqqq
Made final updates for the names.

[dlqqq]

Awesome work!