Skip to content

Devtrack-v0.4-Pulse-deployment#24

Merged
mahesh-solanke merged 13 commits into
mainfrom
devtrack/pulse-q4-dashboard
Nov 30, 2025
Merged

Devtrack-v0.4-Pulse-deployment#24
mahesh-solanke merged 13 commits into
mainfrom
devtrack/pulse-q4-dashboard

Conversation

@mahesh-solanke

@mahesh-solanke mahesh-solanke commented Nov 30, 2025

Copy link
Copy Markdown
Owner

🚀 Release v0.4.0 - Pulse: Dashboard & Real-Time Metrics

📋 Overview

This MR introduces DevTrack SDK v0.4.0 (Pulse) - a major release that transforms DevTrack from a logging tool into a full observability platform with a built-in real-time dashboard and comprehensive metrics APIs.

🎯 Goal

Provide a real-time, interactive analytics console running alongside your API.

✨ Major Features

📊 Built-in Real-Time Dashboard

  • Interactive Dashboard at /__devtrack__/dashboard

    • Traffic Overview – requests over time with interactive charts
    • Error Trends – failure rates & top failing routes
    • Performance Metrics – p50/p95/p99 latency charts
    • Request Logs – searchable & filterable table
    • Consumer Segmentation – identify and analyze API consumers
    • KPI Cards – key metrics at a glance
  • Auto-refresh (5–30 s) toggle

  • Modern UI built with React + Tailwind CSS

  • Zero configuration - works out of the box

🔌 New Metrics API Endpoints

JSON APIs for Integration:

  • GET /__devtrack__/metrics/traffic - Traffic counts over time
  • GET /__devtrack__/metrics/errors - Error trends and top failing routes
  • GET /__devtrack__/metrics/perf - Performance metrics (p50/p95/p99)
  • GET /__devtrack__/consumers - Consumer segmentation data

All endpoints support hours query parameter for time range filtering.

👥 Consumer Segmentation

  • Automatically identify API consumers via headers, JWTs, IPs, or auth context
  • Track request patterns per consumer
  • Analyze error rates and latency by consumer
  • Privacy-friendly hashed identifiers
  • No API key required

🛠️ Technical Implementation

  • Dashboard built with React + Tailwind, bundled with FastAPI static files
  • Async batching writer for minimal overhead
  • Enhanced database queries for metrics aggregation
  • Optimized SQL queries for time-series data
  • Efficient percentile calculations

📦 Changes

Added

  • Built-in dashboard at /__devtrack__/dashboard
  • Traffic metrics API endpoint
  • Error trends API endpoint
  • Performance metrics API endpoint
  • Consumer segmentation API endpoint
  • Auto-refresh functionality in dashboard
  • KPI cards component
  • Interactive charts for all metrics

Improved

  • Database query performance for metrics
  • Error handling in API routes
  • Dashboard asset serving
  • Consumer identification logic

Fixed

  • Dashboard API URL injection
  • Asset path resolution
  • Time bucket calculations
  • Database connection handling in tests

✅ Testing

Status: ✅ ALL TESTS PASSING

  • Django Integration: 10/10 tests passing
  • CLI Commands: 13/13 tests passing
  • v0.4.0 Metrics Endpoints: 9/9 tests passing
  • FastAPI Middleware: 16/16 tests passing

Total: 48+ tests passing

For detailed test results, see: Final Test Summary

🔄 Migration

No breaking changes! This is a backward-compatible release.

Simply upgrade:

pip install --upgrade devtrack-sdk

The dashboard will be automatically available at /__devtrack__/dashboard after upgrade.

📚 Documentation

🎯 Version Update

All version numbers updated from 0.3.0 to 0.4.0:

  • devtrack_sdk/__version__.py
  • setup.py
  • pyproject.toml
  • README.md
  • Documentation files
  • Example files

📝 Checklist

  • All features implemented
  • All tests passing
  • Version numbers updated
  • Documentation updated
  • Release notes created
  • Examples updated
  • No breaking changes
  • Backward compatible
  • Database connection issues fixed

🔗 Related


- Introduced a new FastAPI route to serve the DevTrack dashboard HTML page.
- Implemented dynamic API URL replacement in the dashboard for better integration.
- Added a new HTML file for the dashboard, featuring real-time metrics visualization using Chart.js.
- Enhanced styling and layout for improved user experience.

