analytics-platform 0.3.2__tar.gz → 0.3.3__tar.gz

{analytics_platform-0.3.2 → analytics_platform-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: analytics-platform
-Version: 0.3.2
+Version: 0.3.3
 Summary: Firewall, error monitoring and server analytics for your Python server, run from your analytics dashboard.
 Author: steviec87
 License-Expression: MIT
@@ -187,7 +187,10 @@ 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
+Security → Updates then tell the apps apart, and Health → All systems lists
+each with a light: the package checks in about once a minute, so an app that
+stops reads "Stopped" within ten minutes (`sdk/protocols/checkin.md`).
+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

{analytics_platform-0.3.2 → analytics_platform-0.3.3}/README.md

@@ -161,7 +161,10 @@ 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
+Security → Updates then tell the apps apart, and Health → All systems lists
+each with a light: the package checks in about once a minute, so an app that
+stops reads "Stopped" within ten minutes (`sdk/protocols/checkin.md`).
+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

{analytics_platform-0.3.2 → analytics_platform-0.3.3}/analytics_platform/__init__.py

@@ -81,7 +81,7 @@ class Platform:
                  performance=True, crawlers=True, forms=True, headers=True, audit=True, flags=True, maintenance=True,
                  inventory=True,
                  posture=True, resources=True, proxy=True, server_name=None):
-        self.core = Core(site_id, secret, endpoint, debug)
+        self.core = Core(site_id, secret, endpoint, debug, server_name=server_name)
         if not self.core.valid:
             print("[analytics-platform] site_id, secret and endpoint are required; nothing is sent and every request passes")
         settings = {"firewall": firewall, "errors": errors, "analytics": analytics, "performance": performance,

{analytics_platform-0.3.2 → analytics_platform-0.3.3}/analytics_platform/core.py

@@ -10,13 +10,16 @@ start again in a forked worker (gunicorn, uWSGI), where threads don't survive.
 import atexit
 import json
 import os
+import platform
 import re
+import socket
 import threading
+import time
 import urllib.error
 import urllib.parse
 import urllib.request
 
-VERSION = "0.3.2"
+VERSION = "0.3.3"
 TIMEOUT = 5
 MIN_SYNC = 30
 RETRY = 60
@@ -100,9 +103,30 @@ class Periodic:
             thread.join(wait)
 
 
+def _rss_mb():
+    """This process's resident memory in MB, where the platform says (Linux
+    /proc; elsewhere the peak, from resource); None when neither can."""
+    try:
+        with open("/proc/self/statm") as statm:
+            return round(int(statm.read().split()[1]) * os.sysconf("SC_PAGE_SIZE") / 1048576)
+    except Exception:
+        pass
+    try:
+        import resource
+        import sys
+        peak = resource.getrusage(resource.RUSAGE_SELF).ru_maxrss
+        return round(peak / 1048576 if sys.platform == "darwin" else peak / 1024)
+    except Exception:
+        return None
+
+
 class Core:
-    def __init__(self, site_id, secret, endpoint, debug=False):
+    def __init__(self, site_id, secret, endpoint, debug=False, server_name=None):
         self.site_id = str(site_id or "")
+        # The name this service checks in under (X-Platform-App, on the switches
+        # request): server_name, as every module sends it, else the machine's.
+        self.server_name = str(server_name or socket.gethostname())[:100]
+        self._started = time.time()
         self.secret = str(secret or "")
         self.endpoint = str(endpoint or "").rstrip("/")
         self.valid = bool(re.fullmatch(r"[a-fA-F0-9]{24}", self.site_id) and self.secret and self.endpoint)
@@ -154,8 +178,25 @@ class Core:
         """False only when the dashboard turned the module off."""
         return self._switches.get(name) is not False
 
+    def _check_in(self):
+        """This service's check-in, form-encoded so any name is plain ASCII:
+        Health -> All systems shows it running and when it was last heard from.
+        None when it can't be built: the switches still sync, without it."""
+        try:
+            fields = {"server": self.server_name, "kind": "process", "pid": os.getpid(),
+                      "up_s": int(time.time() - self._started), "runtime": "Python " + platform.python_version()}
+            rss = _rss_mb()
+            if rss is not None:
+                fields["rss_mb"] = rss
+            return urllib.parse.urlencode(fields) if self.server_name else None
+        except Exception:
+            return None
+
     def _sync_switches(self):
         headers = {"X-Platform-Modules": ",".join(self._loaded)}
+        app = self._check_in()
+        if app:
+            headers["X-Platform-App"] = app
         if self._etag:
             headers["If-None-Match"] = self._etag
         res = self.send("core", "/events/platform/config?site_id=" + self.site_id, method="GET", auth="bearer", headers=headers)

{analytics_platform-0.3.2 → analytics_platform-0.3.3}/analytics_platform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: analytics-platform
-Version: 0.3.2
+Version: 0.3.3
 Summary: Firewall, error monitoring and server analytics for your Python server, run from your analytics dashboard.
 Author: steviec87
 License-Expression: MIT
@@ -187,7 +187,10 @@ 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
+Security → Updates then tell the apps apart, and Health → All systems lists
+each with a light: the package checks in about once a minute, so an app that
+stops reads "Stopped" within ten minutes (`sdk/protocols/checkin.md`).
+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

{analytics_platform-0.3.2 → analytics_platform-0.3.3}/analytics_platform.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ analytics_platform.egg-info/PKG-INFO
 analytics_platform.egg-info/SOURCES.txt
 analytics_platform.egg-info/dependency_links.txt
 analytics_platform.egg-info/top_level.txt
+tests/test_checkin.py
 tests/test_crawlers.py
 tests/test_errors.py
 tests/test_firewall.py

{analytics_platform-0.3.2 → analytics_platform-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "analytics-platform"
-version = "0.3.2"
+version = "0.3.3"
 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.3/tests/test_checkin.py

@@ -0,0 +1,29 @@
+"""The check-in on the switches request (X-Platform-App): what names this
+service on Health -> All systems."""
+import os
+import unittest
+import urllib.parse
+from unittest import mock
+
+from analytics_platform.core import Core
+
+
+class CheckInTest(unittest.TestCase):
+    def test_switches_request_says_which_service_asks_and_that_it_runs(self):
+        core = Core("a" * 24, "s", "http://collector", server_name="api wörker")
+        with mock.patch.object(core, "send", return_value=None) as send:
+            core._sync_switches()
+        header = send.call_args.kwargs["headers"]["X-Platform-App"]
+        fields = dict(urllib.parse.parse_qsl(header))
+        self.assertEqual(fields["server"], "api wörker")
+        self.assertEqual(fields["kind"], "process")
+        self.assertEqual(fields["pid"], str(os.getpid()))
+        self.assertTrue(fields["runtime"].startswith("Python "))
+        self.assertTrue(header.isascii())
+
+    def test_default_name_is_the_machines(self):
+        self.assertTrue(Core("a" * 24, "s", "http://collector").server_name)
+
+
+if __name__ == "__main__":
+    unittest.main()