File: metrics_log_uploader.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 (63 lines) | stat: -rw-r--r-- 2,398 bytes parent folder | download
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
// Copyright 2014 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_LOG_UPLOADER_H_
#define COMPONENTS_METRICS_METRICS_LOG_UPLOADER_H_

#include <string>

#include "base/functional/callback.h"
#include "base/strings/string_piece.h"

namespace metrics {

class ReportingInfo;

// MetricsLogUploader is an abstract base class for uploading UMA logs on behalf
// of MetricsService.
class MetricsLogUploader {
 public:
  // Type for OnUploadComplete callbacks. These callbacks receive five
  // parameters:
  //   - a response code,
  //   - a net error code,
  //   - a boolean specifying if the connection was secure (over HTTPS),
  //   - a boolean specifying if the log should be discarded regardless of
  //     response/error code,
  //   - a string specifying the reason why the log was forcibly discarded (or
  //     empty string if not).
  using UploadCallback =
      base::RepeatingCallback<void(int, int, bool, bool, base::StringPiece)>;

  // Possible service types. This should correspond to a type from
  // DataUseUserData.
  // TODO(crbug.com/1445151) Investigate cleaning up this enum if it isn't
  // needed anymore.
  enum MetricServiceType {
    UMA,
    UKM,
    STRUCTURED_METRICS,
  };

  virtual ~MetricsLogUploader() = default;

  // Uploads a log with the specified |compressed_log_data|, a |log_hash| and
  // |log_signature| for data validation, and |reporting_info|. |log_hash| is
  // expected to be the hex-encoded SHA1 hash of the log data before
  // compression, and |log_signature| is expected to be a base64-encoded
  // HMAC-SHA256 signature of the log data before compression. When the server
  // receives an upload, it recomputes the hash and signature of the upload and
  // compares it to the ones included in the upload. If there is a mismatch, the
  // upload is flagged. If an Uploader implementation uploads to a server that
  // doesn't do this validation, then |log_hash| and |log_signature| can be
  // ignored.
  virtual void UploadLog(const std::string& compressed_log_data,
                         const std::string& log_hash,
                         const std::string& log_signature,
                         const ReportingInfo& reporting_info) = 0;
};

}  // namespace metrics

#endif  // COMPONENTS_METRICS_METRICS_LOG_UPLOADER_H_