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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// Copyright 2017 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_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_STATS_H_
#define COMPONENTS_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_STATS_H_
#include "base/files/file.h"
#include "components/download/internal/background_service/constants.h"
#include "components/download/internal/background_service/download_blockage_status.h"
#include "components/download/internal/background_service/driver_entry.h"
#include "components/download/public/background_service/clients.h"
#include "components/download/public/background_service/download_params.h"
#include "components/download/public/task/download_task_types.h"
namespace download {
struct StartupStatus;
namespace stats {
// Please follow the following rules for all enums:
// 1. Keep them in sync with the corresponding entry in enums.xml.
// 2. Treat them as append only.
// 3. Do not remove any enums. Only mark them as deprecated.
// Enum used to track download service start up result and failure reasons.
// Most of the fields should map to StartupStatus.
// Failure reasons are not mutually exclusive.
enum class StartUpResult {
// Download service successfully started.
SUCCESS = 0,
// Download service start up failed.
FAILURE = 1,
// Download driver is not ready.
FAILURE_REASON_DRIVER = 2,
// Database layer failed to initialized.
FAILURE_REASON_MODEL = 3,
// File monitor failed to start.
FAILURE_REASON_FILE_MONITOR = 4,
// The count of entries for the enum.
COUNT = 5,
};
// Enum used by UMA metrics to track which actions a Client is taking on the
// service.
enum class ServiceApiAction {
// Represents a call to DownloadService::StartDownload.
START_DOWNLOAD = 0,
// Represents a call to DownloadService::PauseDownload.
PAUSE_DOWNLOAD = 1,
// Represents a call to DownloadService::ResumeDownload.
RESUME_DOWNLOAD = 2,
// Represents a call to DownloadService::CancelDownload.
CANCEL_DOWNLOAD = 3,
// Represents a call to DownloadService::ChangeCriteria.
CHANGE_CRITERIA = 4,
// The count of entries for the enum.
COUNT = 5,
};
// Enum used by UMA metrics to log the status of scheduled tasks.
enum class ScheduledTaskStatus {
// Startup failed and the task was not run.
ABORTED_ON_FAILED_INIT = 0,
// OnStopScheduledTask() was received before the task could be fired.
CANCELLED_ON_STOP = 1,
// Callback was run successfully after completion of the task.
COMPLETED_NORMALLY = 2,
// The count of entries for the enum.
COUNT = 3,
};
// Enum used by UMA metrics to track various types of cleanup actions taken by
// the service.
enum class FileCleanupReason {
// The file was deleted by the service after timeout.
TIMEOUT = 0,
// The database entry for the file was found not associated with any
// registered client.
ORPHANED = 1,
// At startup, the file was found not being associated with any model entry or
// driver entry.
UNKNOWN = 2,
// We're trying to remove all files as part of a hard recovery attempt.
HARD_RECOVERY = 3,
// The count of entries for the enum.
COUNT = 4,
};
// Enum used by UMA metrics to log a type of download event that occurred in the
// Controller.
enum class DownloadEvent {
// The Controller started a download.
START = 0,
// The Controller resumed a download (we assume this is a light weight
// resumption that does not require a complete download restart).
RESUME = 1,
// The Controller is retrying a download (we assume this is a heavy weight
// resumption that requires a complete download restart).
RETRY = 2,
// The Controller suspended an active download due to priorities, device
// activity, or a request from the Client (see LogDownloadPauseReason).
SUSPEND = 3,
// The count of entries for the enum.
COUNT = 4,
};
// Logs the results of starting up the Controller. Will log each failure reason
// if |status| contains more than one initialization failure.
void LogControllerStartupStatus(bool in_recovery, const StartupStatus& status);
// Logs the service starting up result.
void LogStartUpResult(bool in_recovery, StartUpResult result);
// Logs an action taken on the service API.
void LogServiceApiAction(DownloadClient client, ServiceApiAction action);
// Logs the result of a StartDownload() attempt on the service.
void LogStartDownloadResult(DownloadClient client,
DownloadParams::StartResult result);
// Logs download completion event, and the file size.
void LogDownloadCompletion(DownloadClient client,
CompletionType type,
uint64_t file_size_bytes);
// Logs various pause reasons for download. The reasons are not mutually
// exclusive.
void LogDownloadPauseReason(const DownloadBlockageStatus& blockage_status,
bool on_upload_data_received);
// Log statistics about the status of a TaskFinishedCallback.
void LogScheduledTaskStatus(DownloadTaskType task_type,
ScheduledTaskStatus status);
// Logs download files directory creation error.
void LogsFileDirectoryCreationError(base::File::Error error);
// Logs statistics about the reasons of a file cleanup.
void LogFileCleanupStatus(FileCleanupReason reason,
int succeeded_cleanups,
int failed_cleanups,
int external_cleanups);
// Logs the file life time for successfully completed download.
void LogFileLifeTime(const base::TimeDelta& file_life_time);
// Logs an action the Controller takes on an active download.
void LogEntryEvent(DownloadEvent event);
// At the time of a retry, logs which retry attempt count this is.
void LogEntryRetryCount(uint32_t retry_count);
} // namespace stats
} // namespace download
#endif // COMPONENTS_DOWNLOAD_INTERNAL_BACKGROUND_SERVICE_STATS_H_
|
