Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package com.android.contacts.common.logging; |
| 17 | |
| 18 | import android.app.Activity; |
| 19 | |
Walter Jang | 13d4dbc | 2016-02-24 17:05:10 -0800 | [diff] [blame] | 20 | import com.android.contacts.common.logging.ScreenEvent.ScreenType; |
Walter Jang | e837ae3 | 2016-08-15 12:50:37 -0700 | [diff] [blame] | 21 | import com.android.contactsbind.ObjectFactory; |
Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * Logs analytics events. |
| 25 | */ |
| 26 | public abstract class Logger { |
| 27 | public static final String TAG = "Logger"; |
| 28 | |
Walter Jang | 13d4dbc | 2016-02-24 17:05:10 -0800 | [diff] [blame] | 29 | private static Logger getInstance() { |
Walter Jang | 40c7479 | 2016-02-05 17:02:53 -0800 | [diff] [blame] | 30 | return ObjectFactory.getLogger(); |
Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 31 | } |
| 32 | |
| 33 | /** |
| 34 | * Logs an event indicating that a screen was displayed. |
| 35 | * |
| 36 | * @param screenType integer identifier of the displayed screen |
| 37 | * @param activity Parent activity of the displayed screen. |
Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 38 | */ |
Walter Jang | 13d4dbc | 2016-02-24 17:05:10 -0800 | [diff] [blame] | 39 | public static void logScreenView(Activity activity, int screenType) { |
| 40 | logScreenView(activity, screenType, ScreenType.UNKNOWN); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * @param previousScreenType integer identifier of the displayed screen the user came from. |
| 45 | */ |
| 46 | public static void logScreenView(Activity activity, int screenType, int previousScreenType) { |
Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 47 | final Logger logger = getInstance(); |
| 48 | if (logger != null) { |
Walter Jang | 13d4dbc | 2016-02-24 17:05:10 -0800 | [diff] [blame] | 49 | logger.logScreenViewImpl(screenType, previousScreenType); |
Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 50 | } |
Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 51 | } |
| 52 | |
Walter Jang | 40c7479 | 2016-02-05 17:02:53 -0800 | [diff] [blame] | 53 | /** |
| 54 | * Logs the results of a user search for a particular contact. |
| 55 | */ |
| 56 | public static void logSearchEvent(SearchState searchState) { |
| 57 | final Logger logger = getInstance(); |
Wenyi Wang | c9ad9b1 | 2016-05-20 15:10:12 -0700 | [diff] [blame] | 58 | if (logger != null) { |
Walter Jang | 40c7479 | 2016-02-05 17:02:53 -0800 | [diff] [blame] | 59 | logger.logSearchEventImpl(searchState); |
| 60 | } |
| 61 | } |
| 62 | |
Wenyi Wang | c9ad9b1 | 2016-05-20 15:10:12 -0700 | [diff] [blame] | 63 | /** |
| 64 | * Logs how users view and use a contacts list. See {@link ListEvent} for definition of |
| 65 | * parameters. |
| 66 | */ |
| 67 | public static void logListEvent(int actionType, int listType, int count, int clickedIndex, |
| 68 | int numSelected) { |
| 69 | final ListEvent event = new ListEvent(); |
| 70 | event.actionType = actionType; |
| 71 | event.listType = listType; |
| 72 | event.count = count; |
| 73 | event.clickedIndex = clickedIndex; |
| 74 | event.numSelected = numSelected; |
| 75 | |
| 76 | final Logger logger = getInstance(); |
| 77 | if (logger != null) { |
| 78 | logger.logListEventImpl(event); |
| 79 | } |
| 80 | } |
| 81 | |
yaolu | 79525d0 | 2016-08-24 12:08:39 -0700 | [diff] [blame] | 82 | /** |
| 83 | * Logs an event on QuickContact. See {@link QuickContactEvent} for definition of parameters. |
| 84 | */ |
| 85 | public static void logQuickContactEvent(String referrer, int contactType, int cardType, |
| 86 | int actionType, String thirdPartyAction) { |
| 87 | final Logger logger = getInstance(); |
| 88 | if (logger != null) { |
| 89 | final QuickContactEvent event = new QuickContactEvent(); |
yaolu | 5d1ee91 | 2016-09-15 11:31:10 -0700 | [diff] [blame] | 90 | event.referrer = referrer == null ? "Unknown" : referrer; |
yaolu | 79525d0 | 2016-08-24 12:08:39 -0700 | [diff] [blame] | 91 | event.contactType = contactType; |
| 92 | event.cardType = cardType; |
| 93 | event.actionType = actionType; |
yaolu | 5d1ee91 | 2016-09-15 11:31:10 -0700 | [diff] [blame] | 94 | event.thirdPartyAction = thirdPartyAction == null ? "" : thirdPartyAction; |
yaolu | 79525d0 | 2016-08-24 12:08:39 -0700 | [diff] [blame] | 95 | logger.logQuickContactEventImpl(event); |
| 96 | } |
| 97 | } |
| 98 | |
yaolu | 341d104 | 2016-11-07 15:46:46 -0800 | [diff] [blame] | 99 | public static void logEditorEvent(int eventType, int numberRawContacts) { |
| 100 | final Logger logger = getInstance(); |
| 101 | if (logger != null) { |
| 102 | final EditorEvent event = new EditorEvent(); |
| 103 | event.eventType = eventType; |
| 104 | event.numberRawContacts = numberRawContacts; |
| 105 | logger.logEditorEventImpl(event); |
| 106 | } |
| 107 | } |
| 108 | |
Walter Jang | 13d4dbc | 2016-02-24 17:05:10 -0800 | [diff] [blame] | 109 | public abstract void logScreenViewImpl(int screenType, int previousScreenType); |
Walter Jang | 4a45918 | 2016-01-20 12:53:55 -0800 | [diff] [blame] | 110 | public abstract void logSearchEventImpl(SearchState searchState); |
Wenyi Wang | c9ad9b1 | 2016-05-20 15:10:12 -0700 | [diff] [blame] | 111 | public abstract void logListEventImpl(ListEvent event); |
yaolu | 79525d0 | 2016-08-24 12:08:39 -0700 | [diff] [blame] | 112 | public abstract void logQuickContactEventImpl(QuickContactEvent event); |
yaolu | 341d104 | 2016-11-07 15:46:46 -0800 | [diff] [blame] | 113 | public abstract void logEditorEventImpl(EditorEvent event); |
Walter Jang | 823b83c | 2016-01-20 18:37:40 -0800 | [diff] [blame] | 114 | } |