File: throughput_metric_logger.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (114 lines) | stat: -rw-r--r-- 4,601 bytes parent folder | download | duplicates (6)
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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/nearby_sharing/metrics/throughput_metric_logger.h"

#include <utility>

#include "chrome/browser/nearby_sharing/metrics/metric_common.h"
#include "chromeos/ash/services/nearby/public/mojom/nearby_connections_types.mojom-shared.h"
#include "components/metrics/structured/structured_events.h"
#include "components/metrics/structured/structured_metrics_client.h"

namespace nearby::share::metrics {

ThroughputMetricLogger::ThroughputMetricLogger() = default;
ThroughputMetricLogger::~ThroughputMetricLogger() = default;

void ThroughputMetricLogger::OnTransferStarted(const ShareTarget& share_target,
                                               long total_bytes) {
  // Store the file size.
  transfer_sizes_[share_target.id] = total_bytes;

  // An upgrade may have occurred before the transfer starts, so only set the
  // default medium if it has not already been set.
  if (!last_medium_.contains(share_target.id)) {
    last_medium_[share_target.id] = connections::mojom::Medium::kBluetooth;
  }
}

// TODO(b/266739400): Test this once there is Structured Metrics unittesting
// infrastructure available.
void ThroughputMetricLogger::OnTransferUpdated(const ShareTarget& share_target,
                                               float percentage_complete) {
  base::TimeTicks current_update = base::TimeTicks::Now();
  base::TimeTicks previous_update = last_update_[share_target.id];
  float previous_percentage = last_percentage_[share_target.id];

  // Compute the deltas.
  float percentage_delta = percentage_complete - previous_percentage;
  base::TimeDelta update_delta = current_update - previous_update;

  // To prevent spamming of metrics, batch updates to a minimum of 1%.
  if (percentage_delta < 1.0) {
    return;
  }

  // Update the stored state for this share target.
  last_update_[share_target.id] = current_update;
  last_percentage_[share_target.id] = percentage_complete;

  // Do not emit events for recently upgraded share targets to deal with partial
  // updates across the medium upgrade.
  if (recently_upgraded_.contains(share_target.id)) {
    recently_upgraded_.erase(share_target.id);
    return;
  }

  // Do not emit a metric for the first or last update to prevent setup and
  // teardown noise.
  if (previous_percentage <= 0 || percentage_complete >= 100) {
    return;
  }

  // We must have either started the transfer or triggered a bandwidth upgrade.
  CHECK(last_medium_.contains(share_target.id));
  connections::mojom::Medium medium = last_medium_[share_target.id];

  // We must have started a transfer.
  CHECK(transfer_sizes_.contains(share_target.id));
  long transfer_size = transfer_sizes_[share_target.id];

  Platform platform = GetPlatform(share_target);
  DeviceRelationship relationship = GetDeviceRelationship(share_target);
  // Convert percentages to bytes. There might be some loss of accuracy due
  // to the float conversion, but it should be within a few bytes of the actual
  // number.
  long transferred_bytes = (percentage_complete / 100) * transfer_size;
  long update_bytes = (percentage_delta / 100) * transfer_size;

  ::metrics::structured::StructuredMetricsClient::Record(
      std::move(::metrics::structured::events::v2::nearby_share::Throughput()
                    .SetIsReceiving(share_target.is_incoming)
                    .SetPlatform(static_cast<int>(platform))
                    .SetDeviceRelationship(static_cast<int>(relationship))
                    .SetMedium(static_cast<int>(medium))
                    .SetTotalTransferBytes(transfer_size)
                    .SetTransferredBytes(transferred_bytes)
                    .SetUpdateBytes(update_bytes)
                    .SetUpdateMillis(update_delta.InMilliseconds())));
}

void ThroughputMetricLogger::OnTransferCompleted(
    const ShareTarget& share_target,
    TransferMetadata::Status status) {
  // Reset all share target state.
  transfer_sizes_.erase(share_target.id);
  last_update_.erase(share_target.id);
  last_percentage_.erase(share_target.id);
  last_medium_.erase(share_target.id);
  recently_upgraded_.erase(share_target.id);
}

void ThroughputMetricLogger::OnBandwidthUpgrade(
    const ShareTarget& share_target,
    connections::mojom::Medium medium) {
  // Update the medium.
  last_medium_[share_target.id] = medium;

  // Mark the share target as recently upgraded.
  recently_upgraded_.insert(share_target.id);
}

}  // namespace nearby::share::metrics