Skip to content

Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.

fix(events): always emit project_id so absent and empty stay distinct (#7056)

João Moura7c72d57b738e
diff --git a/lib/crewai-core/src/crewai_core/telemetry.py b/lib/crewai-core/src/crewai_core/telemetry.py
index a7326f43b..be33c6fb8 100644
--- a/lib/crewai-core/src/crewai_core/telemetry.py
+++ b/lib/crewai-core/src/crewai_core/telemetry.py
@@ -135,8 +135,11 @@ def common_span_attributes() -> dict[str, str]:
imports ``crewai``, still reports the same process-wide context.
Returns:
- Attributes to stamp on every span. ``project_id`` is omitted for
- projects that do not declare one.
+ Attributes to stamp on every span. ``project_id`` is always present and
+ is the empty string whenever no id is available -- both for projects that
+ declare none and when the lookup itself failed, which are deliberately
+ indistinguishable here because neither yields an id. See the comment at
+ the assignment for why empty and *absent* must stay distinct.
"""
attributes = {
"coding_agent": detect_coding_agent(),
@@ -151,8 +154,15 @@ def common_span_attributes() -> dict[str, str]:
logger.debug("Failed to read project id: %s", e)
project_id = None
- if project_id:
- attributes["project_id"] = project_id
+ # Always set the key, even when empty. Absent and empty mean different things
+ # and only this distinction can tell them apart: absent means the client is too
+ # old to report a project id at all, empty means the client asked and the project
+ # declares none -- or the lookup failed, which lands here too and is treated the
+ # same, since an unreadable pyproject.toml also means no id is available.
+ # Collapsing empty into "absent" makes the share of clients that COULD have
+ # reported one unknowable, and that share is the denominator every attribution
+ # rate needs.
+ attributes["project_id"] = project_id or ""
return attributes
diff --git a/lib/crewai/tests/telemetry/test_coding_agent_detection.py b/lib/crewai/tests/telemetry/test_coding_agent_detection.py
index 87f43fb09..dd908abb8 100644
--- a/lib/crewai/tests/telemetry/test_coding_agent_detection.py
+++ b/lib/crewai/tests/telemetry/test_coding_agent_detection.py
@@ -547,15 +547,27 @@ def test_common_attributes_include_project_id_when_declared(clean_env, monkeypat
assert attributes["project_id"] == "proj-123"
-def test_project_id_is_omitted_when_absent(clean_env, monkeypatch):
- """Projects without an id must not report a placeholder."""
+def test_project_id_is_empty_rather_than_absent_when_undeclared(clean_env, monkeypatch):
+ """An undeclared project reports an EMPTY id, not a missing key.
+
+ This used to assert the key was omitted. It is now always present, because
+ absent and empty answer different questions and only the caller can tell them
+ apart: a missing key means the client is too old to report a project id at all,
+ an empty one means the client asked and the project declares none. With both
+ collapsed into "absent", the share of clients that COULD have reported an id is
+ unknowable -- and that share is the denominator any attribution rate needs.
+ """
attributes = _common_attributes(monkeypatch, project_id=None)
- assert "project_id" not in attributes
+ assert attributes["project_id"] == ""
+ assert "project_id" in attributes, (
+ "the key must be present even when empty, or absent and undeclared "
+ "become indistinguishable"
+ )
def test_project_id_lookup_never_breaks_telemetry(clean_env, monkeypatch):
- """A failed lookup degrades to omitting the attribute."""
+ """A failed lookup degrades to an empty id, and never to a raised exception."""
from crewai_core.telemetry import common_span_attributes
def boom(*args, **kwargs):
@@ -566,10 +578,26 @@ def test_project_id_lookup_never_breaks_telemetry(clean_env, monkeypatch):
attributes = common_span_attributes()
- assert "project_id" not in attributes
+ assert attributes["project_id"] == ""
assert "coding_agent" in attributes
+def test_a_declared_id_is_distinguishable_from_an_undeclared_one(
+ clean_env, monkeypatch
+):
+ """The whole point of the change: the two cases produce different values.
+
+ Both are present, so a reader can always tell "no project" from "old client",
+ which is what makes an attribution denominator computable.
+ """
+ declared = _common_attributes(monkeypatch, project_id="proj-123")
+ undeclared = _common_attributes(monkeypatch, project_id=None)
+
+ assert declared["project_id"] == "proj-123"
+ assert undeclared["project_id"] == ""
+ assert declared["project_id"] != undeclared["project_id"]
+
+
def test_common_attributes_are_computed_once(clean_env, monkeypatch):
"""The project file must not be re-read for each provider."""
from crewai_core.telemetry import common_span_attributes