将谷歌分析添加到Jupyter笔记本中
jupyteranalytics的Python项目详细描述
Jupyter分析
一个简单的Jupyter笔记本扩展,用于将Google Analytics跟踪代码注入笔记本和JupyterHub网页。此扩展基于yuvipanda/nbgoogleanyltics,但针对更大的JupyterHub部署进行了扩展。在
安装
按如下步骤安装延长件:
$ pip install jupyteranalytics
这应该同时安装并启用jupyteranalytics
扩展。验证方式:
有几个原因,为什么这可能没有安装和自动启用。如果没有,您可以手动安装并启用,如下所示:
$ jupyter nbextension install --py --sys-prefix jupyteranalytics
$ jupyter nbextension enable --py --sys-prefix jupyteranalytics
$ jupyter serverextension enable --py --sys-prefix jupyteranalytics
注意,automatic和manual方法在默认情况下都使用--sys-prefix
标志将jupyteranalytics
安装到virtualenv。或者,您可以省略此标志或指定--user
将配置安装到您的用户配置中,或者您可以使用--system
来安装系统范围的扩展。在
Warning:要使Google Analytics跟踪显示在每个页面上(包括目录列表),配置必须在nbconfig/common.json
中,pip安装程序会将一个新配置复制到virtualenv位置;请确保备份任何现有的nbconfig.common.json
文件。请注意,这不会影响用户或系统的安装,这需要手动启用扩展。在
配置
此扩展所需的配置属性是Google Analytics跟踪ID,在设置Google Analytics属性后可以获得该ID。这个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而禁用分析。确保启用了系统日志记录,以检查部署是否正确。在
- 项目
标签: