Skip to main content

Metrics Tracker API

The metrics tracking system provides comprehensive monitoring and performance tracking capabilities for the video processing pipeline.

Classes

MetricsTracker

Main class for tracking and storing processing metrics.
constructor
Initialize a new metrics tracker

Methods

method
Start tracking metrics for a video processing run
method
End tracking metrics and save results
method
Update current metrics with new values
method
Record an API call with its latency
method
Add a custom metric
method
Get current metrics as dictionary

Timer

Context manager for timing operations with enhanced metrics tracking.
constructor
Initialize a timer for operation tracking

SystemMetrics

Data class for system resource metrics.

PerformanceMetrics

Data class for performance-related metrics.

Methods

method
Add a latency measurement
method
Add a throughput measurement
method
Add a processing time measurement
method
Record an API call with its latency

Examples

Basic Usage

Accessing Metrics

Custom Metrics

System Resource Monitoring

Performance Tracking

Best Practices

  1. Always use try/finally to ensure proper cleanup:
  2. Use the Timer context manager for accurate timing:
  3. Add custom metrics for application-specific monitoring:
  4. Monitor system resources for performance optimization:
  5. Use appropriate operation types for timing: