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
|
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.android.libraries.mobiledatadownload.internal.logging;
import com.google.auto.value.AutoValue;
import com.google.common.util.concurrent.AsyncCallable;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.mobiledatadownload.LogEnumsProto.MddClientEvent;
import com.google.mobiledatadownload.LogEnumsProto.MddDownloadResult;
import com.google.mobiledatadownload.LogProto.DataDownloadFileGroupStats;
import com.google.mobiledatadownload.LogProto.MddFileGroupStatus;
import com.google.mobiledatadownload.LogProto.MddStorageStats;
import java.util.List;
/** Interface for remote logging. */
public interface EventLogger {
/** Log an mdd event */
void logEventSampled(MddClientEvent.Code eventCode);
/** Log an mdd event with an associated file group. */
void logEventSampled(
MddClientEvent.Code eventCode,
String fileGroupName,
int fileGroupVersionNumber,
long buildId,
String variantId);
/**
* Log an mdd event. This not sampled. Caller should make sure this method is called after
* sampling at the passed in value of sample interval.
*/
void logEventAfterSample(MddClientEvent.Code eventCode, int sampleInterval);
/**
* Log mdd file group stats. The buildFileGroupStats callable is only called if the event is going
* to be logged.
*
* @param buildFileGroupStats callable which builds a List of FileGroupStatusWithDetails. Each
* file group status will be logged individually.
* @return a future that completes when the logging work is done. The future will complete with a
* failure if the callable fails or if there is an error when logging.
*/
ListenableFuture<Void> logMddFileGroupStats(
AsyncCallable<List<FileGroupStatusWithDetails>> buildFileGroupStats);
/** Simple wrapper class for MDD file group stats and details. */
@AutoValue
abstract class FileGroupStatusWithDetails {
abstract MddFileGroupStatus fileGroupStatus();
abstract DataDownloadFileGroupStats fileGroupDetails();
static FileGroupStatusWithDetails create(
MddFileGroupStatus fileGroupStatus, DataDownloadFileGroupStats fileGroupDetails) {
return new AutoValue_EventLogger_FileGroupStatusWithDetails(
fileGroupStatus, fileGroupDetails);
}
}
/** Log mdd api call stats. */
void logMddApiCallStats(DataDownloadFileGroupStats fileGroupDetails, Void apiCallStats);
void logMddLibApiResultLog(Void mddLibApiResultLog);
/**
* Log mdd storage stats. The buildMddStorageStats callable is only called if the event is going
* to be logged.
*
* @param buildMddStorageStats callable which builds the MddStorageStats to log.
* @return a future that completes when the logging work is done. The future will complete with a
* failure if the callable fails or if there is an error when logging.
*/
ListenableFuture<Void> logMddStorageStats(AsyncCallable<MddStorageStats> buildMddStorageStats);
/**
* Log mdd network stats. The buildMddNetworkStats callable is only called if the event is going
* to be logged.
*
* @param buildMddNetworkStats callable which builds the Void to log.
* @return a future that completes when the logging work is done. The future will complete with a
* failure if the callable fails or if there is an error when logging.
*/
ListenableFuture<Void> logMddNetworkStats(AsyncCallable<Void> buildMddNetworkStats);
/** Log the number of unaccounted files/metadata deleted during maintenance */
void logMddDataDownloadFileExpirationEvent(int eventCode, int count);
/** Log the network savings of MDD download features */
void logMddNetworkSavings(
DataDownloadFileGroupStats fileGroupDetails,
int code,
long fullFileSize,
long downloadedFileSize,
String fileId,
int deltaIndex);
/** Log mdd download result events. */
void logMddDownloadResult(
MddDownloadResult.Code code, DataDownloadFileGroupStats fileGroupDetails);
/** Log stats of mdd {@code getFileGroup} and {@code getFileGroupByFilter} calls. */
void logMddQueryStats(DataDownloadFileGroupStats fileGroupDetails);
/** Log mdd stats on android sharing events. */
void logMddAndroidSharingLog(Void event);
/** Log mdd download latency. */
void logMddDownloadLatency(DataDownloadFileGroupStats fileGroupStats, Void downloadLatency);
/** Log mdd usage event. */
void logMddUsageEvent(DataDownloadFileGroupStats fileGroupDetails, Void usageEventLog);
/** Log new config received event. */
void logNewConfigReceived(
DataDownloadFileGroupStats fileGroupDetails, Void newConfigReceivedInfo);
}
|
