Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/app/settings/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
"simple_history.middleware.HistoryRequestMiddleware",
"telemetry.middleware.MCPUsageLoggerMiddleware", # Must come last!
"telemetry.middleware.ClientUsageLoggerMiddleware", # Must come last!
]

ADD_NEVER_CACHE_HEADERS = env.bool("ADD_NEVER_CACHE_HEADERS", True)
Expand Down
66 changes: 51 additions & 15 deletions api/telemetry/middleware.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import re
from collections.abc import Callable
from typing import Literal

import structlog
from django.http.request import HttpRequest
Expand All @@ -7,9 +9,14 @@

from telemetry.spans import get_span_attribute

# e.g. `flagsmith-cli/2.0.0 (darwin/arm64)`
CLI_USER_AGENT_PATTERN = re.compile(
r"^flagsmith-cli/(?P<version>[^\s/]+) \((?P<os>[^\s/()]+)/(?P<arch>[^\s/()]+)\)"
)

class MCPUsageLoggerMiddleware:
"""Emit telemetry events for MCP usage"""

class ClientUsageLoggerMiddleware:
"""Emit telemetry events for usage of Flagsmith clients, i.e. MCP and CLI"""

def __init__(
self,
Expand All @@ -20,26 +27,54 @@ def __init__(
def __call__(self, request: HttpRequest) -> HttpResponse:
response = self.get_response(request)

if baggage.get_baggage("flagsmith.client.name") != "flagsmith-mcp":
return response
if baggage.get_baggage("flagsmith.client.name") == "flagsmith-mcp":
self._log_mcp_usage(request, response)
elif cli := CLI_USER_AGENT_PATTERN.match(request.headers.get("User-Agent", "")):
self._log_cli_usage(request, response, cli)

return response

def _log_mcp_usage(self, request: HttpRequest, response: HttpResponse) -> None:
if not request.user or not request.user.is_authenticated:
return response
return

# NOTE: The following W3C Baggage items are added by downstream processor
# - gen_ai.tool.name
# - flagsmith.mcp.client.name
# - flagsmith.mcp.client.version
logger = structlog.get_logger("mcp")
event = {
# NOTE: The following W3C Baggage items are added by downstream processor
# - gen_ai.tool.name
# - flagsmith.mcp.client.name
# - flagsmith.mcp.client.version
"status": "error" if response.status_code >= 400 else "success",
}
logger = logger.bind(status=self._get_status(response))
if (org_id := self._get_organisation_id(request)) is not None:
logger.info("tool.called", organisation__id=org_id, **event)
logger.info("tool.called", organisation__id=org_id)
else:
logger.warning("tool.called", organisation__id=None, **event)
logger.warning("tool.called", organisation__id=None)

return response
def _log_cli_usage(
self,
request: HttpRequest,
response: HttpResponse,
cli: re.Match[str],
) -> None:
if not request.user or not request.user.is_authenticated:
return

logger = structlog.get_logger("cli")
logger = logger.bind(
cli__version=cli["version"],
cli__os=cli["os"],
cli__arch=cli["arch"],
status=self._get_status(response),
)
if not getattr(request.user, "is_master_api_key_user", False):
logger = logger.bind(amplitude__user_id=str(request.user.uuid))

if (org_id := self._get_organisation_id(request)) is not None:
logger.info("request.made", organisation__id=org_id)
else:
logger.warning("request.made", organisation__id=None)

def _get_status(self, response: HttpResponse) -> Literal["success", "error"]:
return "error" if response.status_code >= 400 else "success"

def _get_organisation_id(self, request: HttpRequest) -> int | None:
"""Obtain the organisation ID from the request context."""
Expand All @@ -51,6 +86,7 @@ def _get_organisation_id(self, request: HttpRequest) -> int | None:

assert request.user.is_authenticated # NOTE: protected upstream
try: # Most of the time, the user belongs to one organisation
# NOTE: Master API keys belong to exactly one organisation
return request.user.organisations.get().id
except (
Organisation.DoesNotExist,
Expand Down
Loading
Loading