Implement custom metric collector for AdServices
Sample output with cold-start and hot-start latency data:https://paste.googleplex.com/6021916566487040
Test: tested locally useing following command
adb shell am instrument -w -e class android.platform.test.scenario.adservices.TopicsCrystalBallTest -e listener android.device.collectors.TopicsLatencyCollector -e skip_test_failure_metrics true android.platform.test.scenario/androidx.test.runner.AndroidJUnitRunner
To execute unit test: atest CollectorsHelperAospTest:com.android.helpers.TopicsLatencyHelperTest
Bug:b/229641201
change-Id: Idd5014d2c050dc52c6ffb7320b929dfb6879561c
diff --git a/libraries/collectors-helper/adservices/Android.bp b/libraries/collectors-helper/adservices/Android.bp
index 3525327..9abb920 100644
--- a/libraries/collectors-helper/adservices/Android.bp
+++ b/libraries/collectors-helper/adservices/Android.bp
@@ -24,8 +24,10 @@
srcs: [
"src/**/*.java",
],
+
static_libs: [
"androidx.test.runner",
+ "androidx.test.uiautomator",
"collector-helper-utilities",
"guava",
],
diff --git a/libraries/collectors-helper/adservices/src/com/android/helpers/TopicsLatencyHelper.java b/libraries/collectors-helper/adservices/src/com/android/helpers/TopicsLatencyHelper.java
new file mode 100644
index 0000000..6a550e4
--- /dev/null
+++ b/libraries/collectors-helper/adservices/src/com/android/helpers/TopicsLatencyHelper.java
@@ -0,0 +1,137 @@
+/*
+ * Copyright (C) 2022 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.helpers;
+
+import android.util.Log;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.time.Clock;
+import java.time.Instant;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Map;
+import java.util.HashMap;
+import java.util.function.Supplier;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.time.format.DateTimeFormatter;
+import java.time.ZoneId;
+
+import com.google.common.annotations.VisibleForTesting;
+
+/**
+ * TopicsLatencyHelper consist of helper methods to collect Topics API call latencies
+ *
+ * <p>TODO(b/234452723): Change metric collector to use either statsd or perfetto instead of logcat
+ */
+public class TopicsLatencyHelper implements ICollectorHelper<Long> {
+
+ private static final String TAG = "TopicsLatencyHelper";
+
+ private static final String TOPICS_HOT_START_LATENCY_METRIC = "TOPICS_HOT_START_LATENCY_METRIC";
+ private static final String TOPICS_COLD_START_LATENCY_METRIC =
+ "TOPICS_COLD_START_LATENCY_METRIC";
+
+ private static final DateTimeFormatter LOG_TIME_FORMATTER =
+ DateTimeFormatter.ofPattern("MM-dd HH:mm:ss.SSS").withZone(ZoneId.systemDefault());
+
+ private static final Pattern sLatencyMetricPattern =
+ Pattern.compile("TopicsCrystalBallTest: \\((.*): (\\d+)\\)");
+
+ private Instant mInstant;
+ private final Clock mClock;
+ private final Supplier<MetricsEventStreamReader> mMetricsEventStreamReaderSupplier;
+
+ public TopicsLatencyHelper() {
+ mClock = Clock.systemUTC();
+ mMetricsEventStreamReaderSupplier = () -> new MetricsEventStreamReader();
+ }
+
+ @VisibleForTesting
+ public TopicsLatencyHelper(
+ Supplier<MetricsEventStreamReader> metricsEventStreamSupplier, Clock clock) {
+ this.mMetricsEventStreamReaderSupplier = metricsEventStreamSupplier;
+ mClock = clock;
+ }
+
+ @Override
+ public boolean startCollecting() {
+ mInstant = mClock.instant();
+ return true;
+ }
+
+ @Override
+ public Map<String, Long> getMetrics() {
+ try {
+ return processOutput(
+ mMetricsEventStreamReaderSupplier.get().getMetricsEvents(mInstant));
+ } catch (Exception e) {
+ Log.e(TAG, "Failed to collect TopicsManager metrics.", e);
+ }
+
+ return Collections.emptyMap();
+ }
+
+ private Map<String, Long> processOutput(InputStream inputStream) throws IOException {
+ BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream));
+
+ String line = "";
+ Map<String, Long> output = new HashMap<String, Long>();
+ while ((line = bufferedReader.readLine()) != null) {
+ Matcher matcher = sLatencyMetricPattern.matcher(line);
+ while (matcher.find()) {
+ /**
+ * The lines from Logcat will look like: 06-13 18:09:24.058 20765 20781 D
+ * TopicsCrystalBallTest: (TOPICS_HOT_START_LATENCY_METRIC: 14)
+ */
+ String metric = matcher.group(1);
+ long latency = Long.parseLong(matcher.group(2));
+ if (TOPICS_HOT_START_LATENCY_METRIC.equals(metric)) {
+ output.put(TOPICS_HOT_START_LATENCY_METRIC, latency);
+ } else if (TOPICS_COLD_START_LATENCY_METRIC.equals(metric)) {
+ output.put(TOPICS_COLD_START_LATENCY_METRIC, latency);
+ }
+ }
+ }
+
+ return output;
+ }
+
+ @Override
+ public boolean stopCollecting() {
+ return true;
+ }
+
+ @VisibleForTesting
+ public static class MetricsEventStreamReader {
+ /** Return TopicsCrystalBallTest logs that will be used to build the test metrics. */
+ public InputStream getMetricsEvents(Instant startTime) throws IOException {
+ ProcessBuilder pb =
+ new ProcessBuilder(
+ Arrays.asList(
+ "logcat",
+ "-s",
+ "TopicsCrystalBallTest:D",
+ "-t",
+ LOG_TIME_FORMATTER.format(startTime)));
+ return pb.start().getInputStream();
+ }
+ }
+}
diff --git a/libraries/collectors-helper/adservices/test/Android.bp b/libraries/collectors-helper/adservices/test/Android.bp
index cc0e0e3..e6d04ea 100644
--- a/libraries/collectors-helper/adservices/test/Android.bp
+++ b/libraries/collectors-helper/adservices/test/Android.bp
@@ -23,12 +23,15 @@
srcs: ["src/**/*.java"],
static_libs: [
- "adservices-collector-helper",
"androidx.test.runner",
- "app-collector-helper",
"junit",
"mockito-target",
+ "adservices-collector-helper",
+ "app-collector-helper",
"truth-prebuilt",
+ "androidx.test.ext.junit",
+ "androidx.test.uiautomator",
+ "mockito-target-minus-junit4",
],
sdk_version: "current",
diff --git a/libraries/collectors-helper/adservices/test/src/com/android/helpers/TopicsLatencyHelperTest.java b/libraries/collectors-helper/adservices/test/src/com/android/helpers/TopicsLatencyHelperTest.java
new file mode 100644
index 0000000..178ed75
--- /dev/null
+++ b/libraries/collectors-helper/adservices/test/src/com/android/helpers/TopicsLatencyHelperTest.java
@@ -0,0 +1,96 @@
+/*
+ * Copyright (C) 2022 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.helpers;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.ArgumentMatchers.any;
+
+import androidx.test.runner.AndroidJUnit4;
+
+import static com.android.helpers.TopicsLatencyHelper.MetricsEventStreamReader;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+import java.time.Clock;
+import java.util.Map;
+import java.util.function.Supplier;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+/**
+ * Android Unit tests for {@link TopicsLatencyHelper}.
+ *
+ * <p>To run: atest CollectorsHelperAospTest:com.android.helpers.tests.TopicsLatencyHelperTest
+ */
+@RunWith(AndroidJUnit4.class)
+public class TopicsLatencyHelperTest {
+ private static final String TAG = TopicsLatencyHelper.class.getSimpleName();
+ private static final String TOPICS_HOT_START_LATENCY_METRIC = "TOPICS_HOT_START_LATENCY_METRIC";
+ private static final String TOPICS_COLD_START_LATENCY_METRIC =
+ "TOPICS_COLD_START_LATENCY_METRIC";
+
+ private static final String SAMPLE_TOPICS_HOT_START_LATENCY_OUTPUT =
+ "06-13 18:09:24.058 20765 20781 D\n"
+ + " TopicsCrystalBallTest: (TOPICS_HOT_START_LATENCY_METRIC: 14)";
+ private static final String SAMPLE_TOPICS_COLD_START_LATENCY_OUTPUT =
+ "06-13 18:09:24.058 20765 20781 D\n"
+ + " TopicsCrystalBallTest: (TOPICS_COLD_START_LATENCY_METRIC: 200)";
+
+ private TopicsLatencyHelper mTopicsLatencyHelper;
+
+ private @Mock MetricsEventStreamReader mMetricsEventStreamReader;
+ private @Mock Supplier<MetricsEventStreamReader> mMetricsEventStreamReaderSupplier;
+
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+ mTopicsLatencyHelper =
+ new TopicsLatencyHelper(mMetricsEventStreamReaderSupplier, Clock.systemUTC());
+ when(mMetricsEventStreamReaderSupplier.get()).thenReturn(mMetricsEventStreamReader);
+ }
+
+ /** Test getting metrics for single package. */
+ @Test
+ public void testGetMetrics() throws Exception {
+ String outputString =
+ SAMPLE_TOPICS_HOT_START_LATENCY_OUTPUT
+ + "\n"
+ + SAMPLE_TOPICS_COLD_START_LATENCY_OUTPUT;
+ InputStream targetStream = new ByteArrayInputStream(outputString.getBytes());
+ doReturn(targetStream).when(mMetricsEventStreamReader).getMetricsEvents(any());
+ Map<String, Long> topicsLatencyMetrics = mTopicsLatencyHelper.getMetrics();
+ assertThat(topicsLatencyMetrics.get(TOPICS_HOT_START_LATENCY_METRIC)).isEqualTo(14);
+ assertThat(topicsLatencyMetrics.get(TOPICS_COLD_START_LATENCY_METRIC)).isEqualTo(200);
+ }
+
+ /** Test getting no metrics for single package. */
+ @Test
+ public void testEmptyLogcat_noMetrics() throws Exception {
+ String outputString = "";
+ InputStream targetStream = new ByteArrayInputStream(outputString.getBytes());
+ doReturn(targetStream).when(mMetricsEventStreamReader).getMetricsEvents(any());
+ Map<String, Long> topicsLatencyMetrics = mTopicsLatencyHelper.getMetrics();
+ assertThat(topicsLatencyMetrics.containsKey(TOPICS_COLD_START_LATENCY_METRIC)).isFalse();
+ assertThat(topicsLatencyMetrics.containsKey(TOPICS_HOT_START_LATENCY_METRIC)).isFalse();
+ }
+}
diff --git a/libraries/device-collectors/src/main/Android.bp b/libraries/device-collectors/src/main/Android.bp
index 68023fa..6cb5c5e 100644
--- a/libraries/device-collectors/src/main/Android.bp
+++ b/libraries/device-collectors/src/main/Android.bp
@@ -37,6 +37,7 @@
"power-helper",
"simpleperf-helper",
"system-metric-helper",
+ "platform-test-annotations",
],
sdk_version: "test_current",
diff --git a/libraries/device-collectors/src/main/java/android/device/collectors/TopicsLatencyCollector.java b/libraries/device-collectors/src/main/java/android/device/collectors/TopicsLatencyCollector.java
new file mode 100644
index 0000000..ba382a1
--- /dev/null
+++ b/libraries/device-collectors/src/main/java/android/device/collectors/TopicsLatencyCollector.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2022 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 android.device.collectors;
+
+import android.device.collectors.annotations.OptionClass;
+
+import com.android.helpers.TopicsLatencyHelper;
+
+@OptionClass(alias = "topics-latency-collector")
+public class TopicsLatencyCollector extends BaseCollectionListener<Long> {
+
+ public TopicsLatencyCollector() {
+ createHelperInstance(new TopicsLatencyHelper());
+ }
+}
