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.

Sign up for GitHub

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

Jump to bottom

[telemetry] Add telemetry to SbPlayerWriteSamples #4097

Open
wants to merge 1 commit into
base: 25.lts.1+
Choose a base branch
from
Open

[telemetry] Add telemetry to SbPlayerWriteSamples #4097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions cobalt/media/base/metrics_provider.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,20 @@ void MediaMetricsProvider::EndTrackingAction(MediaAction action) {
tracked_actions_start_times_.erase(action);
}

void MediaMetricsProvider::EndTrackingAction(MediaAction action,
int number_of_samples) {
DCHECK(IsActionCurrentlyTracked(action));
base::AutoLock scoped_lock(mutex_);

auto duration = clock_->NowTicks() - tracked_actions_start_times_[action];
if (number_of_samples > 0) {
// Report latency UMA if it writes non-zero samples.
auto duration_per_sample = duration / number_of_samples;
ReportActionLatencyUMA(action, duration_per_sample);
}
tracked_actions_start_times_.erase(action);
}

bool MediaMetricsProvider::IsActionCurrentlyTracked(MediaAction action) {
base::AutoLock scoped_lock(mutex_);
return tracked_actions_start_times_.find(action) !=
Expand Down Expand Up @@ -151,6 +165,18 @@ void MediaMetricsProvider::ReportActionLatencyUMA(
UMA_HISTOGRAM_TIMES("Cobalt.Media.SbPlayer.Destroy.LatencyTiming",
action_duration);
break;
case MediaAction::SBPLAYER_WRITE_SAMPLES_AUDIO:
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Cobalt.Media.SbPlayer.WriteSamples.Audio.LatencyTiming",
action_duration, base::TimeDelta::FromMicroseconds(1),
base::TimeDelta::FromMilliseconds(100), 50);
break;
case MediaAction::SBPLAYER_WRITE_SAMPLES_VIDEO:
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Cobalt.Media.SbPlayer.WriteSamples.Video.LatencyTiming",
action_duration, base::TimeDelta::FromMicroseconds(1),
base::TimeDelta::FromMilliseconds(100), 50);
break;
case MediaAction::SBDRM_DESTROY:
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Cobalt.Media.SbDrm.Destroy.LatencyTiming", action_duration,
Expand Down
3 changes: 3 additions & 0 deletions cobalt/media/base/metrics_provider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ enum class MediaAction : uint8_t {
SBPLAYER_CREATE,
SBPLAYER_CREATE_URL_PLAYER,
SBPLAYER_DESTROY,
SBPLAYER_WRITE_SAMPLES_AUDIO,
SBPLAYER_WRITE_SAMPLES_VIDEO,
SBDRM_DESTROY,
SBDRM_GENERATE_SESSION_UPDATE_REQUEST,
SBDRM_UPDATE_SESSION,
Expand Down Expand Up @@ -87,6 +89,7 @@ class MediaMetricsProvider {
// Used to record the latency of an action in the WebMediaPlayer.
void StartTrackingAction(MediaAction action);
void EndTrackingAction(MediaAction action);
void EndTrackingAction(MediaAction action, int number_of_samples);
bool IsActionCurrentlyTracked(MediaAction action);

void Reset();
Expand Down
22 changes: 22 additions & 0 deletions cobalt/media/base/metrics_provider_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,28 @@ TEST_F(MediaMetricsProviderTest, SbPlayerDestroy) {
std::string(kUmaPrefix) + "SbPlayer.Destroy.LatencyTiming", 100, 1);
}

TEST_F(MediaMetricsProviderTest, SbPlayerWriteSamplesAudio) {
metrics_.StartTrackingAction(MediaAction::SBPLAYER_WRITE_SAMPLES_AUDIO);

clock_.Advance(base::TimeDelta::FromMicroseconds(570));
metrics_.EndTrackingAction(MediaAction::SBPLAYER_WRITE_SAMPLES_AUDIO);

histogram_tester_.ExpectUniqueSample(
std::string(kUmaPrefix) + "SbPlayer.WriteSamples.Audio.LatencyTiming",
570, 1);
}

TEST_F(MediaMetricsProviderTest, SbPlayerWriteSamplesVideoAudio) {
metrics_.StartTrackingAction(MediaAction::SBPLAYER_WRITE_SAMPLES_VIDEO);

clock_.Advance(base::TimeDelta::FromMicroseconds(570));
metrics_.EndTrackingAction(MediaAction::SBPLAYER_WRITE_SAMPLES_VIDEO);

histogram_tester_.ExpectUniqueSample(
std::string(kUmaPrefix) + "SbPlayer.WriteSamples.Video.LatencyTiming",
570, 1);
}

TEST_F(MediaMetricsProviderTest, SbDrmCloseSession) {
metrics_.StartTrackingAction(MediaAction::SBDRM_CLOSE_SESSION);

Expand Down
6 changes: 6 additions & 0 deletions cobalt/media/base/sbplayer_interface.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,19 @@ void DefaultSbPlayerInterface::WriteSamples(
SbPlayer player, SbMediaType sample_type,
const SbPlayerSampleInfo* sample_infos, int number_of_sample_infos) {
DCHECK(!IsEnhancedAudioExtensionEnabled());
auto media_action = (sample_type == kSbMediaTypeAudio)
? MediaAction::SBPLAYER_WRITE_SAMPLES_AUDIO
: MediaAction::SBPLAYER_WRITE_SAMPLES_VIDEO;
media_metrics_provider_.StartTrackingAction(media_action);
#if SB_API_VERSION >= 15
SbPlayerWriteSamples(player, sample_type, sample_infos,
number_of_sample_infos);
#else // SB_API_VERSION >= 15
SbPlayerWriteSample2(player, sample_type, sample_infos,
number_of_sample_infos);
#endif // SB_API_VERSION >= 15
media_metrics_provider_.EndTrackingAction(media_action,
number_of_sample_infos);
}

void DefaultSbPlayerInterface::WriteSamples(
Expand Down
18 changes: 18 additions & 0 deletions tools/metrics/histograms/metadata/cobalt/histograms.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,24 @@ Always run the pretty print utility on this file after editing:
<summary>Timing data for the destruction of SbPlayer.</summary>
</histogram>

<histogram name="Cobalt.Media.SbPlayer.WriteSamples.Audio.LatencyTiming"
units="microseconds" expires_after="never">
<!-- expires-never: Needed for long-term tracking of SbPlayer latencies. -->

<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>Timing data for writing single audio sample.</summary>
</histogram>

<histogram name="Cobalt.Media.SbPlayer.WriteSamples.Video.LatencyTiming"
units="microseconds" expires_after="never">
<!-- expires-never: Needed for long-term tracking of SbPlayer latencies. -->

<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>Timing data for writing single video sample.</summary>
</histogram>

<histogram name="Cobalt.Media.SDR.Matrix" enum="MatrixID" expires_after="never">
<!-- expires-never: Needed for baseline Media pipeline health metric. -->

Expand Down
Loading