File: metrics_data_validation.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (71 lines) | stat: -rw-r--r-- 3,365 bytes parent folder | download | duplicates (5)
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
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_METRICS_METRICS_DATA_VALIDATION_H_
#define COMPONENTS_METRICS_METRICS_DATA_VALIDATION_H_

#include "base/feature_list.h"
#include "base/metrics/field_trial_params.h"
#include "base/time/time.h"

// Features and functions in this file are necessary to set up artificial A / B
// experiments that help us better assess the accuracy and power of our field
// trial data. All code in this file should not have any impact on client's
// experience.
namespace metrics {

// Only used for testing.
namespace internal {
BASE_DECLARE_FEATURE(kPseudoMetricsEffectFeature);
}  // namespace internal

// Used to assess the reliability of field trial data by sending artificial
// non-uniform data drawn from a log normal distribution.
BASE_DECLARE_FEATURE(kNonUniformityValidationFeature);

// The parameters for the log normal distribution. They refer to the default
// mean, the delta that would be applied to the default mean (the actual mean
// equals mean + log(1 + delta)) and the standard deviation of the distribution
// that's being generated. These parameters are carefully calculated so that
// ~0.01% of data drawn from the distribution would fall in the underflow bucket
// and ~0.01% of data in the overflow bucket. And they also leave us enough
// wiggle room to shift mean using delta in experiments without losing precision
// badly because of data in the overflow bucket.
//
// The way we get these numbers are based on the following calculation:
// u := the lower threshold for the overflow bucket (in this case, 10000).
// l := the upper threshold for the smallest bucket (in this case, 1).
// p := the probability that an observation will fall in the highest bucket (in
//   this case, 0.01%) and also the probability that an observation will fall in
//   the lowest bucket.
//
// mean = (log(u) + log(l)) / 2
// sd = (log(u) - log(l)) / (2 * qnorm(1-p))
//
// At this point, experiments should only control the delta but not mean and
// stdDev. Putting them in feature params so that we can configure them from the
// server side if we want.
extern const base::FeatureParam<double> kLogNormalMean;
extern const base::FeatureParam<double> kLogNormalDelta;
extern const base::FeatureParam<double> kLogNormalStdDev;

// In order to assess if we're able to accurately detect a statistically
// significant difference in our field trial data, we set up pseudo metrics for
// some of our key metrics. Values of these pseudo metrics are the linear
// transformation (ax + b) of real values (x). The multiplicative factor (a) and
// additive factor (b) are controlled by field trial experiments.
//
// Returns the sample value for a pseudo metric given the |sample| from the real
// metric and the assigned field trial group. The input type is double because
// we don't want to lose precision before applying transformation.
double GetPseudoMetricsSample(double sample);

// Returns the TimeDelta for a pseudo metric given the |sample| from the real
// metric and the assigned field trial group. The unit of the additive factor
// (b) is milliseconds.
base::TimeDelta GetPseudoMetricsSample(base::TimeDelta sample);

}  // namespace metrics

#endif  // COMPONENTS_METRICS_METRICS_DATA_VALIDATION_H_