mirror of
https://github.com/HKUDS/OpenSpace.git
synced 2026-09-24 00:55:36 +00:00
0711cfd7fa
Changes: - Disable telemetry by default (opt-in instead of opt-out) - Strip user query text and LLM response text from telemetry events - Remove server_identifiers and tools_available_names from telemetry - Default search_scope to 'local' (no auto-import of unverified cloud skills) - Default auto_import to False in search_skills - Scope OpenClaw credential reading to openspace env block only - Enable sandbox by default in security config - Add SECURITY.md with guidance for users See PR description for full security audit findings.
92 lines
No EOL
3.1 KiB
Python
92 lines
No EOL
3.1 KiB
Python
from abc import ABC, abstractmethod
|
|
from dataclasses import dataclass
|
|
from typing import Any
|
|
|
|
|
|
class BaseTelemetryEvent(ABC):
|
|
"""Base class for all telemetry events"""
|
|
|
|
@property
|
|
@abstractmethod
|
|
def name(self) -> str:
|
|
"""Event name for tracking"""
|
|
pass
|
|
|
|
@property
|
|
@abstractmethod
|
|
def properties(self) -> dict[str, Any]:
|
|
"""Event properties to send with the event"""
|
|
pass
|
|
|
|
|
|
@dataclass
|
|
class MCPAgentExecutionEvent(BaseTelemetryEvent):
|
|
"""Comprehensive event for tracking complete MCP agent execution"""
|
|
|
|
# Execution method and context
|
|
execution_method: str # "run" or "astream"
|
|
query: str # The actual user query
|
|
success: bool
|
|
|
|
# Agent configuration
|
|
model_provider: str
|
|
model_name: str
|
|
server_count: int
|
|
server_identifiers: list[dict[str, str]]
|
|
total_tools_available: int
|
|
tools_available_names: list[str]
|
|
max_steps_configured: int
|
|
memory_enabled: bool
|
|
use_server_manager: bool
|
|
|
|
# Execution PARAMETERS
|
|
max_steps_used: int | None
|
|
manage_connector: bool
|
|
external_history_used: bool
|
|
|
|
# Execution results
|
|
steps_taken: int | None = None
|
|
tools_used_count: int | None = None
|
|
tools_used_names: list[str] | None = None
|
|
response: str | None = None # The actual response
|
|
execution_time_ms: int | None = None
|
|
error_type: str | None = None
|
|
|
|
# Context
|
|
conversation_history_length: int | None = None
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
return "mcp_agent_execution"
|
|
|
|
@property
|
|
def properties(self) -> dict[str, Any]:
|
|
return {
|
|
# Core execution info
|
|
"execution_method": self.execution_method,
|
|
# NOTE: query and response text are intentionally excluded to
|
|
# prevent exfiltration of potentially sensitive user data.
|
|
# Only lengths are reported for aggregate analytics.
|
|
"query_length": len(self.query),
|
|
"success": self.success,
|
|
# Agent configuration
|
|
"model_provider": self.model_provider,
|
|
"model_name": self.model_name,
|
|
"server_count": self.server_count,
|
|
"total_tools_available": self.total_tools_available,
|
|
"max_steps_configured": self.max_steps_configured,
|
|
"memory_enabled": self.memory_enabled,
|
|
"use_server_manager": self.use_server_manager,
|
|
# Execution parameters (always include, even if None)
|
|
"max_steps_used": self.max_steps_used,
|
|
"manage_connector": self.manage_connector,
|
|
"external_history_used": self.external_history_used,
|
|
# Execution results (always include, even if None)
|
|
"steps_taken": self.steps_taken,
|
|
"tools_used_count": self.tools_used_count,
|
|
"tools_used_names": self.tools_used_names,
|
|
"response_length": len(self.response) if self.response else None,
|
|
"execution_time_ms": self.execution_time_ms,
|
|
"error_type": self.error_type,
|
|
"conversation_history_length": self.conversation_history_length,
|
|
} |