1 /* 2 * Copyright (C) 2009 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 17 package com.android.quicksearchbox; 18 19 import android.content.Context; 20 import android.util.EventLog; 21 22 import java.util.Collection; 23 import java.util.List; 24 import java.util.Random; 25 26 /** 27 * Logs events to {@link EventLog}. 28 */ 29 public class EventLogLogger implements Logger { 30 31 private static final char LIST_SEPARATOR = '|'; 32 33 private final Context mContext; 34 35 private final Config mConfig; 36 37 private final String mPackageName; 38 39 private final Random mRandom; 40 EventLogLogger(Context context, Config config)41 public EventLogLogger(Context context, Config config) { 42 mContext = context; 43 mConfig = config; 44 mPackageName = mContext.getPackageName(); 45 mRandom = new Random(); 46 } 47 getContext()48 protected Context getContext() { 49 return mContext; 50 } 51 getVersionCode()52 protected int getVersionCode() { 53 return QsbApplication.get(getContext()).getVersionCode(); 54 } 55 getConfig()56 protected Config getConfig() { 57 return mConfig; 58 } 59 logStart(int onCreateLatency, int latency, String intentSource, Corpus corpus, List<Corpus> orderedCorpora)60 public void logStart(int onCreateLatency, int latency, String intentSource, Corpus corpus, 61 List<Corpus> orderedCorpora) { 62 // TODO: Add more info to startMethod 63 String startMethod = intentSource; 64 String currentCorpus = getCorpusLogName(corpus); 65 String enabledCorpora = getCorpusLogNames(orderedCorpora); 66 EventLogTags.writeQsbStart(mPackageName, getVersionCode(), startMethod, 67 latency, currentCorpus, enabledCorpora, onCreateLatency); 68 } 69 logSuggestionClick(long id, SuggestionCursor suggestionCursor, Collection<Corpus> queriedCorpora, int clickType)70 public void logSuggestionClick(long id, SuggestionCursor suggestionCursor, 71 Collection<Corpus> queriedCorpora, int clickType) { 72 String suggestions = getSuggestions(suggestionCursor); 73 String corpora = getCorpusLogNames(queriedCorpora); 74 int numChars = suggestionCursor.getUserQuery().length(); 75 EventLogTags.writeQsbClick(id, suggestions, corpora, numChars, 76 clickType); 77 } 78 logSearch(Corpus corpus, int startMethod, int numChars)79 public void logSearch(Corpus corpus, int startMethod, int numChars) { 80 String corpusName = getCorpusLogName(corpus); 81 EventLogTags.writeQsbSearch(corpusName, startMethod, numChars); 82 } 83 logVoiceSearch(Corpus corpus)84 public void logVoiceSearch(Corpus corpus) { 85 String corpusName = getCorpusLogName(corpus); 86 EventLogTags.writeQsbVoiceSearch(corpusName); 87 } 88 logExit(SuggestionCursor suggestionCursor, int numChars)89 public void logExit(SuggestionCursor suggestionCursor, int numChars) { 90 String suggestions = getSuggestions(suggestionCursor); 91 EventLogTags.writeQsbExit(suggestions, numChars); 92 } 93 logLatency(CorpusResult result)94 public void logLatency(CorpusResult result) { 95 if (!shouldLogLatency()) return; 96 String corpusName = getCorpusLogName(result.getCorpus()); 97 int latency = result.getLatency(); 98 int numChars = result.getUserQuery().length(); 99 EventLogTags.writeQsbLatency(corpusName, latency, numChars); 100 } 101 shouldLogLatency()102 private boolean shouldLogLatency() { 103 int freq = mConfig.getLatencyLogFrequency(); 104 return freq > mRandom.nextInt(1000); 105 } 106 getCorpusLogName(Corpus corpus)107 private String getCorpusLogName(Corpus corpus) { 108 if (corpus == null) return null; 109 return corpus.getName(); 110 } 111 getSuggestions(SuggestionCursor cursor)112 private String getSuggestions(SuggestionCursor cursor) { 113 StringBuilder sb = new StringBuilder(); 114 final int count = cursor == null ? 0 : cursor.getCount(); 115 for (int i = 0; i < count; i++) { 116 if (i > 0) sb.append(LIST_SEPARATOR); 117 cursor.moveTo(i); 118 String source = cursor.getSuggestionSource().getName(); 119 String type = cursor.getSuggestionLogType(); 120 if (type == null) type = ""; 121 String shortcut = cursor.isSuggestionShortcut() ? "shortcut" : ""; 122 sb.append(source).append(':').append(type).append(':').append(shortcut); 123 } 124 return sb.toString(); 125 } 126 getCorpusLogNames(Collection<Corpus> corpora)127 private String getCorpusLogNames(Collection<Corpus> corpora) { 128 if (corpora == null) return ""; 129 StringBuilder sb = new StringBuilder(); 130 for (Corpus corpus : corpora) { 131 if (sb.length() > 0) sb.append(LIST_SEPARATOR); 132 sb.append(getCorpusLogName(corpus)); 133 } 134 return sb.toString(); 135 } 136 137 } 138