Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Register callback to statsD for AppSearchStorageInfo" into sc-dev

Browse Source
This commit is contained in:
Xiaoyu Jin
2021-07-10 01:20:18 +00:00
committed by Android (Google) Code Review
parent 5ad4a8093c 57bd208139
commit d4ce296d90
5 changed files with 227 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
apex/appsearch/service/Android.bp
View File

@@ -51,6 +51,7 @@ java_library {
],
libs: [
"framework-appsearch.impl",
"framework-statsd.stubs.module_lib",
"unsupportedappusage", // TODO(b/181887768) should be removed
],
defaults: ["framework-system-server-module-defaults"],

8
apex/appsearch/service/java/com/android/server/appsearch/AppSearchManagerService.java
View File

@@ -61,6 +61,7 @@ import com.android.server.LocalManagerRegistry;
import com.android.server.SystemService;
import com.android.server.appsearch.external.localstorage.stats.CallStats;
import com.android.server.appsearch.external.localstorage.visibilitystore.VisibilityStore;
import com.android.server.appsearch.stats.StatsCollector;
import com.android.server.appsearch.util.PackageUtil;
import com.android.server.usage.StorageStatsManagerLocal;
import com.android.server.usage.StorageStatsManagerLocal.StorageStatsAugmenter;
@@ -123,6 +124,13 @@ public class AppSearchManagerService extends SystemService {
.registerStorageStatsAugmenter(new AppSearchStorageStatsAugmenter(), TAG);
}
@Override
public void onBootPhase(/* @BootPhase */ int phase) {
if (phase == PHASE_BOOT_COMPLETED) {
StatsCollector.getInstance(mContext, EXECUTOR);
}
}
private void registerReceivers() {
mContext.registerReceiverForAllUsers(
new UserActionReceiver(),

14
apex/appsearch/service/java/com/android/server/appsearch/AppSearchUserInstanceManager.java
View File

@@ -32,6 +32,8 @@ import com.android.server.appsearch.stats.PlatformLogger;
import com.android.server.appsearch.visibilitystore.VisibilityStoreImpl;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
@@ -157,6 +159,18 @@ public final class AppSearchUserInstanceManager {
}
}
/**
* Returns the list of all {@link UserHandle}s.
*
* <p>It can return an empty list if there is no {@link AppSearchUserInstance} created yet.
*/
@NonNull
public List<UserHandle> getAllUserHandles() {
synchronized (mInstancesLocked) {
return new ArrayList<>(mInstancesLocked.keySet());
}
}
@NonNull
private AppSearchUserInstance createUserInstance(
@NonNull Context userContext,

2
apex/appsearch/service/java/com/android/server/appsearch/stats/PlatformLogger.java
View File

@@ -45,7 +45,7 @@ import java.util.Objects;
import java.util.Random;
/**
* Logger Implementation to log to statsd.
* Logger Implementation for pushed atoms.
*
* <p>This class is thread-safe.
*

203
apex/appsearch/service/java/com/android/server/appsearch/stats/StatsCollector.java Normal file
View File

@@ -0,0 +1,203 @@
/*
* Copyright (C) 2021 The Android Open Source Project
*
* 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.android.server.appsearch.stats;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.UserIdInt;
import android.app.StatsManager;
import android.content.Context;
import android.os.UserHandle;
import android.util.Log;
import android.util.StatsEvent;
import com.android.server.appsearch.AppSearchUserInstance;
import com.android.server.appsearch.AppSearchUserInstanceManager;
import com.google.android.icing.proto.DocumentStorageInfoProto;
import com.google.android.icing.proto.IndexStorageInfoProto;
import com.google.android.icing.proto.SchemaStoreStorageInfoProto;
import com.google.android.icing.proto.StorageInfoProto;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.Executor;
/**
* Implements statsd pullers for AppSearch.
*
* <p>This class registers pullers to statsd, which will be called once a day to obtain AppSearch
* statistics that cannot be sent to statsd in real time by {@link PlatformLogger}.
*
* @hide
*/
public final class StatsCollector implements StatsManager.StatsPullAtomCallback {
private static final String TAG = "AppSearchStatsCollector";
private static volatile StatsCollector sStatsCollector;
private final StatsManager mStatsManager;
/**
* Gets an instance of {@link StatsCollector} to be used.
*
* <p>If no instance has been initialized yet, a new one will be created. Otherwise, the
* existing instance will be returned.
*/
@NonNull
public static StatsCollector getInstance(@NonNull Context context,
@NonNull Executor executor) {
Objects.requireNonNull(context);
Objects.requireNonNull(executor);
if (sStatsCollector == null) {
synchronized (StatsCollector.class) {
if (sStatsCollector == null) {
sStatsCollector = new StatsCollector(context, executor);
}
}
}
return sStatsCollector;
}
private StatsCollector(@NonNull Context context, @NonNull Executor executor) {
mStatsManager = context.getSystemService(StatsManager.class);
if (mStatsManager != null) {
registerAtom(AppSearchStatsLog.APP_SEARCH_STORAGE_INFO, /*policy=*/ null, executor);
Log.d(TAG, "atoms registered");
} else {
Log.e(TAG, "could not get StatsManager, atoms not registered");
}
}
/**
* {@inheritDoc}
*
* @return {@link StatsManager#PULL_SUCCESS} with list of atoms (potentially empty) if pull
* succeeded, {@link StatsManager#PULL_SKIP} if pull was too frequent or atom ID is
* unexpected.
*/
@Override
public int onPullAtom(int atomTag, @NonNull List<StatsEvent> data) {
Objects.requireNonNull(data);
switch (atomTag) {
case AppSearchStatsLog.APP_SEARCH_STORAGE_INFO:
return pullAppSearchStorageInfo(data);
default:
Log.e(TAG, "unexpected atom ID " + atomTag);
return StatsManager.PULL_SKIP;
}
}
private static int pullAppSearchStorageInfo(@NonNull List<StatsEvent> data) {
AppSearchUserInstanceManager userInstanceManager =
AppSearchUserInstanceManager.getInstance();
List<UserHandle> userHandles = userInstanceManager.getAllUserHandles();
for (int i = 0; i < userHandles.size(); i++) {
UserHandle userHandle = userHandles.get(i);
try {
AppSearchUserInstance userInstance = userInstanceManager.getUserInstance(
userHandle);
StorageInfoProto storageInfoProto =
userInstance.getAppSearchImpl().getRawStorageInfoProto();
data.add(buildStatsEvent(userHandle.getIdentifier(), storageInfoProto));
} catch (Throwable t) {
Log.e(TAG,
"Failed to pull the storage info for user " + userHandle.toString(),
t);
}
}
// Skip the report if there is no data.
if (data.isEmpty()) {
return StatsManager.PULL_SKIP;
}
return StatsManager.PULL_SUCCESS;
}
/**
* Registers and configures the callback for the pulled atom.
*
* @param atomId The id of the atom
* @param policy Optional metadata specifying the timeout, cool down time etc. statsD would
* use default values if it is null
* @param executor The executor in which to run the callback
*/
private void registerAtom(int atomId, @Nullable StatsManager.PullAtomMetadata policy,
@NonNull Executor executor) {
mStatsManager.setPullAtomCallback(atomId, policy, executor, /*callback=*/this);
}
private static StatsEvent buildStatsEvent(@UserIdInt int userId,
@NonNull StorageInfoProto storageInfoProto) {
return AppSearchStatsLog.buildStatsEvent(
AppSearchStatsLog.APP_SEARCH_STORAGE_INFO,
userId,
storageInfoProto.getTotalStorageSize(),
getDocumentStorageInfoBytes(storageInfoProto.getDocumentStorageInfo()),
getSchemaStoreStorageInfoBytes(storageInfoProto.getSchemaStoreStorageInfo()),
getIndexStorageInfoBytes(storageInfoProto.getIndexStorageInfo()));
}
private static byte[] getDocumentStorageInfoBytes(
@NonNull DocumentStorageInfoProto proto) {
// Make sure we only log the fields defined in the atom in case new fields are added in
// IcingLib
DocumentStorageInfoProto.Builder builder = DocumentStorageInfoProto.newBuilder();
builder.setNumAliveDocuments(proto.getNumAliveDocuments())
.setNumDeletedDocuments(proto.getNumDeletedDocuments())
.setNumExpiredDocuments(proto.getNumExpiredDocuments())
.setDocumentStoreSize(proto.getDocumentStoreSize())
.setDocumentLogSize(proto.getDocumentLogSize())
.setKeyMapperSize(proto.getKeyMapperSize())
.setDocumentIdMapperSize(proto.getDocumentIdMapperSize())
.setScoreCacheSize(proto.getScoreCacheSize())
.setFilterCacheSize(proto.getFilterCacheSize())
.setCorpusMapperSize(proto.getCorpusMapperSize())
.setCorpusScoreCacheSize(proto.getCorpusScoreCacheSize())
.setNamespaceIdMapperSize(proto.getNamespaceIdMapperSize())
.setNumNamespaces(proto.getNumNamespaces());
return builder.build().toByteArray();
}
private static byte[] getSchemaStoreStorageInfoBytes(
@NonNull SchemaStoreStorageInfoProto proto) {
// Make sure we only log the fields defined in the atom in case new fields are added in
// IcingLib
SchemaStoreStorageInfoProto.Builder builder = SchemaStoreStorageInfoProto.newBuilder();
builder.setSchemaStoreSize(proto.getSchemaStoreSize())
.setNumSchemaTypes(proto.getNumSchemaTypes())
.setNumTotalSections(proto.getNumTotalSections())
.setNumSchemaTypesSectionsExhausted(proto.getNumSchemaTypesSectionsExhausted());
return builder.build().toByteArray();
}
private static byte[] getIndexStorageInfoBytes(
@NonNull IndexStorageInfoProto proto) {
// Make sure we only log the fields defined in the atom in case new fields are added in
// IcingLib
IndexStorageInfoProto.Builder builder = IndexStorageInfoProto.newBuilder();
builder.setIndexSize(proto.getIndexSize())
.setLiteIndexLexiconSize(proto.getLiteIndexLexiconSize())
.setLiteIndexHitBufferSize(proto.getLiteIndexHitBufferSize())
.setMainIndexLexiconSize(proto.getMainIndexLexiconSize())
.setMainIndexStorageSize(proto.getMainIndexStorageSize())
.setMainIndexBlockSize(proto.getMainIndexBlockSize())
.setNumBlocks(proto.getNumBlocks())
.setMinFreeFraction(proto.getMinFreeFraction());
return builder.build().toByteArray();
}
}