File size: 24,432 Bytes
aaa787c c4d5a2b aaa787c fcee23a c4d5a2b aaa787c c4d5a2b fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c fcee23a aaa787c 9eebcb4 aaa787c fcee23a aaa787c fcee23a c4d5a2b aaa787c fcee23a aaa787c c4d5a2b aaa787c |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 |
#!/usr/bin/env python3
"""Generate usage reports from telemetry data.
This script analyzes Mosaic telemetry data and generates reports for:
- Cost tracking (app uptime and estimated costs)
- Usage summary (analyses, slides, sessions)
- Failure analysis
Usage:
# Full report (all time)
python scripts/telemetry_report.py /path/to/telemetry
# Daily report for yesterday (cron-friendly)
python scripts/telemetry_report.py /path/to/telemetry --daily
# Daily report for specific date
python scripts/telemetry_report.py /path/to/telemetry --date 2026-01-20
# Email output (pipe to sendmail or use with cron)
python scripts/telemetry_report.py /path/to/telemetry --daily --email user@example.com
# Skip email if report is empty (useful for automated daily reports)
python scripts/telemetry_report.py /path/to/telemetry --daily --email user@example.com --skip-empty
# HTML format for email
python scripts/telemetry_report.py /path/to/telemetry --daily --format html
# Pull data from HuggingFace Dataset repository
python scripts/telemetry_report.py --hf-repo PDM-Group/mosaic-telemetry
# Pull from HF and save to specific directory
python scripts/telemetry_report.py /path/to/telemetry --hf-repo PDM-Group/mosaic-telemetry
Example cron entry (daily report at 8am, skip if empty):
0 8 * * * python /app/scripts/telemetry_report.py /data/telemetry --daily --email team@example.com --skip-empty
"""
import argparse
import json
import os
import smtplib
import sys
from datetime import datetime, timedelta
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
from pathlib import Path
from typing import Optional
DEFAULT_HOURLY_RATE = 0.40
def load_events(
telemetry_dir: Path, event_type: str, date: Optional[str] = None
) -> list:
"""Load events from JSONL files.
Args:
telemetry_dir: Base telemetry directory
event_type: Type of event ("session", "usage", "resource", "failure")
date: Optional date filter in YYYY-MM-DD format
Returns:
List of event dictionaries
"""
events = []
daily_dir = telemetry_dir / "daily"
if not daily_dir.exists():
return events
if date:
# Load specific date file
file_path = daily_dir / f"{event_type}_{date}.jsonl"
if file_path.exists():
with open(file_path, encoding="utf-8") as fp:
for line in fp:
if line.strip():
events.append(json.loads(line))
else:
# Load all files
for f in daily_dir.glob(f"{event_type}_*.jsonl"):
with open(f, encoding="utf-8") as fp:
for line in fp:
if line.strip():
events.append(json.loads(line))
return events
def is_report_empty(
sessions: list, usage: list, resources: list, failures: list
) -> bool:
"""Check if report would be empty (no meaningful data).
Args:
sessions: Session events
usage: Usage events
resources: Resource events
failures: Failure events
Returns:
True if report is empty, False otherwise
"""
# Check if there are any meaningful events
has_sessions = bool(sessions)
has_usage = bool(usage)
has_resources = bool(resources)
has_failures = bool(failures)
return not (has_sessions or has_usage or has_resources or has_failures)
def generate_text_report(telemetry_dir: Path, date: Optional[str] = None) -> str:
"""Generate plain text report.
Args:
telemetry_dir: Base telemetry directory
date: Optional date filter
Returns:
Report as string
"""
sessions = load_events(telemetry_dir, "session", date)
usage = load_events(telemetry_dir, "usage", date)
resources = load_events(telemetry_dir, "resource", date)
failures = load_events(telemetry_dir, "failure", date)
lines = []
date_label = f" for {date}" if date else " (All Time)"
lines.append("=" * 60)
lines.append(f"MOSAIC TELEMETRY REPORT{date_label}")
lines.append("=" * 60)
lines.append(f"Generated: {datetime.utcnow().isoformat()}Z")
lines.append("")
# Cost summary from session events
if sessions:
shutdowns = [s for s in sessions if s.get("event_type") == "app_shutdown"]
# For running instances without shutdowns, use the latest heartbeat per session
if not shutdowns:
# Group heartbeats by app_start_time to identify unique sessions
heartbeats = [s for s in sessions if s.get("event_type") == "heartbeat"]
if heartbeats:
# Get the latest heartbeat for each session (by app_start_time)
sessions_by_start = {}
for hb in heartbeats:
start_time = hb.get("app_start_time")
if start_time:
if start_time not in sessions_by_start or hb.get(
"uptime_sec", 0
) > sessions_by_start[start_time].get("uptime_sec", 0):
sessions_by_start[start_time] = hb
shutdowns = list(sessions_by_start.values())
if shutdowns:
total_uptime_sec = sum(s.get("uptime_sec", 0) for s in shutdowns)
total_uptime_hrs = total_uptime_sec / 3600
total_analysis_sec = sum(s.get("analysis_time_sec", 0) for s in shutdowns)
total_analysis_hrs = total_analysis_sec / 3600
total_idle_hrs = total_uptime_hrs - total_analysis_hrs
# Use hourly_rate from data, fallback to DEFAULT if missing or zero
hourly_rate = shutdowns[0].get("hourly_rate") or DEFAULT_HOURLY_RATE
total_cost = total_uptime_hrs * hourly_rate
analysis_count = sum(s.get("analysis_count", 0) for s in shutdowns)
utilization = (
(total_analysis_hrs / total_uptime_hrs * 100)
if total_uptime_hrs > 0
else 0
)
# Check if these are from running instances (heartbeats) vs completed (shutdowns)
is_running = all(s.get("event_type") == "heartbeat" for s in shutdowns)
session_label = (
f"Running sessions: {len(shutdowns)}"
if is_running
else f"App sessions: {len(shutdowns)}"
)
lines.append("=== COST SUMMARY ===")
lines.append(session_label)
lines.append(f"Total uptime: {total_uptime_hrs:.2f} hours")
lines.append(
f" - Active analysis: {total_analysis_hrs:.2f} hrs ({utilization:.1f}%)"
)
lines.append(
f" - Idle time: {total_idle_hrs:.2f} hrs ({100-utilization:.1f}%)"
)
lines.append(f"Estimated cost: ${total_cost:.2f} (@ ${hourly_rate}/hr)")
if analysis_count > 0:
lines.append(f"Cost per analysis: ${total_cost / analysis_count:.2f}")
lines.append("")
# Usage summary
if usage:
starts = [u for u in usage if u.get("event_type") == "analysis_start"]
completes = [u for u in usage if u.get("event_type") == "analysis_complete"]
successful = [c for c in completes if c.get("success", False)]
total_slides = sum(s.get("slide_count", 0) for s in starts)
unique_sessions = len(
set(u.get("session_hash") for u in usage if u.get("session_hash"))
)
# Calculate average duration
durations = [
c.get("duration_sec", 0) for c in completes if c.get("duration_sec")
]
avg_duration = sum(durations) / len(durations) if durations else 0
lines.append("=== USAGE SUMMARY ===")
lines.append(f"Analyses started: {len(starts)}")
lines.append(f"Analyses completed: {len(completes)}")
lines.append(f"Successful analyses: {len(successful)}")
lines.append(f"Total slides processed: {total_slides}")
lines.append(f"Unique sessions: {unique_sessions}")
if avg_duration > 0:
lines.append(f"Average analysis duration: {avg_duration:.1f}s")
lines.append("")
# Breakdown by settings
site_types = {}
seg_configs = {}
for s in starts:
st = s.get("site_type", "Unknown")
site_types[st] = site_types.get(st, 0) + 1
sc = s.get("seg_config", "Unknown")
seg_configs[sc] = seg_configs.get(sc, 0) + 1
if site_types:
lines.append("By site type:")
for st, count in sorted(site_types.items(), key=lambda x: -x[1]):
lines.append(f" {st}: {count}")
lines.append("")
if seg_configs:
lines.append("By segmentation config:")
for sc, count in sorted(seg_configs.items(), key=lambda x: -x[1]):
lines.append(f" {sc}: {count}")
lines.append("")
# Resource summary
if resources:
total_duration = sum(r.get("total_duration_sec", 0) for r in resources)
total_tiles = sum(
r.get("tile_count", 0) for r in resources if r.get("tile_count")
)
peak_memory = max(
(r.get("peak_gpu_memory_gb", 0) for r in resources), default=0
)
lines.append("=== RESOURCE SUMMARY ===")
lines.append(f"Total slide processing time: {total_duration / 3600:.2f} hours")
lines.append(f"Total tiles processed: {total_tiles:,}")
if peak_memory > 0:
lines.append(f"Peak GPU memory: {peak_memory:.2f} GB")
lines.append("")
# Failure summary
if failures:
lines.append(f"=== FAILURES ({len(failures)}) ===")
error_counts = {}
for f in failures:
error_type = f.get("error_type", "Unknown")
error_counts[error_type] = error_counts.get(error_type, 0) + 1
for error_type, count in sorted(error_counts.items(), key=lambda x: -x[1])[:10]:
lines.append(f" {error_type}: {count}")
# Show recent failure messages
lines.append("")
lines.append("Recent failure messages:")
for f in failures[-5:]:
msg = f.get("error_message", "")[:100]
stage = f.get("error_stage", "unknown")
lines.append(f" [{stage}] {msg}")
lines.append("")
else:
lines.append("=== NO FAILURES ===")
lines.append("")
lines.append("=" * 60)
return "\n".join(lines)
def generate_html_report(telemetry_dir: Path, date: Optional[str] = None) -> str:
"""Generate HTML report.
Args:
telemetry_dir: Base telemetry directory
date: Optional date filter
Returns:
Report as HTML string
"""
sessions = load_events(telemetry_dir, "session", date)
usage = load_events(telemetry_dir, "usage", date)
resources = load_events(telemetry_dir, "resource", date)
failures = load_events(telemetry_dir, "failure", date)
date_label = f" for {date}" if date else " (All Time)"
html = []
html.append("<!DOCTYPE html>")
html.append("<html><head>")
html.append("<meta charset='utf-8'>")
html.append(f"<title>Mosaic Telemetry Report{date_label}</title>")
html.append("<style>")
html.append("body { font-family: Arial, sans-serif; margin: 20px; }")
html.append("h1 { color: #2c3e50; }")
html.append("h2 { color: #34495e; border-bottom: 1px solid #eee; }")
html.append("table { border-collapse: collapse; margin: 10px 0; }")
html.append("th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }")
html.append("th { background-color: #f5f5f5; }")
html.append(".metric { font-size: 24px; font-weight: bold; color: #2980b9; }")
html.append(".cost { color: #e74c3c; }")
html.append(".success { color: #27ae60; }")
html.append("</style>")
html.append("</head><body>")
html.append(f"<h1>Mosaic Telemetry Report{date_label}</h1>")
html.append(f"<p>Generated: {datetime.utcnow().isoformat()}Z</p>")
# Cost summary
if sessions:
shutdowns = [s for s in sessions if s.get("event_type") == "app_shutdown"]
# For running instances without shutdowns, use the latest heartbeat per session
if not shutdowns:
heartbeats = [s for s in sessions if s.get("event_type") == "heartbeat"]
if heartbeats:
sessions_by_start = {}
for hb in heartbeats:
start_time = hb.get("app_start_time")
if start_time:
if start_time not in sessions_by_start or hb.get(
"uptime_sec", 0
) > sessions_by_start[start_time].get("uptime_sec", 0):
sessions_by_start[start_time] = hb
shutdowns = list(sessions_by_start.values())
if shutdowns:
total_uptime_sec = sum(s.get("uptime_sec", 0) for s in shutdowns)
total_uptime_hrs = total_uptime_sec / 3600
total_analysis_sec = sum(s.get("analysis_time_sec", 0) for s in shutdowns)
total_analysis_hrs = total_analysis_sec / 3600
hourly_rate = shutdowns[0].get("hourly_rate") or DEFAULT_HOURLY_RATE
total_cost = total_uptime_hrs * hourly_rate
analysis_count = sum(s.get("analysis_count", 0) for s in shutdowns)
utilization = (
(total_analysis_hrs / total_uptime_hrs * 100)
if total_uptime_hrs > 0
else 0
)
is_running = all(s.get("event_type") == "heartbeat" for s in shutdowns)
session_label = (
f"Running sessions: {len(shutdowns)}"
if is_running
else f"App sessions: {len(shutdowns)}"
)
html.append("<h2>Cost Summary</h2>")
html.append("<table>")
html.append(
f"<tr><td>{session_label.split(':')[0]}</td><td>{len(shutdowns)}</td></tr>"
)
html.append(
f"<tr><td>Total uptime</td><td>{total_uptime_hrs:.2f} hours</td></tr>"
)
html.append(
f"<tr><td>Active analysis time</td><td>{total_analysis_hrs:.2f} hours ({utilization:.1f}%)</td></tr>"
)
html.append(
f"<tr><td>Estimated cost</td><td class='cost'>${total_cost:.2f}</td></tr>"
)
if analysis_count > 0:
html.append(
f"<tr><td>Cost per analysis</td><td>${total_cost/analysis_count:.2f}</td></tr>"
)
html.append("</table>")
# Usage summary
if usage:
starts = [u for u in usage if u.get("event_type") == "analysis_start"]
completes = [u for u in usage if u.get("event_type") == "analysis_complete"]
successful = [c for c in completes if c.get("success", False)]
total_slides = sum(s.get("slide_count", 0) for s in starts)
unique_sessions = len(
set(u.get("session_hash") for u in usage if u.get("session_hash"))
)
html.append("<h2>Usage Summary</h2>")
html.append("<table>")
html.append(f"<tr><td>Analyses started</td><td>{len(starts)}</td></tr>")
html.append(f"<tr><td>Analyses completed</td><td>{len(completes)}</td></tr>")
html.append(
f"<tr><td>Successful analyses</td><td class='success'>{len(successful)}</td></tr>"
)
html.append(f"<tr><td>Total slides</td><td>{total_slides}</td></tr>")
html.append(f"<tr><td>Unique sessions</td><td>{unique_sessions}</td></tr>")
html.append("</table>")
# Failures
if failures:
html.append(f"<h2>Failures ({len(failures)})</h2>")
html.append("<table>")
html.append("<tr><th>Error Type</th><th>Count</th></tr>")
error_counts = {}
for f in failures:
error_type = f.get("error_type", "Unknown")
error_counts[error_type] = error_counts.get(error_type, 0) + 1
for error_type, count in sorted(error_counts.items(), key=lambda x: -x[1])[:10]:
html.append(f"<tr><td>{error_type}</td><td>{count}</td></tr>")
html.append("</table>")
html.append("</body></html>")
return "\n".join(html)
def send_email(report: str, to_email: str, subject: str, format: str = "text"):
"""Send report via email using SMTP.
Args:
report: Report content
to_email: Recipient email address
subject: Email subject
format: "text" or "html"
"""
from_email = os.environ.get("SMTP_FROM", "mosaic-telemetry@noreply.local")
smtp_host = os.environ.get("SMTP_HOST", "localhost")
smtp_port_env = os.environ.get("SMTP_PORT", "25")
try:
smtp_port = int(smtp_port_env)
except ValueError:
smtp_port = 25
smtp_user = os.environ.get("SMTP_USER")
smtp_pass = os.environ.get("SMTP_PASS")
msg = MIMEMultipart("alternative")
msg["Subject"] = subject
msg["From"] = from_email
msg["To"] = to_email
if format == "html":
msg.attach(MIMEText(report, "html"))
else:
msg.attach(MIMEText(report, "plain"))
with smtplib.SMTP(smtp_host, smtp_port) as server:
if smtp_user and smtp_pass:
server.starttls()
server.login(smtp_user, smtp_pass)
server.sendmail(from_email, [to_email], msg.as_string())
def download_from_hf(repo_id: str, telemetry_dir: Path) -> bool:
"""Download telemetry data from HuggingFace Dataset repository.
Args:
repo_id: HuggingFace Dataset repository ID
telemetry_dir: Local directory to store downloaded files
Returns:
True if download was successful, False otherwise
"""
try:
from mosaic.telemetry.storage import TelemetryStorage
except ImportError:
# Fallback for standalone usage without mosaic installed
try:
from huggingface_hub import HfApi, hf_hub_download
except ImportError:
print(
"huggingface_hub not installed. Install with: pip install huggingface-hub",
file=sys.stderr,
)
return False
api = HfApi()
daily_dir = telemetry_dir / "daily"
daily_dir.mkdir(parents=True, exist_ok=True)
try:
files = api.list_repo_files(repo_id=repo_id, repo_type="dataset")
except Exception as e:
print(f"Failed to list files in {repo_id}: {e}", file=sys.stderr)
return False
jsonl_files = [
f for f in files if f.startswith("daily/") and f.endswith(".jsonl")
]
if not jsonl_files:
print(f"No telemetry files found in {repo_id}", file=sys.stderr)
return False
downloaded = 0
for remote_path in jsonl_files:
try:
local_path = hf_hub_download(
repo_id=repo_id,
filename=remote_path,
repo_type="dataset",
)
filename = os.path.basename(remote_path)
target_path = daily_dir / filename
with open(local_path, "r", encoding="utf-8") as f:
remote_content = f.read()
if target_path.exists():
with open(target_path, "r", encoding="utf-8") as f:
local_content = f.read()
local_lines = (
set(local_content.strip().split("\n"))
if local_content.strip()
else set()
)
remote_lines = (
remote_content.strip().split("\n")
if remote_content.strip()
else []
)
new_lines = [
line
for line in remote_lines
if line and line not in local_lines
]
if new_lines:
with open(target_path, "a", encoding="utf-8") as f:
for line in new_lines:
f.write(line + "\n")
print(f"Merged {len(new_lines)} new events into {filename}")
else:
with open(target_path, "w", encoding="utf-8") as f:
f.write(remote_content)
print(f"Downloaded: {filename}")
downloaded += 1
except Exception as e:
print(f"Failed to download {remote_path}: {e}", file=sys.stderr)
return downloaded > 0
# Use TelemetryStorage if mosaic is available
storage = TelemetryStorage(telemetry_dir)
return storage.download_from_hf_dataset(repo_id)
def main():
parser = argparse.ArgumentParser(
description="Generate Mosaic telemetry reports",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=__doc__,
)
parser.add_argument(
"telemetry_dir",
type=Path,
nargs="?",
default=Path("/tmp/mosaic_telemetry"),
help="Telemetry directory (default: /tmp/mosaic_telemetry)",
)
parser.add_argument(
"--daily",
action="store_true",
help="Report for yesterday only",
)
parser.add_argument(
"--date",
type=str,
help="Report for specific date (YYYY-MM-DD)",
)
parser.add_argument(
"--email",
type=str,
help="Send report to this email address",
)
parser.add_argument(
"--format",
choices=["text", "html"],
default="text",
help="Output format (default: text)",
)
parser.add_argument(
"--hf-repo",
type=str,
help="HuggingFace Dataset repository to pull telemetry from (e.g., PDM-Group/mosaic-telemetry)",
)
parser.add_argument(
"--skip-empty",
action="store_true",
help="Skip sending email if report has no data (useful for automated daily reports)",
)
args = parser.parse_args()
# If HF repo specified, download to a clean temp directory
if args.hf_repo:
import tempfile
# Use a clean temp directory to avoid mixing with local data
temp_dir = Path(tempfile.mkdtemp(prefix="mosaic_telemetry_"))
print(f"Downloading telemetry from {args.hf_repo}...")
if not download_from_hf(args.hf_repo, temp_dir):
print(
"Warning: Failed to download some or all telemetry data",
file=sys.stderr,
)
# Use the temp directory for report generation
args.telemetry_dir = temp_dir
if not args.telemetry_dir.exists():
print(f"Telemetry directory not found: {args.telemetry_dir}", file=sys.stderr)
sys.exit(1)
# Determine date filter
date = args.date
if args.daily and not date:
date = (datetime.now() - timedelta(days=1)).strftime("%Y-%m-%d")
# Check if report would be empty before generating
if args.skip_empty:
sessions = load_events(args.telemetry_dir, "session", date)
usage = load_events(args.telemetry_dir, "usage", date)
resources = load_events(args.telemetry_dir, "resource", date)
failures = load_events(args.telemetry_dir, "failure", date)
if is_report_empty(sessions, usage, resources, failures):
print(f"Skipping empty report for {date or 'all time'}")
sys.exit(0)
# Generate report
if args.format == "html":
report = generate_html_report(args.telemetry_dir, date=date)
else:
report = generate_text_report(args.telemetry_dir, date=date)
# Output
if args.email:
subject = f"Mosaic Telemetry Report - {date or 'All Time'}"
try:
send_email(report, args.email, subject, args.format)
print(f"Report sent to {args.email}")
except Exception as e:
print(f"Failed to send email: {e}", file=sys.stderr)
print(report) # Print report to stdout as fallback
sys.exit(1)
else:
print(report)
if __name__ == "__main__":
main()
|