analytics-platform 0.3.0__tar.gz → 0.3.1__tar.gz

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: analytics-platform
-Version: 0.3.0
+Version: 0.3.1
 Summary: Firewall, error monitoring and server analytics for your Python server, run from your analytics dashboard.
 Author: steviec87
 License-Expression: MIT
@@ -179,6 +179,16 @@ Their errors carry the job's name as the route, a job that raises is sent
 (status 500) and raised on, and each run is timed (Server speed → Jobs).
 Several services on one site: `Platform(..., server_name="worker")`.
 
+**Several apps on one site** (microservices, a worker, a Node service next to
+this one): install the package in each, with the same `site_id`, `secret` and
+`endpoint`, and a `server_name` of its own. Errors, Server speed, Crawlers and
+Security → Updates then tell the apps apart. Without one, each app is named
+after its machine: two apps on one machine are reported as one, and only the
+last package list sent is kept. A service only your other apps call takes
+`firewall=False, proxy=False, maintenance=False` (its requests all come from
+your own apps, so the rate limit would see one visitor); on a machine shared
+by several apps, keep `resources` on in only one of them.
+
 Options: `server_name`, `root` (traceback paths relative to it),
 `capture_uncaught`, `capture_logging`, `spool_dir` (where unsent errors wait;
 `False` for none), `before_send(event, error)` (change an error, or return

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/README.md

@@ -153,6 +153,16 @@ Their errors carry the job's name as the route, a job that raises is sent
 (status 500) and raised on, and each run is timed (Server speed → Jobs).
 Several services on one site: `Platform(..., server_name="worker")`.
 
+**Several apps on one site** (microservices, a worker, a Node service next to
+this one): install the package in each, with the same `site_id`, `secret` and
+`endpoint`, and a `server_name` of its own. Errors, Server speed, Crawlers and
+Security → Updates then tell the apps apart. Without one, each app is named
+after its machine: two apps on one machine are reported as one, and only the
+last package list sent is kept. A service only your other apps call takes
+`firewall=False, proxy=False, maintenance=False` (its requests all come from
+your own apps, so the rate limit would see one visitor); on a machine shared
+by several apps, keep `resources` on in only one of them.
+
 Options: `server_name`, `root` (traceback paths relative to it),
 `capture_uncaught`, `capture_logging`, `spool_dir` (where unsent errors wait;
 `False` for none), `before_send(event, error)` (change an error, or return

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/analytics_platform/__init__.py

@@ -100,6 +100,10 @@ class Platform:
             # so its errors, timings and resources can be told apart.
             if server_name and name in ("errors", "performance", "crawlers", "resources"):
                 opts.setdefault("server_name", server_name)
+            # Inventory and posture call it host, and are stored one per site
+            # and host: without it two services on one machine overwrite each other's.
+            if server_name and name in ("inventory", "posture"):
+                opts.setdefault("host", server_name)
             try:
                 self._modules[name] = _load(name, self.core, opts)
             except Exception as error:

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/analytics_platform/core.py

@@ -16,7 +16,7 @@ import urllib.error
 import urllib.parse
 import urllib.request
 
-VERSION = "0.3.0"
+VERSION = "0.3.1"
 TIMEOUT = 5
 MIN_SYNC = 30
 RETRY = 60

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/analytics_platform/proxy.py

@@ -47,6 +47,13 @@ def prefix_for(secret):
     return hashlib.sha256(("proxy|" + str(secret)).encode("utf-8")).hexdigest()[:8]
 
 
+# Sent as X-Proxy-Key, so the collector believes the visitor addresses this
+# proxy passes on: anyone can write X-Forwarded-For. Worked out from the secret
+# as the collector does (expresscollect/utils/proxyKey.js).
+def key_for(secret):
+    return hashlib.sha256(("proxykey|" + str(secret)).encode("utf-8")).hexdigest()[:32]
+
+
 class Proxy:
     """prefix: the path it answers on (default: from the secret)."""
 
@@ -54,6 +61,7 @@ class Proxy:
         self.core = core
         self.enabled = enabled
         self.prefix = re.sub(r"[^A-Za-z0-9_-]", "", str(prefix or prefix_for(core.secret)))
+        self.key = key_for(core.secret) if core.secret else ""
         # One copy of each tracker file, so a repeat visitor costs no upstream
         # request. A handful of small files: it never grows.
         self._files = {}
@@ -139,6 +147,8 @@ class Proxy:
         # The visitor's address: the collector needs it for the country, the
         # daily visitor ID and the per-visitor rate limit.
         out = {"X-Forwarded-For": client_ip or ""}
+        if self.key:
+            out["X-Proxy-Key"] = self.key
         for name in PASS_HEADERS:
             value = headers.get(name)
             if value:

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/analytics_platform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: analytics-platform
-Version: 0.3.0
+Version: 0.3.1
 Summary: Firewall, error monitoring and server analytics for your Python server, run from your analytics dashboard.
 Author: steviec87
 License-Expression: MIT
@@ -179,6 +179,16 @@ Their errors carry the job's name as the route, a job that raises is sent
 (status 500) and raised on, and each run is timed (Server speed → Jobs).
 Several services on one site: `Platform(..., server_name="worker")`.
 
+**Several apps on one site** (microservices, a worker, a Node service next to
+this one): install the package in each, with the same `site_id`, `secret` and
+`endpoint`, and a `server_name` of its own. Errors, Server speed, Crawlers and
+Security → Updates then tell the apps apart. Without one, each app is named
+after its machine: two apps on one machine are reported as one, and only the
+last package list sent is kept. A service only your other apps call takes
+`firewall=False, proxy=False, maintenance=False` (its requests all come from
+your own apps, so the rate limit would see one visitor); on a machine shared
+by several apps, keep `resources` on in only one of them.
+
 Options: `server_name`, `root` (traceback paths relative to it),
 `capture_uncaught`, `capture_logging`, `spool_dir` (where unsent errors wait;
 `False` for none), `before_send(event, error)` (change an error, or return

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "analytics-platform"
-version = "0.3.0"
+version = "0.3.1"
 description = "Firewall, error monitoring and server analytics for your Python server, run from your analytics dashboard."
 readme = "README.md"
 requires-python = ">=3.8"

{analytics_platform-0.3.0 → analytics_platform-0.3.1}/tests/test_proxy.py

@@ -12,7 +12,7 @@ from http.server import BaseHTTPRequestHandler, HTTPServer
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
 
-from analytics_platform.proxy import Proxy, prefix_for  # noqa: E402
+from analytics_platform.proxy import Proxy, key_for, prefix_for  # noqa: E402
 
 TRACKER = b"// a tracker" + b"x" * 600
 
@@ -77,6 +77,10 @@ class ProxyTest(unittest.TestCase):
         Collector.seen = []
         self.proxy = Proxy(FakeCore(self.endpoint))
 
+    def test_the_proxy_key_is_worked_out_as_the_collector_does(self):
+        # The same vector is pinned in the collector, the backend and the other packages.
+        self.assertEqual(key_for("0123456789abcdef01234567"), "8fc74dbbd4f088449862841cd29fcaee")
+
     def test_the_address_comes_from_the_secret(self):
         self.assertEqual(prefix_for("s3cret"), prefix_for("s3cret"))
         self.assertNotEqual(prefix_for("s3cret"), prefix_for("other"))
@@ -123,6 +127,7 @@ class ProxyTest(unittest.TestCase):
         self.assertEqual(got["path"], "/collectanalytics/e?v=1")
         self.assertEqual(got["body"], b'{"event":"pageview"}')
         self.assertEqual(got["headers"].get("X-Forwarded-For"), "198.51.100.4")
+        self.assertEqual(got["headers"].get("X-Proxy-Key"), key_for("s3cret"), "so the collector believes the address")
         self.assertEqual(got["headers"].get("User-Agent"), "Mozilla/5.0")
         self.assertIsNone(got["headers"].get("Cookie"), "the site's own cookies stay on the site")