File: metrics_util.h

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; 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 (66 lines) | stat: -rw-r--r-- 2,256 bytes parent folder | download | duplicates (7)
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
// 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.

#ifndef COMPONENTS_PAGE_IMAGE_SERVICE_METRICS_UTIL_H_
#define COMPONENTS_PAGE_IMAGE_SERVICE_METRICS_UTIL_H_

#include <string>

#include "base/metrics/histogram_functions.h"
#include "components/page_image_service/mojom/page_image_service.mojom.h"

namespace page_image_service {

constexpr char kBackendHistogramName[] = "PageImageService.Backend";
constexpr char kBackendOptimizationGuideResultHistogramName[] =
    "PageImageService.Backend.OptimizationGuide.Result";
constexpr char kBackendSuggestResultHistogramName[] =
    "PageImageService.Backend.Suggest.Result";
constexpr char kConsentStatusHistogramName[] = "PageImageService.ConsentStatus";

// Used in UMA. Must not be renumbered, and must be kept in sync with enums.xml.
enum class PageImageServiceBackend {
  kNoValidBackend = 0,
  kSuggest = 1,
  kOptimizationGuide = 2,
  kMaxValue = kOptimizationGuide,
};

// Used in UMA. Must not be renumbered, and must be kept in sync with enums.xml.
enum class PageImageServiceResult {
  kSuccess = 0,
  kResponseMissing = 1,
  kNoImage = 2,
  kResponseMalformed = 3,
  kMaxValue = kResponseMalformed,
};

// Used in UMA. Must not be renumbered, and must be kept in sync with enums.xml.
enum class PageImageServiceConsentStatus {
  kSuccess = 0,
  kFailure = 1,
  kTimedOut = 2,
  kMaxValue = kTimedOut,
};

// Returns a string for each `client_id`. Always returns a non-empty string.
// The returned string doesn't have a period prefixing it.
std::string ClientIdToString(mojom::ClientId client_id);

template <typename T>
void UmaHistogramEnumerationForClient(const std::string& name,
                                      T sample,
                                      mojom::ClientId client_id) {
  // Record it in the unsliced histogram.
  base::UmaHistogramEnumeration(name, sample);

  // Now record it for the sliced by client equivalent.
  std::string client_suffix = ClientIdToString(client_id);
  DCHECK(!client_suffix.empty());
  base::UmaHistogramEnumeration(name + "." + client_suffix, sample);
}

}  // namespace page_image_service

#endif  // COMPONENTS_PAGE_IMAGE_SERVICE_METRICS_UTIL_H_