Jupyter 分析

一个简单的 Jupyter Notebook 扩展，用于将Google Analytics跟踪代码注入笔记本和 JupyterHub 网页。此扩展基于yuvipanda/nbgoogleanyltics，但针对更大的 JupyterHub 部署进行了扩展。

安装

按如下方式安装扩展：

$ pip install jupyteranalytics

这应该同时安装和启用jupyteranalytics扩展。验证：

$ jupyter nbextension list
$ jupyter serverextension list

可能没有自动安装和启用它有几个原因。如果没有，您可以手动安装和启用如下：

$ jupyter nbextension install --py --sys-prefix jupyteranalytics
$ jupyter nbextension enable --py --sys-prefix jupyteranalytics
$ jupyter serverextension enable --py --sys-prefix jupyteranalytics

请注意，默认情况下，自动和手动方法都使用该标志安装jupyteranalytics到您的 virtualenv 。--sys-prefix或者，您可以省略此标志或指定--user将配置安装到您的用户配置，或者您可以使用--system在系统范围内安装扩展。

警告：要让 Google Analytics 跟踪出现在每个页面（包括目录列表），配置必须在 中nbconfig/common.json，pip 安装程序会将新配置复制到 virtualenv 位置；确保备份任何现有nbconfig.common.json文件。请注意，这不会影响需要手动启用扩展的用户或系统安装。

配置

此扩展所需的配置属性是 Google Analytics 跟踪 ID，可以在您设置 Google Analytics 属性后获取。这个 ID 看起来像UA-#########-#.

要快速开始，您可以将此 id 作为命令行参数传递：

$ jupyter notebook --GoogleAnalytics.tracking_id="UA-#########-#"

要在所有笔记本页面上永久启用跟踪，请使用 . 检查配置的路径jupyter nbextension list。然后，<config_path>/common.json添加以下内容：

{
    "GoogleAnalytics": {
        "tracking_id": "UA-#########-#"
    }
}

或者，您可以通过将 Trackig ID 存储在GOOGLE_ANALYTICS_TRACKING_ID环境变量中来设置它，如果您使用 Docker 或 Kubernetes 部署 JupyterHub，这将特别有用。

请注意，如果笔记本记录器可以从配置、环境或命令行中找到跟踪 ID（按此顺序解析），则笔记本记录器将指示是否启用了跟踪。它还将指示分析是否因找不到跟踪 ID 而被禁用。确保您启用了系统日志记录以检查您的部署是否正确。