Files: devtrack_sdk/controller/devtrack_routes.py, devtrack_sdk/dashboard/index.html
- Added `client_identifier_hash` column to `request_logs` for improved client tracking.
- Implemented new methods in `DevTrackDB` for retrieving traffic metrics, error trends, performance metrics, and consumer segmentation data.
- Updated Django middleware to hash sensitive client identifiers and improve client identification from multiple sources.
- Enhanced FastAPI routes to expose new metrics endpoints for traffic, errors, performance, and consumer data.
- Updated dashboard HTML to visualize traffic, error trends, performance metrics, and consumer segmentation.

Files: devtrack_sdk/database.py, devtrack_sdk/django_middleware.py, devtrack_sdk/controller/devtrack_routes.py, devtrack_sdk/dashboard/index.html
- Added a new React-based dashboard for visualizing metrics, including traffic, error trends, performance metrics, and consumer segmentation.
- Implemented dynamic API URL injection in the dashboard for seamless integration with FastAPI.
- Enhanced Django middleware and FastAPI routes to serve the dashboard and its static assets.
- Updated database schema and logging mechanisms to support new dashboard features.
- Included necessary files for building and serving the dashboard, including configuration for Vite, Tailwind CSS, and Chart.js.

Files: .gitignore, MANIFEST.in, pyproject.toml, setup.py, devtrack_sdk/database.py, devtrack_sdk/django_middleware.py, devtrack_sdk/django_urls.py, devtrack_sdk/django_views.py, devtrack_sdk/controller/devtrack_routes.py, devtrack_sdk/dashboard/*
- Added DevTrack SDK logo to the documentation homepage for better branding.
- Improved layout by restructuring the alignment of the introductory text.

Files: docs/index.md
- Added DevTrack SDK logo to the README for improved branding.
- Updated the path for the logo in the documentation index to ensure correct display.

Files: README.md, docs/index.md, static/devtrack-logo.png
- Changed email contact link to LinkedIn profile for improved accessibility and professional networking.

Files: README.md
- Added a LinkedIn company link for DevTrackHQ to improve professional networking.
- Included a badge for DevTrackHQ in the README for better visibility and branding.

Files: README.md, static/company-logo.png
…board

- Introduced a built-in real-time dashboard for visualizing API performance metrics, including traffic, error trends, and consumer segmentation.
- Added new metrics API endpoints for traffic, errors, performance, and consumer data.
- Enhanced FastAPI and Django integrations to support the new dashboard and metrics features.
- Updated all version references to 0.4.0 across documentation and codebase.
- Conducted extensive testing, achieving 100% pass rate across all test suites.

Files: FINAL_TEST_SUMMARY.md, GITHUB_RELEASE_0.4.0.md, manual_test_verification.py, pyproject.toml, README.md, RELEASE_REVIEW_0.4.0.md, setup.py, TEST_REPORT_0.4.0.md, devtrack_sdk/__version__.py, devtrack_sdk/dashboard/*, docs/*, examples/*, tests/*
- Included a new section for Testing & Quality Assurance with a link to the Final Test Summary for detailed test results and verification.

Files: docs/release/RELEASE_NOTES DevTrack SDK v0.4.0.md
@mahesh-solanke mahesh-solanke self-assigned this Nov 30, 2025
- Changed the status of v0.4 from "In Progress" to "Released" and updated the release target to "Current" to accurately represent its availability.

Files: docs/release/ROADMAP.md
…rackDB

- Enhanced the connection management to check if the thread-local database connection is alive and reconnect if necessary.
- Updated the query execution method to handle cases where column descriptions may not be available, providing fallback column names for consistency.
- Added cleanup logic in tests to ensure proper closure of thread-local connections after use.

Files: devtrack_sdk/database.py, tests/test_middleware.py
…ics APIs

- Launched a major release of DevTrack SDK, transforming it into a full observability platform.
- Added a built-in real-time dashboard for visualizing traffic, error trends, and performance metrics.
- Introduced new metrics API endpoints for traffic, errors, performance, and consumer segmentation.
- Enhanced database query performance and improved error handling in API routes.
- Ensured backward compatibility with no breaking changes.

Files: MERGE_REQUEST_0.4.0.md
- Deleted the MERGE_REQUEST_0.4.0.md file as it is no longer needed following the release of DevTrack SDK v0.4.0.
- This cleanup helps maintain a tidy project structure and removes unnecessary documentation.

Files: MERGE_REQUEST_0.4.0.md
@mahesh-solanke mahesh-solanke merged commit fc2e576 into main Nov 30, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant