Migrate entirely to our self-hosted Plausible instance for analytics (#17981)

* move blog to plausible analytics

* add plausible to user docs

* remove google analytics support

Author: ewdurbin

docs/mkdocs-blog.yml

@@ -52,6 +52,7 @@ plugins:
       # If we ever want to change the format and thus break old URLs,
       # consider https://github.com/mkdocs/mkdocs-redirects
       post_url_format: "posts/{file}"
+  - material-plausible
   - rss:
       abstract_chars_count: -1
       categories:
@@ -82,10 +83,11 @@ extra:
       link: https://twitter.com/pypi
     - icon: material/rss
       link: https://blog.pypi.org/feed_rss_created.xml
-  # See https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/
+  # See https://material-plausible-plugin.ale.sh
   analytics:
-    provider: google
-    property: G-4L9L0H79CY
+    provider: plausible
+    domain: blog.pypi.org
+    src: https://analytics.python.org/js/script.outbound-links.js
 
 site_url: https://blog.pypi.org/
 repo_url: https://github.com/pypi/warehouse

docs/mkdocs-user-docs.yml

@@ -3,6 +3,7 @@ docs_dir: user
 site_dir: user-site
 plugins:
   - search
+  - material-plausible
   - macros:
       module_name: user/main
       j2_block_start_string: "<!--[[%"
@@ -50,6 +51,10 @@ theme:
 extra_css:
   - stylesheets/extra.css
 extra:
+  analytics:
+    provider: plausible
+    domain: docs.pypi.org
+    src: https://analytics.python.org/js/script.outbound-links.js
   homepage: https://pypi.org
   social:
     - icon: fontawesome/brands/github

requirements/docs-blog.in

@@ -1,3 +1,4 @@
+material-plausible-plugin
 mkdocs
 mkdocs-material
 mkdocs-rss-plugin

requirements/docs-blog.txt

@@ -309,6 +309,10 @@ markupsafe==3.0.2 \
     # via
     #   jinja2
     #   mkdocs
+material-plausible-plugin==0.3.0 \
+    --hash=sha256:31c872608bfa4e94ef05c128f7bf1e476c55b0576ba418a983977a75216d10cc \
+    --hash=sha256:4e1cbaf0eef86dbd34fafa2f25830960416c989f80e0b1d1fabceed6cf6b40aa
+    # via -r requirements/docs-blog.in
 mergedeep==1.3.4 \
     --hash=sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8 \
     --hash=sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307
@@ -320,6 +324,7 @@ mkdocs==1.6.1 \
     --hash=sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e
     # via
     #   -r requirements/docs-blog.in
+    #   material-plausible-plugin
     #   mkdocs-material
     #   mkdocs-rss-plugin
 mkdocs-get-deps==0.2.0 \
@@ -329,7 +334,9 @@ mkdocs-get-deps==0.2.0 \
 mkdocs-material==9.6.11 \
     --hash=sha256:0b7f4a0145c5074cdd692e4362d232fb25ef5b23328d0ec1ab287af77cc0deff \
     --hash=sha256:47f21ef9cbf4f0ebdce78a2ceecaa5d413581a55141e4464902224ebbc0b1263
-    # via -r requirements/docs-blog.in
+    # via
+    #   -r requirements/docs-blog.in
+    #   material-plausible-plugin
 mkdocs-material-extensions==1.3.1 \
     --hash=sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443 \
     --hash=sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31

requirements/docs-user.in

@@ -1,3 +1,4 @@
+material-plausible-plugin
 mkdocs
 mkdocs-material
 mkdocs-macros-plugin

requirements/docs-user.txt

@@ -215,6 +215,10 @@ markupsafe==3.0.2 \
     # via
     #   jinja2
     #   mkdocs
+material-plausible-plugin==0.3.0 \
+    --hash=sha256:31c872608bfa4e94ef05c128f7bf1e476c55b0576ba418a983977a75216d10cc \
+    --hash=sha256:4e1cbaf0eef86dbd34fafa2f25830960416c989f80e0b1d1fabceed6cf6b40aa
+    # via -r requirements/docs-user.in
 mergedeep==1.3.4 \
     --hash=sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8 \
     --hash=sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307
@@ -226,6 +230,7 @@ mkdocs==1.6.1 \
     --hash=sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e
     # via
     #   -r requirements/docs-user.in
+    #   material-plausible-plugin
     #   mkdocs-macros-plugin
     #   mkdocs-material
 mkdocs-get-deps==0.2.0 \
@@ -239,7 +244,9 @@ mkdocs-macros-plugin==1.3.7 \
 mkdocs-material==9.6.11 \
     --hash=sha256:0b7f4a0145c5074cdd692e4362d232fb25ef5b23328d0ec1ab287af77cc0deff \
     --hash=sha256:47f21ef9cbf4f0ebdce78a2ceecaa5d413581a55141e4464902224ebbc0b1263
-    # via -r requirements/docs-user.in
+    # via
+    #   -r requirements/docs-user.in
+    #   material-plausible-plugin
 mkdocs-material-extensions==1.3.1 \
     --hash=sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443 \
     --hash=sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31

tests/unit/test_csp.py

@@ -250,9 +250,6 @@ def test_includeme():
                         "https://api.github.com/repos/",
                         "https://api.github.com/search/issues",
                         "https://gitlab.com/api/",
-                        "https://*.google-analytics.com",
-                        "https://*.analytics.google.com",
-                        "https://*.googletagmanager.com",
                         "https://analytics.python.org",
                         "fastly-insights.com",
                         "*.fastly-insights.com",
@@ -269,17 +266,12 @@ def test_includeme():
                     "img-src": [
                         "'self'",
                         "camo.url.value",
-                        "https://*.google-analytics.com",
-                        "https://*.googletagmanager.com",
                         "*.fastly-insights.com",
                         "*.ethicalads.io",
                         "ethicalads.blob.core.windows.net",
                     ],
                     "script-src": [
                         "'self'",
-                        "https://*.googletagmanager.com",
-                        "https://www.google-analytics.com",
-                        "https://ssl.google-analytics.com",
                         "https://analytics.python.org",
                         "*.fastly-insights.com",
                         "*.ethicalads.io",

warehouse/config.py

@@ -399,8 +399,6 @@ def configure(settings=None):
     maybe_set(settings, "camo.url", "CAMO_URL")
     maybe_set(settings, "camo.key", "CAMO_KEY")
     maybe_set(settings, "docs.url", "DOCS_URL")
-    maybe_set(settings, "ga.tracking_id", "GA_TRACKING_ID")
-    maybe_set(settings, "ga4.tracking_id", "GA4_TRACKING_ID")
     maybe_set(settings, "statuspage.url", "STATUSPAGE_URL")
     maybe_set(settings, "hibp.api_key", "HIBP_API_KEY")
     maybe_set(settings, "token.password.secret", "TOKEN_PASSWORD_SECRET")

warehouse/csp.py

@@ -98,9 +98,6 @@ def _connect_src_settings(config) -> list:
         "https://api.github.com/repos/",
         "https://api.github.com/search/issues",
         "https://gitlab.com/api/",
-        "https://*.google-analytics.com",
-        "https://*.analytics.google.com",
-        "https://*.googletagmanager.com",
         "https://analytics.python.org",
         "fastly-insights.com",
         "*.fastly-insights.com",
@@ -135,9 +132,6 @@ def _connect_src_settings(config) -> list:
 def _script_src_settings(config) -> list:
     settings = [
         SELF,
-        "https://*.googletagmanager.com",
-        "https://www.google-analytics.com",  # Remove when disabling UA
-        "https://ssl.google-analytics.com",  # Remove when disabling UA
         "https://analytics.python.org",
         "*.fastly-insights.com",
         "*.ethicalads.io",
@@ -177,8 +171,6 @@ def includeme(config):
                 "img-src": [
                     SELF,
                     config.registry.settings["camo.url"],
-                    "https://*.google-analytics.com",
-                    "https://*.googletagmanager.com",
                     "*.fastly-insights.com",
                     "*.ethicalads.io",
                     "ethicalads.blob.core.windows.net",