jupyterlab-pioneer 0.1.9 → 0.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/lib/types.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -38,12 +38,13 @@ The configuration file controls the activated events and data exporters.
|
|
|
38
38
|
|
|
39
39
|
To add a data exporter, users should assign a callable function along with function arguments when configuring `exporters`.
|
|
40
40
|
|
|
41
|
-
This extension provides
|
|
41
|
+
This extension provides 5 default exporters.
|
|
42
42
|
|
|
43
|
-
- [`console_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#
|
|
44
|
-
- [`command_line_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#
|
|
45
|
-
- [`file_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#
|
|
46
|
-
- [`remote_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#
|
|
43
|
+
- [`console_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L22), which sends telemetry data to the browser console
|
|
44
|
+
- [`command_line_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L48), which sends telemetry data to the python console jupyter is running on
|
|
45
|
+
- [`file_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L76), which saves telemetry data to local file
|
|
46
|
+
- [`remote_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L106), which sends telemetry data to a remote http endpoint
|
|
47
|
+
- [`opentelemetry_exporter`](https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/jupyterlab_pioneer/default_exporters.py#L162), which sends telemetry data via otlp.
|
|
47
48
|
|
|
48
49
|
Additionally, users can write customized exporters in the configuration file.
|
|
49
50
|
|
|
@@ -66,9 +67,8 @@ Check jupyter server [doc](https://jupyter-server.readthedocs.io/en/latest/opera
|
|
|
66
67
|
}
|
|
67
68
|
```
|
|
68
69
|
|
|
69
|
-
The extension would only generate and export data for valid
|
|
70
|
-
|
|
71
|
-
The extension will export the entire notebook content only for valid events with the `logWholeNotebook` flag == True.
|
|
70
|
+
The extension would only generate and export data for valid event that has an id associated with the event class, and the event name is included in `activeEvents`.
|
|
71
|
+
The extension will export the entire notebook content only for valid events when the `logWholeNotebook` flag is True.
|
|
72
72
|
|
|
73
73
|
`exporters`: An array of exporters. Each exporter in the array should have the following structure:
|
|
74
74
|
|
package/lib/types.d.ts
CHANGED
|
@@ -32,7 +32,7 @@ export interface ExporterArgs {
|
|
|
32
32
|
}
|
|
33
33
|
export interface Exporter {
|
|
34
34
|
/**
|
|
35
|
-
* Exporter type, should be one of "console_exporter", "command_line_exporter", "file_exporter", "remote_exporter" or "custom_exporter"
|
|
35
|
+
* Exporter type, should be one of "console_exporter", "command_line_exporter", "file_exporter", "remote_exporter", "opentelemetry_exporter" or "custom_exporter"
|
|
36
36
|
*/
|
|
37
37
|
type: string;
|
|
38
38
|
/**
|