Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update metrics tracker to most recent specifications #967

Merged
merged 46 commits into from
Aug 11, 2024

Conversation

defagos
Copy link
Member

@defagos defagos commented Aug 9, 2024

Description

This PR updates our metrics tracker implementation so that it conforms to the latest version of our specifications. After having identified a few issues during the implementation I also realized that having no UTs for our metrics tracker implementation was risky. I therefore introduced the necessary testing infrastructure so that we can ensure our implementation stays reliable over time.

Changes made

  • Avoid stop event being sent when no start event has been sent.
  • Use metric event date as date sent to the monitoring service.
  • Use lower-case UUIDs which are more standard, improving consistency with UUIDs delivered by Android and the web.
  • Send bitrate and bandwidth in bits per second.
  • Add schema version.
  • Group stall information.
  • Rename key for storage of QoE metrics.
  • Implement heartbeats.
  • Revisit metrics tracker configuration to support optional heartbeat interval customization.
  • Introduce testing infrastructure and improve consistency with the similar formalism existing for analytics tracker testing.
  • Fix PillarboxMonitoring scheme.
  • Fix MB calculation.
  • Cache device type in comScore analytics.
  • Group files in a better way in Monitoring and Analytics packages.

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

@defagos defagos linked an issue Aug 9, 2024 that may be closed by this pull request
12 tasks
@defagos defagos enabled auto-merge August 9, 2024 19:28
Demo/Sources/Metrics/DataVolumeChart.swift Outdated Show resolved Hide resolved
Sources/Monitoring/Types/MetricStartData.swift Outdated Show resolved Hide resolved
Tests/MonitoringTests/MetricHitExpectation.swift Outdated Show resolved Hide resolved
@waliid waliid self-requested a review August 11, 2024 09:49
@defagos defagos added this pull request to the merge queue Aug 11, 2024
Merged via the queue into main with commit 3258b33 Aug 11, 2024
6 checks passed
@defagos defagos deleted the 966-update-metric-tracker-to-most-recent-specifications branch August 11, 2024 09:56
@defagos
Copy link
Member Author

defagos commented Aug 11, 2024

Thank you very much for the review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Update metrics tracker to most recent specifications
2 participants