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
|
// 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 <string_view>
#include "base/functional/callback.h"
#include "components/metrics/metrics_log.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, std::string_view)>;
// Possible service types. This is used during the upload process for
// determining which server to upload to and by metrics providers when adding
// data to logs.
enum MetricServiceType {
UMA,
UKM,
STRUCTURED_METRICS,
DWA,
};
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 LogMetadata& log_metadata,
const std::string& log_hash,
const std::string& log_signature,
const ReportingInfo& reporting_info) = 0;
};
} // namespace metrics
#endif // COMPONENTS_METRICS_METRICS_LOG_UPLOADER_H_
|
