mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 13:29:19 +08:00
fix(privacy): turn off Mem0's PostHog telemetry by default (#4619)
## Description Turns off Mem0's PostHog usage telemetry by default for Headroom's memory-stack backends. Mem0 sends `mem0.init`, `mem0.add`, `mem0.search` and `mem0.notice_displayed` events to `https://us.i.posthog.com` unless `MEM0_TELEMETRY` is false. The events carry config, OS and version fields plus hashed entity ids, but no memory text or queries. It is on by default in every Mem0 release we lock (2.0.5 and 2.2.1). Found while collecting runtime evidence for #4614. Same approach as #4602 (ONNX Runtime): `setdefault`, so an explicit caller value wins. ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) ## Changes Made - `headroom/memory/backends/mem0.py`: `disable_mem0_telemetry_by_default()` sets `MEM0_TELEMETRY=False` unless already set. `Mem0Backend._ensure_client` calls it before `from mem0 import Memory`. - `headroom/memory/backends/direct_mem0.py`: `DirectMem0Adapter` calls it before its `from mem0 import Memory`. These are the only two mem0 imports in `headroom/`. - `docs/content/docs/installation.mdx`: the `memory-stack` row says telemetry is off and how to allow it. Mem0 reads the variable once, when `mem0.memory.telemetry` is imported. A host process that imported mem0 before Headroom must set it itself; the docstring says so. ## Testing - [x] Unit tests pass (`pytest`): `tests/test_memory/test_mem0_telemetry.py tests/test_memory/test_direct_mem0.py tests/test_memory/test_mem0_system_adapter_deprecation.py` → 28 passed - [x] Linting passes (`ruff check`, `ruff format --check` on `headroom/memory tests/test_memory`) - [x] Type checking: `mypy headroom/memory/backends/mem0.py` reports 9 errors, identical on `main` (`direct_mem0.py:203`, `embedders.py:389`) - [x] New tests added: backend sets the default before importing mem0, caller value wins, real mem0 reads the default as disabled - [x] Manual testing performed ### Test Output ```text 28 passed in 1.62s # on main (new test file only): FAILED test_mem0_telemetry.py::test_backend_turns_mem0_telemetry_off_before_importing_mem0 FAILED test_mem0_telemetry.py::test_real_mem0_reads_the_default_as_disabled 2 failed, 1 passed ``` ## Real Behavior Proof - Environment: macOS arm64, Python 3.12.13, mem0ai 2.2.1, posthog 7.81.2, Qdrant 1.15.5 in Docker, OpenAI replaced by a local stub. - Steps: patched `posthog.Posthog.capture` to record instead of send, then ran a `Mem0Backend` save and search. - Observed before: `mem0.init`, `mem0.add`, `mem0.search`, `mem0.notice_displayed` captured, with properties like `client_version`, `collection`, `embedding_model`, `encoded_ids`, `os`, `python_version`, `vector_store`. - Observed after: `test_real_mem0_reads_the_default_as_disabled` imports the real `mem0.memory.telemetry` in a clean subprocess and reads `MEM0_TELEMETRY == False`. Mem0's capture path returns early when it is false. - Not tested: Mem0 cloud mode (`Mem0Config(mode="cloud")`), which talks to Mem0's hosted API regardless. ## Runtime Rollout Safety - Rollout-managed feature(s): none - Minimum rollout channel: N/A - Stable/default behavior changed: yes, Mem0 telemetry is no longer sent by default. Memory behavior is unchanged. - Kill switch / disable path: `MEM0_TELEMETRY=True` restores Mem0's default - Unsafe override required: no - Qualification impact: none - Rollback path: revert this PR ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] I did **not** edit `CHANGELOG.md` 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/headroomlabs-ai/headroom/pull/4619" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-devin-review-dark.svg?v=4"><img src="https://static.devin.ai/assets/gh-devin-review-light.svg?v=4" alt="Devin Review"></picture></a> <!-- devin-review-badge-end --> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: JD Davis <mxjerrett@gmail.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
JD Davis
parent
342c495ea5
commit
fe69f38116
@@ -101,7 +101,7 @@ pip install "headroom-ai[all]"
|
||||
| `code` | CodeCompressor (tree-sitter AST parsing) | `pip install "headroom-ai[code]"` |
|
||||
| `memory` | Persistent memory (sqlite-vec, sentence-transformers) — pure-Python default backend, no compiler | `pip install "headroom-ai[memory]"` |
|
||||
| `vector` | Optional HNSW vector backend (hnswlib) — needs a C++ toolchain; **not in `[all]`** | `pip install "headroom-ai[vector]"` |
|
||||
| `memory-stack` | Optional Qdrant + Neo4j memory backend helpers; **not in `[all]`** | `pip install "headroom-ai[memory-stack]"` |
|
||||
| `memory-stack` | Optional Qdrant + Neo4j memory backend helpers; **not in `[all]`**. Headroom turns off Mem0's PostHog telemetry by default; set `MEM0_TELEMETRY=True` to allow it | `pip install "headroom-ai[memory-stack]"` |
|
||||
| `relevance` | fastembed-based relevance scoring (BAAI/bge-small-en-v1.5, ONNX) | `pip install "headroom-ai[relevance]"` |
|
||||
| `image` | Image compression (Pillow, ONNX runtime, OCR) | `pip install "headroom-ai[image]"` |
|
||||
| `reports` | HTML/Markdown report generation (Jinja2) | `pip install "headroom-ai[reports]"` |
|
||||
|
||||
@@ -59,6 +59,7 @@ from typing import Any
|
||||
|
||||
from headroom.log_safety import describe_exception, safe_id
|
||||
from headroom.memory import qdrant_env
|
||||
from headroom.memory.backends.mem0 import disable_mem0_telemetry_by_default
|
||||
from headroom.memory.models import Memory
|
||||
from headroom.memory.ports import MemorySearchResult
|
||||
from headroom.offline import guard_egress
|
||||
@@ -219,6 +220,7 @@ class DirectMem0Adapter:
|
||||
self._neo4j_driver = None
|
||||
|
||||
# Initialize Mem0 client for fallback path
|
||||
disable_mem0_telemetry_by_default()
|
||||
try:
|
||||
from mem0 import Memory as Mem0Memory
|
||||
|
||||
|
||||
@@ -22,6 +22,22 @@ from headroom.memory import qdrant_env
|
||||
from headroom.memory.models import Memory
|
||||
from headroom.memory.ports import MemoryFilter, VectorFilter, VectorSearchResult
|
||||
|
||||
MEM0_TELEMETRY_ENV = "MEM0_TELEMETRY"
|
||||
|
||||
|
||||
def disable_mem0_telemetry_by_default() -> None:
|
||||
"""Opt Mem0 out of its PostHog usage telemetry unless the caller chose.
|
||||
|
||||
Mem0 sends ``mem0.init``/``mem0.add``/``mem0.search`` events (config, OS and
|
||||
version fields plus hashed entity ids) to ``us.i.posthog.com`` unless
|
||||
``MEM0_TELEMETRY`` is false. It reads the variable once, when
|
||||
``mem0.memory.telemetry`` is imported, so every ``from mem0 import`` in
|
||||
Headroom calls this first. ``setdefault`` keeps an explicit caller value,
|
||||
including ``True`` to allow it. A host that imported mem0 before Headroom
|
||||
has already read the variable and must set it itself.
|
||||
"""
|
||||
os.environ.setdefault(MEM0_TELEMETRY_ENV, "False")
|
||||
|
||||
|
||||
@dataclass
|
||||
class Mem0Config:
|
||||
@@ -121,6 +137,7 @@ class Mem0Backend:
|
||||
ImportError: If mem0 package is not installed.
|
||||
"""
|
||||
if self._client is None:
|
||||
disable_mem0_telemetry_by_default()
|
||||
try:
|
||||
from mem0 import Memory as Mem0Memory
|
||||
except ImportError:
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
"""Mem0's PostHog telemetry is off unless the caller turns it on."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
import types
|
||||
from typing import Any
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
import pytest
|
||||
|
||||
from headroom.memory.backends.mem0 import Mem0Backend, Mem0Config
|
||||
|
||||
|
||||
class _FakeMem0(types.ModuleType):
|
||||
"""Stand-in ``mem0`` that records MEM0_TELEMETRY when ``Memory`` is imported.
|
||||
|
||||
Real Mem0 reads the variable at that import, so the value seen here is the
|
||||
one it would use.
|
||||
"""
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__("mem0")
|
||||
self.telemetry_at_import: str | None = None
|
||||
|
||||
def __getattr__(self, name: str) -> Any:
|
||||
if name != "Memory":
|
||||
raise AttributeError(name)
|
||||
self.telemetry_at_import = os.environ.get("MEM0_TELEMETRY")
|
||||
return MagicMock()
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_backend_turns_mem0_telemetry_off_before_importing_mem0(monkeypatch) -> None:
|
||||
monkeypatch.delenv("MEM0_TELEMETRY", raising=False)
|
||||
fake = _FakeMem0()
|
||||
monkeypatch.setitem(sys.modules, "mem0", fake)
|
||||
|
||||
await Mem0Backend(Mem0Config(enable_graph=False))._ensure_client()
|
||||
|
||||
assert fake.telemetry_at_import == "False"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_caller_choice_of_mem0_telemetry_wins(monkeypatch) -> None:
|
||||
monkeypatch.setenv("MEM0_TELEMETRY", "True")
|
||||
fake = _FakeMem0()
|
||||
monkeypatch.setitem(sys.modules, "mem0", fake)
|
||||
|
||||
await Mem0Backend(Mem0Config(enable_graph=False))._ensure_client()
|
||||
|
||||
assert fake.telemetry_at_import == "True"
|
||||
|
||||
|
||||
def test_real_mem0_reads_the_default_as_disabled() -> None:
|
||||
pytest.importorskip("mem0")
|
||||
env = {k: v for k, v in os.environ.items() if k != "MEM0_TELEMETRY"}
|
||||
script = (
|
||||
"from headroom.memory.backends.mem0 import disable_mem0_telemetry_by_default\n"
|
||||
"disable_mem0_telemetry_by_default()\n"
|
||||
"import mem0.memory.telemetry as t\n"
|
||||
"print(t.MEM0_TELEMETRY)\n"
|
||||
)
|
||||
out = subprocess.run(
|
||||
[sys.executable, "-c", script], env=env, capture_output=True, text=True, check=True
|
||||
)
|
||||
assert out.stdout.strip().splitlines()[-1] == "False"
|
||||
Reference in New Issue
Block a user